#include "Cluster3D.h"

Public Types
enum	StatusBits { SHAREDINPAIR = 0x00080000, SHAREDINTRIPLET = 0x00040000, USEDINPAIR = 0x00008000, USEDINTRIPLET = 0x00004000, SHAREDINCLUSTER = 0x00000200, USEDINCLUSTER = 0x00000100, USED = 0x00000001 }

Public Member Functions
	ClusterHit2D ()

	ClusterHit2D (unsigned statusBits, float doca, float poca, float xPosition, float timeTicks, const recob::Hit &recobHit)

unsigned	getStatusBits () const

float	getDocaToAxis () const

float	getArcLenToPoca () const

float	getXPosition () const

float	getTimeTicks () const

const recob::Hit &	getHit () const

void	setStatusBit (unsigned bits) const

void	clearStatusBits (unsigned bits) const

void	setDocaToAxis (float doca) const

void	setArcLenToPoca (float poca) const

Private Attributes
unsigned	m_statusBits
	Volatile status information of this 3D hit. More...

float	m_docaToAxis
	DOCA of hit at POCA to associated cluster axis. More...

float	m_arcLenToPoca
	arc length to POCA along cluster axis More...

float	m_xPosition
	The x coordinate for this hit. More...

float	m_timeTicks
	The time (in ticks) for this hit. More...

const recob::Hit *	m_hit
	Hit we are augmenting. More...

Friends
std::ostream &	operator<< (std::ostream &o, const ClusterHit2D &c)

bool	operator< (const ClusterHit2D &a, const ClusterHit2D &b)

Detailed Description

Definition at line 35 of file Cluster3D.h.

Member Enumeration Documentation

enum reco::ClusterHit2D::StatusBits

Enumerator
SHAREDINPAIR
SHAREDINTRIPLET
USEDINPAIR
USEDINTRIPLET
SHAREDINCLUSTER
USEDINCLUSTER
USED

Definition at line 52 of file Cluster3D.h.

                     { SHAREDINPAIR    = 0x00080000,
                       SHAREDINTRIPLET = 0x00040000,
                       USEDINPAIR      = 0x00008000,
                       USEDINTRIPLET   = 0x00004000,
                       SHAREDINCLUSTER = 0x00000200,
                       USEDINCLUSTER   = 0x00000100,
                       USED            = 0x00000001
                     };

Constructor & Destructor Documentation

reco::ClusterHit2D::ClusterHit2D ( )

Definition at line 19 of file Cluster3D.cxx.

                            : m_statusBits(0),
                                m_docaToAxis(9999.),
                                m_arcLenToPoca(0.),
                                m_xPosition(0.),
                                m_timeTicks(0.),
                                m_hit(nullptr) {}

reco::ClusterHit2D::ClusterHit2D	(	unsigned	statusBits,
		float	doca,
		float	poca,
		float	xPosition,
		float	timeTicks,
		const recob::Hit &	recobHit
	)

Definition at line 26 of file Cluster3D.cxx.

                                                  :
                            m_statusBits(statusBits),
                            m_docaToAxis(doca),
                            m_arcLenToPoca(poca),
                            m_xPosition(xPosition),
                            m_timeTicks(timeTicks),
                            m_hit(&hit) {}

Member Function Documentation

void reco::ClusterHit2D::clearStatusBits ( unsigned bits ) const

inline

Definition at line 76 of file Cluster3D.h.

76 {m_statusBits &= ~bits;}

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:43

float reco::ClusterHit2D::getArcLenToPoca ( ) const

inline

Definition at line 70 of file Cluster3D.h.

References m_arcLenToPoca.

70 {return m_arcLenToPoca;}

reco::ClusterHit2D::m_arcLenToPoca

float m_arcLenToPoca

arc length to POCA along cluster axis

Definition: Cluster3D.h:45

float reco::ClusterHit2D::getDocaToAxis ( ) const

inline

Definition at line 69 of file Cluster3D.h.

References m_docaToAxis.

69 {return m_docaToAxis;}

reco::ClusterHit2D::m_docaToAxis

float m_docaToAxis

DOCA of hit at POCA to associated cluster axis.

Definition: Cluster3D.h:44

const recob::Hit& reco::ClusterHit2D::getHit ( ) const

inline

Definition at line 73 of file Cluster3D.h.

References m_hit.

Referenced by lar_cluster3d::StandardHit3DBuilder::BuildHit3D(), lar_cluster3d::StandardHit3DBuilder::findGoodHitPairs(), lar_cluster3d::PrincipalComponentsAlg::getHit2DPocaToAxis(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::Hit2DSetCompare::operator()(), reco::operator<(), reco::operator<<(), lar_cluster3d::SetHitTimeOrder(), reco::RecobClusterParameters::UpdateParameters(), and reco::ClusterParameters::UpdateParameters().

73 {return *m_hit;}

reco::ClusterHit2D::m_hit

const recob::Hit * m_hit

Hit we are augmenting.

Definition: Cluster3D.h:48

unsigned reco::ClusterHit2D::getStatusBits ( ) const

inline

Definition at line 68 of file Cluster3D.h.

References m_statusBits.

Referenced by lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), and lar_cluster3d::StandardHit3DBuilder::makeHitTriplet().

