ImpactBinsSpec Class Reference

Strategy to construct discrete impact points from discrete overlap specifications. More...

#include <ImpactRep.h>

Public Member Functions
	ImpactBinsSpec (double lowerBound, double upperBound, long nBins, int nOverlap, int nWidth)
	Constructs a specification for equally spaced discrete impactature values with discrete overlap specification.
DiscreteImpact::Array	constructArray () const
	Construct the array of discrete impact positions.
long	getNPositions () const
	Getter for the number of bounds.
double	getBinWidth () const
	Getter for the bin width in real impact to investigate the value that results from the discrete overlap specification.
double	getOverlap () const
	Getter for the overlap in real impact to investigate the value that results from the discrete overlap specification.
long	getNOverlap () const
	Getter for the overlap in discrete number of positions.

Private Attributes
double	m_lowerBound
	Lower bound of the binning range.
double	m_upperBound
	Upper bound of the binning range.
long	m_nBins
	Number of accessible bins.
int	m_nOverlap = 1
	Overlap of the leaves in impact counted in number of discrete values.
int	m_nWidth = 3
	Width of the leaves at the maximal level in impact counted in number of discrete values.

Detailed Description

Strategy to construct discrete impact points from discrete overlap specifications.

Definition at line 19 of file ImpactRep.h.

Constructor & Destructor Documentation

ImpactBinsSpec()

ImpactBinsSpec	(	double	lowerBound,
		double	upperBound,
		long	nBins,
		int	nOverlap,
		int	nWidth
	)

Constructs a specification for equally spaced discrete impactature values with discrete overlap specification.

Parameters

lowerBound	Lower bound of the value range
upperBound	Upper bound of the value range
nBins	Total number of final bins to be constructed
nWidth	Number of discrete values in each bin (counted semi open [start, stop)).
nOverlap	Number of discrete values that overlapping bins have in common (counted semi open [start, stop)).

Definition at line 15 of file ImpactRep.cc.

  : m_lowerBound(lowerBound)
  , m_upperBound(upperBound)
  , m_nBins(nBins)
  , m_nOverlap(nOverlap)
  , m_nWidth(nWidth)
{
  B2ASSERT("Overlap must be smaller than the width.", m_nWidth > m_nOverlap);
  B2ASSERT("Upper impactature bound must be higher than the lower bound.", m_upperBound > m_lowerBound);
}

Member Function Documentation

constructArray()

DiscreteImpact::Array constructArray

(

)

const

Construct the array of discrete impact positions.

Definition at line 26 of file ImpactRep.cc.

{
  const long nPositions = getNPositions();
  return linspace<float>(m_lowerBound, m_upperBound, nPositions);
}

getBinWidth()

double getBinWidth

(

)

const

Getter for the bin width in real impact to investigate the value that results from the discrete overlap specification.

Definition at line 38 of file ImpactRep.cc.

{
  const double overlapWidthRatio = static_cast<double>(m_nOverlap) / m_nWidth;
  const double width = (m_upperBound - m_lowerBound) / (m_nBins * (1 - overlapWidthRatio) + overlapWidthRatio);
  return width;
}

getNOverlap()

long getNOverlap ( ) const

inline

Getter for the overlap in discrete number of positions.

Definition at line 54 of file ImpactRep.h.

      {
        return m_nOverlap;
      }

getNPositions()

long getNPositions

(

)

const

Getter for the number of bounds.

Definition at line 32 of file ImpactRep.cc.

{
  const long nPositions = (m_nWidth - m_nOverlap) * m_nBins + m_nOverlap + 1;
  return nPositions;
}

getOverlap()

double getOverlap

(

)

const

Getter for the overlap in real impact to investigate the value that results from the discrete overlap specification.

Definition at line 45 of file ImpactRep.cc.

{
  return getBinWidth() * m_nOverlap / m_nWidth;
}

Member Data Documentation

m_lowerBound

double m_lowerBound

private

Lower bound of the binning range.

Definition at line 61 of file ImpactRep.h.

m_nBins

long m_nBins

private

Number of accessible bins.

Definition at line 67 of file ImpactRep.h.

m_nOverlap

int m_nOverlap = 1

private

Overlap of the leaves in impact counted in number of discrete values.

Definition at line 70 of file ImpactRep.h.

m_nWidth

int m_nWidth = 3

private

Width of the leaves at the maximal level in impact counted in number of discrete values.

Definition at line 73 of file ImpactRep.h.

m_upperBound

double m_upperBound

private

Upper bound of the binning range.

Definition at line 64 of file ImpactRep.h.

---

The documentation for this class was generated from the following files:

• tracking/trackFindingCDC/hough/perigee/include/ImpactRep.h
• tracking/trackFindingCDC/hough/perigee/src/ImpactRep.cc