Hit patterns used in the tracking tree search. More...

#include <QwHitPattern.h>

Inheritance diagram for QwHitPattern:

Collaboration diagram for QwHitPattern:

Public Member Functions
	QwHitPattern ()
	Default constructor. More...

	QwHitPattern (const unsigned int levels)
	Constructor with hit pattern depth. More...

	QwHitPattern (const QwHitPattern &pattern)
	Copy constructor. More...

virtual	~QwHitPattern ()
	Delete the hit pattern. More...

void	SetNumberOfLevels (const unsigned int levels)
	Set the hit pattern depth. More...

unsigned int	GetNumberOfLevels () const
	Get the hit pattern depth. More...

unsigned int	GetNumberOfBins () const
	Get the number of bins. More...

unsigned int	GetFinestBinWidth () const
	Get the finest bin width. More...

void	Reset ()
	Reset the contents of the hit pattern. More...

void	SetHDCHit (double detectorwidth, QwHit *hit)
	Set the hit pattern bins for the specified HDC-type hit. More...

void	SetVDCHit (double detectorwidth, QwHit *hit)
	Set the hit pattern bins for the specified VDC-type hit. More...

void	SetHDCHitList (double detectorwidth, QwHitContainer *hitlist)
	Set the hit pattern bins for the specified HDC-type hit list. More...

void	SetVDCHitList (double detectorwidth, QwHitContainer *hitlist)
	Set the hit pattern bins for the specified VDC-type hit list. More...

bool	HasHits () const
	Has this pattern any hit? More...

void	GetPattern (char *pattern) const
	Get the hit pattern. More...

void	GetPatternHash (int *patternhash) const
	Get the hit pattern hash. More...

QwHitPattern &	operator= (const QwHitPattern &rhs)
	Assignment operator. More...

QwHitPattern &	operator+= (const QwHitPattern &rhs)
	Addition-assignment operator. More...

Public Member Functions inherited from VQwTrackingElement
	VQwTrackingElement ()
	Default constructor. More...

	VQwTrackingElement (const VQwTrackingElement &that)

virtual	~VQwTrackingElement ()
	Virtual destructor. More...

VQwTrackingElement &	operator= (const VQwTrackingElement &that)
	Assignment operator. More...

const QwDetectorInfo *	GetDetectorInfo () const
	Get the detector info pointer. More...

void	SetDetectorInfo (const QwDetectorInfo *detectorinfo)
	Set the detector info pointer. More...

EQwRegionID	GetRegion () const
	Get the region. More...

void	SetRegion (EQwRegionID region)
	Set the region. More...

EQwDetectorPackage	GetPackage () const
	Get the package. More...

void	SetPackage (EQwDetectorPackage package)
	Set the package. More...

int	GetOctant () const
	Get the octant number. More...

void	SetOctant (int octant)
	Set the octant number. More...

EQwDirectionID	GetDirection () const
	Get the direction. More...

void	SetDirection (EQwDirectionID direction)
	Set the direction. More...

int	GetPlane () const
	Get the plane number. More...

void	SetPlane (int plane)
	Set the plane number. More...

int	GetElement () const
	Get the element number. More...

void	SetElement (int element)
	Set the element number. More...

void	SetGeometryTo (const VQwTrackingElement &e)
	Copy the geometry info from another object. More...

Public Member Functions inherited from QwObjectCounter< QwHitPattern >
	QwObjectCounter ()
	Default constructor. More...

	QwObjectCounter (const QwObjectCounter &)
	Copy constructor. More...

virtual	~QwObjectCounter ()
	Destructor. More...

Private Member Functions
void	_SetPoint (double position, double resolution, double detectorwidth)
	Recursive tree pattern method on a point with resolution. More...

void	_SetPoints (double pos_start, double pos_end, double detectorwidth)
	Recursive tree pattern method on a range of points. More...

	ClassDef (QwHitPattern, 1)