68 {return m_statusBits;}

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:43

float reco::ClusterHit2D::getTimeTicks ( ) const

inline

Definition at line 72 of file Cluster3D.h.

References m_timeTicks.

Referenced by lar_cluster3d::StandardHit3DBuilder::BuildHit3D(), lar_cluster3d::StandardHit3DBuilder::BuildHitPairMapByTPC(), lar_cluster3d::SkeletonAlg::FindMedialSkeleton(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), and lar_cluster3d::StandardHit3DBuilder::makeHitTriplet().

72 {return m_timeTicks;}

reco::ClusterHit2D::m_timeTicks

float m_timeTicks

The time (in ticks) for this hit.

Definition: Cluster3D.h:47

float reco::ClusterHit2D::getXPosition ( ) const

inline

Definition at line 71 of file Cluster3D.h.

References m_xPosition.

Referenced by lar_cluster3d::StandardHit3DBuilder::makeHitPair(), and lar_cluster3d::StandardHit3DBuilder::makeHitTriplet().

71 {return m_xPosition;}

reco::ClusterHit2D::m_xPosition

float m_xPosition

The x coordinate for this hit.

Definition: Cluster3D.h:46

void reco::ClusterHit2D::setArcLenToPoca ( float poca ) const

inline

Definition at line 78 of file Cluster3D.h.

References operator<, and operator<<.

78 {m_arcLenToPoca = poca;}

reco::ClusterHit2D::m_arcLenToPoca

float m_arcLenToPoca

arc length to POCA along cluster axis

Definition: Cluster3D.h:45

void reco::ClusterHit2D::setDocaToAxis ( float doca ) const

inline

Definition at line 77 of file Cluster3D.h.

77 {m_docaToAxis = doca;}

reco::ClusterHit2D::m_docaToAxis

float m_docaToAxis

DOCA of hit at POCA to associated cluster axis.

Definition: Cluster3D.h:44

void reco::ClusterHit2D::setStatusBit ( unsigned bits ) const

inline

Definition at line 75 of file Cluster3D.h.

Referenced by lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), and lar_cluster3d::StandardHit3DBuilder::makeHitTriplet().

75 {m_statusBits |= bits;}

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:43

Friends And Related Function Documentation

bool operator<	(	const ClusterHit2D &	a,
		const ClusterHit2D &	b
	)

friend

Definition at line 47 of file Cluster3D.cxx.

Referenced by reco::Cluster3D::clearStatusBits(), setArcLenToPoca(), and reco::PrincipalComponents::setAveHitDoca().

 {
     return a.getHit() < b.getHit();
 }

std::ostream& operator<<	(	std::ostream &	o,
		const ClusterHit2D &	c
	)

friend

Definition at line 40 of file Cluster3D.cxx.

Referenced by reco::Cluster3D::clearStatusBits(), reco::ClusterHit3D::operator==(), setArcLenToPoca(), and reco::PrincipalComponents::setAveHitDoca().

 {
     o << c.getHit();
     
     return o;
 }

Member Data Documentation

float reco::ClusterHit2D::m_arcLenToPoca

mutableprivate

arc length to POCA along cluster axis

Definition at line 45 of file Cluster3D.h.

Referenced by getArcLenToPoca().

float reco::ClusterHit2D::m_docaToAxis

mutableprivate

DOCA of hit at POCA to associated cluster axis.

Definition at line 44 of file Cluster3D.h.

Referenced by getDocaToAxis(), reco::ClusterHit3D::getDocaToAxis(), and reco::ClusterHit3D::setDocaToAxis().

const recob::Hit* reco::ClusterHit2D::m_hit

private

Hit we are augmenting.

Definition at line 48 of file Cluster3D.h.

Referenced by getHit().

unsigned reco::ClusterHit2D::m_statusBits

mutableprivate

Volatile status information of this 3D hit.

Definition at line 43 of file Cluster3D.h.

Referenced by reco::ClusterHit3D::bitsAreSet(), reco::ClusterHit3D::clearStatusBits(), getStatusBits(), reco::ClusterHit3D::getStatusBits(), reco::Cluster3D::getStatusBits(), and reco::ClusterHit3D::setStatusBit().

float reco::ClusterHit2D::m_timeTicks

private

The time (in ticks) for this hit.

Definition at line 47 of file Cluster3D.h.

Referenced by getTimeTicks().

float reco::ClusterHit2D::m_xPosition

private

The x coordinate for this hit.

Definition at line 46 of file Cluster3D.h.

Referenced by getXPosition().

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

/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.h
/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.cxx

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation