Acts::HoughTransformUtils Namespace Reference

Namespaces
namespace	PeakFinders
	example peak finders.

Classes
struct	HoughAxisRanges
	struct to define the ranges of the hough histogram. More...
class	HoughCell
	data class for the information to store for each cell of the hough histogram. More...
class	HoughPlane
	Representation of the hough plane - the histogram used for the hough transform with methods to fill and evaluate the histogram. More...
struct	HoughPlaneConfig
	Configuration - number of bins in each axis. More...

Typedefs
using	CoordType = double
	this type is responsible for encoding the parameters of our hough space
template<class PointType>
using	LineParametrisation
	this function represents a mapping of a coordinate point in detector space to a line in hough space.
using	YieldType = float
	Type alias for hit count/weight values in Hough space.

Functions
double	binCenter (double min, double max, unsigned nSteps, std::size_t binIndex)
int	binIndex (double min, double max, unsigned nSteps, double val)
	convenience functions to link bin indices to axis coordinates
double	lowerBinEdge (double min, double max, unsigned nSteps, std::size_t binIndex)

Typedef Documentation

CoordType

using Acts::HoughTransformUtils::CoordType = double

this type is responsible for encoding the parameters of our hough space

LineParametrisation

template<class PointType>

using Acts::HoughTransformUtils::LineParametrisation

Initial value:

 
    std::function<CoordType(CoordType, const PointType&)>

this function represents a mapping of a coordinate point in detector space to a line in hough space.

Given the value of the first hough coordinate, it shall return the corresponding second coordinate according to the line parametrisation. Should be implemented by the user.

Template Parameters

PointType

The class representing a point in detector space (can differ between implementations)

YieldType

using Acts::HoughTransformUtils::YieldType = float

Type alias for hit count/weight values in Hough space.

Function Documentation

binCenter()

double Acts::HoughTransformUtils::binCenter	(	double	min,
		double	max,
		unsigned	nSteps,
		std::size_t	binIndex )

Parameters

min	Start of axis range
max	End of axis range
nSteps	Number of bins in axis
binIndex	The index of the bin

Returns

the parameter value at the bin center. No special logic to prevent over-/underflow, checking these is left to the caller

binIndex()

int Acts::HoughTransformUtils::binIndex	(	double	min,
		double	max,
		unsigned	nSteps,
		double	val )

convenience functions to link bin indices to axis coordinates

find the bin index corresponding to a certain abscissa of the coordinate axis, based on the axis limits and binning.

Parameters

min	Start of axis range
max	End of axis range
nSteps	Number of bins in axis
val	value to find the corresponding bin for

Returns

the bin number. No special logic to prevent over-/underflow, checking these is left to the caller

lowerBinEdge()

double Acts::HoughTransformUtils::lowerBinEdge	(	double	min,
		double	max,
		unsigned	nSteps,
		std::size_t	binIndex )

Parameters

min	Start of axis range
max	End of axis range
nSteps	Number of bins in axis
binIndex	The index of the bin

Returns

the parameter value at the lower bin edge. No special logic to prevent over-/underflow, checking these is left to the caller