Private Attributes
unsigned int	fLevels
	Depth of the tree search. More...

unsigned int	fBins
	Number of bins. More...

unsigned int	fBinWidth
	Width of each bin. More...

unsigned char *	fPattern

unsigned int *	fPatternHash
	///< Hit pattern More...

Friends
std::ostream &	operator<< (std::ostream &stream, const QwHitPattern &hitpattern)
	///< Hash of the hit pattern More...

Additional Inherited Members
Static Public Member Functions inherited from QwObjectCounter< QwHitPattern >
static size_t	GetObjectsCreated ()
	Get number of objects ever created. More...

static size_t	GetObjectsAlive ()
	Get number of objects still alive. More...

Protected Member Functions inherited from VQwTrackingElement
	ClassDef (VQwTrackingElement, 1)

Protected Attributes inherited from VQwTrackingElement
const QwDetectorInfo *	fDetectorInfo

EQwRegionID	fRegion
	///< Detector info pointer More...

EQwDetectorPackage	fPackage
	Package. More...

int	fOctant
	Octant number. More...

EQwDirectionID	fDirection
	Direction. More...

int	fPlane
	Plane number. More...

int	fElement
	Element number. More...

Detailed Description

Hit patterns used in the tracking tree search.

The hit patterns used in the tree search have a rather peculiar format. Each level of depth in the pattern has a resolution that is twice as good as the previous level. The top level has a resolution of one, meaning that one bit indicates whether a track is present or not. The second level has two bits, etc.

A pattern is stored for every layer of the tracking detector (or every wire in the case of the VDCs, where the interpretation is rotated over 90 degrees).

The options file indicates the number of tree levels (how many times we go to finer binning). The total number of bits is determined using bit shift operators: Total number of bins + 1 = (1UL << levels) == 2^levels Number of bins at bottom = (1UL << (levels - 1)) == 2^(levels-1) For e.g. 4 levels we need 1 + 2 + 4 + 8 = 15 = (2^4 - 1) bits.

Definition at line 44 of file QwHitPattern.h.

Constructor & Destructor Documentation

QwHitPattern::QwHitPattern ( )

inline

Default constructor.

Definition at line 49 of file QwHitPattern.h.

50 : fLevels(0),fBins(0),fBinWidth(0),fPattern(0),fPatternHash(0)

51 { };

QwHitPattern::fLevels

unsigned int fLevels

Depth of the tree search.

Definition: QwHitPattern.h:144

QwHitPattern::fBinWidth

unsigned int fBinWidth

Width of each bin.

Definition: QwHitPattern.h:147

QwHitPattern::fPattern

unsigned char * fPattern

Definition: QwHitPattern.h:149

QwHitPattern::fPatternHash

unsigned int * fPatternHash

///< Hit pattern

Definition: QwHitPattern.h:150

QwHitPattern::fBins

unsigned int fBins

Number of bins.

Definition: QwHitPattern.h:146

QwHitPattern::QwHitPattern ( const unsigned int levels )

inline

Constructor with hit pattern depth.

Definition at line 53 of file QwHitPattern.h.

References Reset(), and SetNumberOfLevels().

     : fLevels(levels),fBins(0),fBinWidth(0),fPattern(0),fPatternHash(0)
     {
       SetNumberOfLevels(levels);
       Reset();
     };

Here is the call graph for this function:

QwHitPattern::QwHitPattern ( const QwHitPattern & pattern )

inline

Copy constructor.

Definition at line 60 of file QwHitPattern.h.

References fBins, fBinWidth, fPattern, and fPatternHash.

     : VQwTrackingElement(pattern),QwObjectCounter<QwHitPattern>(pattern),
       fLevels(pattern.fLevels),
       fBins(pattern.fBins),fBinWidth(pattern.fBinWidth)
     {
       fPattern = new unsigned char[fBins];
       for (unsigned int bin = 0; bin < fBins; bin++)
         fPattern[bin] = pattern.fPattern[bin];
       fPatternHash =  new unsigned int[fBinWidth];
       for (unsigned int hash = 0; hash < fBinWidth; hash++)
         fPatternHash[hash] = pattern.fPatternHash[hash];
     };

virtual QwHitPattern::~QwHitPattern ( )

inlinevirtual

Delete the hit pattern.

Definition at line 74 of file QwHitPattern.h.

References fLevels, fPattern, and fPatternHash.

                             {
       if (fLevels == 0) return;
       if (fPattern)     delete[] fPattern;
       if (fPatternHash) delete[] fPatternHash;
     };

Member Function Documentation

void QwHitPattern::_SetPoint	(	double	position,
		double	resolution,
		double	detectorwidth
	)

private

Recursive tree pattern method on a point with resolution.

Set the bins in the hit pattern for a range of positions around a central point within a specified distance/resolution by calling the setpoint() function.

Parameters

position	Central position
resolution	Resolution
detectorwidth	Width of the detector

Definition at line 204 of file QwHitPattern.cc.

References _SetPoints().

 {
   _SetPoints (position - resolution, position + resolution, detectorwidth);
 }

Here is the call graph for this function:

void QwHitPattern::_SetPoints	(	double	pos_start,
		double	pos_end,
		double	detectorwidth
	)

private

Recursive tree pattern method on a range of points.

Set the bins in a hit pattern for a range of positions. The range of hit patterns is specified by a start and a stop position in the detector. This function turns on the bins in the hit pattern for each level of the bin-division used in the tree search algorithm.

Parameters

pos_start	Start position
pos_end	End position
detectorwidth	Width of the detector

Definition at line 224 of file QwHitPattern.cc.

References fBinWidth, fPattern, fPatternHash, and hashgen().

Referenced by _SetPoint(), SetHDCHit(), and SetVDCHit().

 {
   int ia, ie;
   int hashint = hashgen();
   unsigned int binwidth = fBinWidth;
   unsigned char* pattern = fPattern;
 
   
 /* ---- compute the first bin in the deepest tree level to turn on     ---- */
 
   ia = (int) floor (pos_start / detectorwidth * fBinWidth);
 
   
 /* ---- compute the last bin in the deepest tree level to turn on      ---- */
 
   ie = (int) floor (pos_end   / detectorwidth * fBinWidth);
 
 /* ---- step through each of the bins at the deepest bin-division
         level in the hit pattern and turn on the bits in the
         pattern at all the bin-division levels for this bin.          ---- */
 
   for (int j = ia; j <= ie; j++) { /* loop over the bins to be set */
 
     int i = j; /* remember the bin at the deepest level which is turned on */
 
     binwidth = fBinWidth;   /* the size of the bit pattern for the detector
                                at the deepest level of bin-division.       */
     pattern  = fPattern;    /* pointer to start of the bit pattern         */
 
 /* ---- check if the bin is inside the detector                       ---- */
     if (i >= (signed int) binwidth)
       return;
     if (i < 0)
       continue;
 
 /* ---- compute the hash value                                        ---- */
     //NOTE:why like this?
     fPatternHash[i] = ((fPatternHash[i] << 1) + hashint) | 1;
 //     std::cout << "fPatternHash[" << i << "]=" << fPatternHash[i] << std::endl; 
 /* ---- set the bits in the bit pattern at all depths of bin-division ---- */
     if (pattern) {
       while (binwidth) {         /* starting at maximum depth, loop over
                                     each depth of the treesearch           */
 //         if(binwidth==1) std::cout << "set i" << i << " " << pos_start << std::endl;
         pattern[i] = 1;          /* turn on the bit in this bin            */
         pattern   += binwidth;   /* set ahead to the part of the bit
                                     pattern in which the bits for the
                                     next higher bin-division are stored    */
         i        >>= 1;          /* go up one depth of the depth           */
         binwidth >>= 1;          /* size of the bit pattern for the next
                                     higher bin-division is half of the
                                     size of the bit pattern for a given
                                     level of bin-division.                 */
 
       } /* end of loop over the depths of the treesearch */
     }
   } /* end of loop over the bins to be set */
 }

Here is the call graph for this function:

Here is the caller graph for this function:

QwHitPattern::ClassDef	(	QwHitPattern	,
		1
	)

private

unsigned int QwHitPattern::GetFinestBinWidth ( ) const

inline

Get the finest bin width.

Definition at line 94 of file QwHitPattern.h.

References fBinWidth.

94 { return fBinWidth; };

QwHitPattern::fBinWidth

unsigned int fBinWidth

Width of each bin.

Definition: QwHitPattern.h:147

unsigned int QwHitPattern::GetNumberOfBins ( ) const

inline

Get the number of bins.

Definition at line 92 of file QwHitPattern.h.

References fBins.

92 { return fBins; };

QwHitPattern::fBins

unsigned int fBins

Number of bins.

Definition: QwHitPattern.h:146

unsigned int QwHitPattern::GetNumberOfLevels ( ) const

inline

Get the hit pattern depth.

Definition at line 90 of file QwHitPattern.h.

References fLevels.

90 { return fLevels; };

QwHitPattern::fLevels

unsigned int fLevels

Depth of the tree search.

Definition: QwHitPattern.h:144

void QwHitPattern::GetPattern ( char * pattern ) const

inline

Get the hit pattern.

Definition at line 120 of file QwHitPattern.h.

References fBins, and fPattern.

                                          {
       for (unsigned int bin = 0; bin < fBins; bin++)
         pattern[bin] = fPattern[bin];
     };

void QwHitPattern::GetPatternHash ( int * patternhash ) const

inline

Get the hit pattern hash.

Definition at line 125 of file QwHitPattern.h.

References fBinWidth, and fPatternHash.

                                                 {
       for (unsigned int hash = 0; hash < fBinWidth; hash++)
         patternhash[hash] = fPatternHash[hash];
     };

bool QwHitPattern::HasHits ( ) const

inline

Has this pattern any hit?

Definition at line 114 of file QwHitPattern.h.

References fBins, and fPattern.

                          {
       if (fPattern == 0) return false;
       else return fPattern[fBins-2] == 1;
     };

QwHitPattern & QwHitPattern::operator+= ( const QwHitPattern & that )

Addition-assignment operator.

Addition-assignment operator for hit patterns. This is important for multiple hits on a single wire.

TODO figure out how this affects region 2 and region 3

Requirements are: hitpattern += 0 == hitpattern 0 += hitpattern == hitpattern hitpattern1 += hitpattern2 == hitpattern as obtained by TreeSearch code

The hash pattern is not so important, but the hit pattern has to match!

Parameters

that	Right hand side

Returns: Left hand side

Definition at line 73 of file QwHitPattern.cc.

References fBins, fLevels, and fPattern.

 {
   // If lhs is zero we assign that and return
   if (fLevels == 0) return *this = that;
   // Check whether levels is equal
   if (fLevels == that.fLevels) {
     for (unsigned int bin = 0; bin < fBins; bin++)
       fPattern[bin] |= that.fPattern[bin];
   }
   return *this;
 }

QwHitPattern & QwHitPattern::operator= ( const QwHitPattern & that )

Assignment operator.

Assignment operator for hit patterns.

Parameters

that	Right hand side

Returns: Left hand side

Definition at line 38 of file QwHitPattern.cc.

References fBins, fBinWidth, fLevels, fPattern, fPatternHash, VQwTrackingElement::operator=(), and SetNumberOfLevels().

 {
   if (this == &that) return *this;
 
   VQwTrackingElement::operator=(that);
 
   SetNumberOfLevels(that.fLevels);
   // If lhs is zero we assign that and return
   if (fLevels == 0) return *this;
   // Copy the levels and pattern data
   for (unsigned int bin = 0; bin < fBins; bin++)
     fPattern[bin] = that.fPattern[bin];
   for (unsigned int hash = 0; hash < fBinWidth; hash++)
     fPatternHash[hash] = that.fPatternHash[hash];
   return *this;
 }

