reco::ClusterHit2D Class Reference

#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 geo::WireID &wireID, const recob::Hit *recobHit)
	ClusterHit2D (const ClusterHit2D &)
unsigned	getStatusBits () const
float	getDocaToAxis () const
float	getArcLenToPoca () const
float	getXPosition () const
float	getTimeTicks () const
const geo::WireID &	WireID () 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
void	setHit (const recob::Hit *hit)

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...
geo::WireID	m_wireID
	Keep track this particular hit's wireID. 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 53 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 16 of file Cluster3D.cxx.

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

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

Definition at line 24 of file Cluster3D.cxx.

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

reco::ClusterHit2D::ClusterHit2D

(

const ClusterHit2D &

toCopy

)

Definition at line 39 of file Cluster3D.cxx.

{
    m_statusBits    = toCopy.m_statusBits;
    m_docaToAxis    = toCopy.m_docaToAxis;
    m_arcLenToPoca  = toCopy.m_arcLenToPoca;
    m_xPosition     = toCopy.m_xPosition;
    m_timeTicks     = toCopy.m_timeTicks;
    m_wireID        = toCopy.m_wireID;
    m_hit           = toCopy.m_hit;
}

Member Function Documentation

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

inline

Definition at line 81 of file Cluster3D.h.

{m_statusBits   &= ~bits;}

float reco::ClusterHit2D::getArcLenToPoca ( ) const

inline

Definition at line 74 of file Cluster3D.h.

{return m_arcLenToPoca;}

float reco::ClusterHit2D::getDocaToAxis ( ) const

inline

Definition at line 73 of file Cluster3D.h.

{return m_docaToAxis;}

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

inline

Definition at line 78 of file Cluster3D.h.

{return m_hit;}

unsigned reco::ClusterHit2D::getStatusBits ( ) const

inline

Definition at line 72 of file Cluster3D.h.

{return m_statusBits;}

float reco::ClusterHit2D::getTimeTicks ( ) const

inline

Definition at line 76 of file Cluster3D.h.

{return m_timeTicks;}

float reco::ClusterHit2D::getXPosition ( ) const

inline

Definition at line 75 of file Cluster3D.h.

{return m_xPosition;}

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

inline

Definition at line 83 of file Cluster3D.h.

{m_arcLenToPoca  = poca;}

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

inline

Definition at line 82 of file Cluster3D.h.

{m_docaToAxis    = doca;}

void reco::ClusterHit2D::setHit ( const recob::Hit *  hit )

inline

Definition at line 85 of file Cluster3D.h.

{m_hit = hit;}

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

inline

Definition at line 80 of file Cluster3D.h.

{m_statusBits   |= bits;}

const geo::WireID& reco::ClusterHit2D::WireID ( ) const

inline

Definition at line 77 of file Cluster3D.h.

{return m_wireID;}

Friends And Related Function Documentation

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

friend

Definition at line 57 of file Cluster3D.cxx.

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

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

friend

Definition at line 50 of file Cluster3D.cxx.

{
    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.

float reco::ClusterHit2D::m_docaToAxis

mutableprivate

DOCA of hit at POCA to associated cluster axis.

Definition at line 44 of file Cluster3D.h.

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

private

Hit we are augmenting.

Definition at line 49 of file Cluster3D.h.

unsigned reco::ClusterHit2D::m_statusBits

mutableprivate

Volatile status information of this 3D hit.

Definition at line 43 of file Cluster3D.h.

float reco::ClusterHit2D::m_timeTicks

private

The time (in ticks) for this hit.

Definition at line 47 of file Cluster3D.h.

geo::WireID reco::ClusterHit2D::m_wireID

private

Keep track this particular hit's wireID.

Definition at line 48 of file Cluster3D.h.

float reco::ClusterHit2D::m_xPosition

private

The x coordinate for this hit.

Definition at line 46 of file Cluster3D.h.

---

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

• larreco/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.h
• larreco/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.cxx