Here is the call graph for this function:

void QwHitPattern::Reset ( )

inline

Reset the contents of the hit pattern.

Definition at line 97 of file QwHitPattern.h.

References fBins, fBinWidth, fPattern, and fPatternHash.

Referenced by QwHitPattern().

                  {
       for (unsigned int bin = 0; bin < fBins; bin++)
         fPattern[bin] = 0;
       for (unsigned int hash = 0; hash < fBinWidth; hash++)
         fPatternHash[hash] = 0;
     };

Here is the caller graph for this function:

void QwHitPattern::SetHDCHit	(	double	detectorwidth,
		QwHit *	hit
	)

Set the hit pattern bins for the specified HDC-type hit.

The planes are treated as individual tree-detectors. In this case, a separate hit pattern is created for both planes and the above described searching for paired hits is not employed. (This method is the standard for the front chambers since they have only four planes per treeline).

Parameters

detectorwidth	Width of the detector
hit	Hit

Definition at line 134 of file QwHitPattern.cc.

References _SetPoints(), VQwTrackingElement::GetDetectorInfo(), QwHit::GetDriftDistance(), VQwTrackingElement::GetElement(), QwDetectorInfo::GetElementSpacing(), and QwDetectorInfo::GetTrackResolution().

Referenced by SetHDCHitList().

 {
   // Get the wire number
   int wire = hit->GetElement();
   double drift_distance = hit->GetDriftDistance();
   double wire_spacing = hit->GetDetectorInfo()->GetElementSpacing();
   double track_resolution = hit->GetDetectorInfo()->GetTrackResolution();
   
 
   // Set the points on the front/bottom side of the wire (R3/R2)
   //NOTE:why wire+1,not wire?
 //   std::cout << "r2 bottom: " << hit->GetDirection() << " " << hit->GetPlane() << std::endl;
   _SetPoints(wire_spacing * (wire-0.5) - drift_distance - track_resolution,
              wire_spacing * (wire-0.5) - drift_distance + track_resolution,
              detectorwidth);
 
 //   std::cout << "r2 up: " << hit->GetDirection() << " " << hit->GetPlane() << std::endl;  
   // Set the points on the back/top side of the wire (R3/R2)
   _SetPoints(wire_spacing * (wire-0.5) + drift_distance - track_resolution,
              wire_spacing * (wire-0.5) + drift_distance + track_resolution,
              detectorwidth);
 
 
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwHitPattern::SetHDCHitList	(	double	detectorwidth,
		QwHitContainer *	hitlist
	)

Set the hit pattern bins for the specified HDC-type hit list.

Parameters

detectorwidth	Width of the detector
hitlist	Hit list

Definition at line 93 of file QwHitPattern.cc.

References SetHDCHit().

Referenced by QwTrackingWorker::ProcessEvent().

 {
   QwHitContainer::iterator end=hitlist->end();
   for (QwHitContainer::iterator hit  = hitlist->begin();
                                 hit != end; ++hit){
     if(hit->GetDriftDistance()<0 || hit->GetHitNumber()!=0) continue;
     SetHDCHit(detectorwidth,&(*hit));
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwHitPattern::SetNumberOfLevels ( const unsigned int levels )

inline

Set the hit pattern depth.

Definition at line 81 of file QwHitPattern.h.

References fBins, fBinWidth, fLevels, fPattern, and fPatternHash.

Referenced by operator=(), and QwHitPattern().

                                                       {
       fLevels = levels;
       if (fLevels == 0) return;
       fBins = (1UL << fLevels); // total number of bins, i.e. 2^fLevels
       fBinWidth = (1UL << (fLevels - 1)); // maximum bin division, i.e. 2^(fLevels-1)
       fPattern = new unsigned char[fBins];
       fPatternHash =  new unsigned int[fBinWidth];
     };

Here is the caller graph for this function:

void QwHitPattern::SetVDCHit	(	double	detectorwidth,
		QwHit *	hit
	)

Set the hit pattern bins for the specified VDC-type hit.

(TODO Need to elaborate on how this is different exactly)

Parameters

detectorwidth	Width of the detector
hit	Hit

Definition at line 172 of file QwHitPattern.cc.

References _SetPoints(), VQwTrackingElement::GetDetectorInfo(), QwHit::GetDriftDistance(), and QwDetectorInfo::GetTrackResolution().

Referenced by QwTrackingWorker::ProcessEvent(), and SetVDCHitList().

 {
   double halfwidth = (detectorwidth / 2.0); /* half-width of the detector (in cm) */
   double drift_distance = hit->GetDriftDistance();
   double track_resolution = hit->GetDetectorInfo()->GetTrackResolution();
 
   // Set the points on the front/top side of the wire (R3/R2)
   _SetPoints(halfwidth - drift_distance - track_resolution,
              halfwidth - drift_distance + track_resolution,
              detectorwidth);
 
   // Set the points on the back/bottom side of the wire (R3/R2)
   _SetPoints(halfwidth + drift_distance - track_resolution,
              halfwidth + drift_distance + track_resolution,
              detectorwidth);
 
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwHitPattern::SetVDCHitList	(	double	detectorwidth,
		QwHitContainer *	hitlist
	)

Set the hit pattern bins for the specified VDC-type hit list.

Parameters

detectorwidth	Width of the detector
hitlist	Hit list

Definition at line 112 of file QwHitPattern.cc.

References SetVDCHit().

 {
   for (QwHitContainer::iterator hit  = hitlist->begin();
                                 hit != hitlist->end(); hit++)
     SetVDCHit(detectorwidth, &(*hit));
 }

Here is the call graph for this function:

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const QwHitPattern &	hitpattern
	)

friend

///< Hash of the hit pattern

Stream the hit pattern to an std::ostream.

Definition at line 291 of file QwHitPattern.cc.

 {
   for (unsigned int bin = 0; bin < hitpattern.fBins - 1; bin++) {
     if (hitpattern.fPattern[bin] == 1)
         stream << "|";
     else
         stream << ".";
   }
   return stream;
 }

Field Documentation

unsigned int QwHitPattern::fBins

private

Number of bins.

Definition at line 146 of file QwHitPattern.h.

Referenced by GetNumberOfBins(), GetPattern(), HasHits(), operator+=(), operator<<(), operator=(), QwHitPattern(), Reset(), and SetNumberOfLevels().

unsigned int QwHitPattern::fBinWidth

private

Width of each bin.

Definition at line 147 of file QwHitPattern.h.

Referenced by _SetPoints(), GetFinestBinWidth(), GetPatternHash(), operator=(), QwHitPattern(), Reset(), and SetNumberOfLevels().

unsigned int QwHitPattern::fLevels

private

Depth of the tree search.

Definition at line 144 of file QwHitPattern.h.

Referenced by GetNumberOfLevels(), operator+=(), operator=(), SetNumberOfLevels(), and ~QwHitPattern().

unsigned char* QwHitPattern::fPattern

private

Definition at line 149 of file QwHitPattern.h.

Referenced by _SetPoints(), GetPattern(), HasHits(), operator+=(), operator<<(), operator=(), QwHitPattern(), Reset(), SetNumberOfLevels(), and ~QwHitPattern().

unsigned int* QwHitPattern::fPatternHash

private

///< Hit pattern

Definition at line 150 of file QwHitPattern.h.

Referenced by _SetPoints(), GetPatternHash(), operator=(), QwHitPattern(), Reset(), SetNumberOfLevels(), and ~QwHitPattern().

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation