#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 &)

ClusterHit2D &	operator= (ClusterHit2D const &)

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 36 of file Cluster3D.h.

Member Enumeration Documentation

enum reco::ClusterHit2D::StatusBits

Enumerator
SHAREDINPAIR
SHAREDINTRIPLET
USEDINPAIR
USEDINTRIPLET
SHAREDINCLUSTER
USEDINCLUSTER
USED

Definition at line 50 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 17 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 27 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 43 of file Cluster3D.cxx.

References m_arcLenToPoca, m_docaToAxis, m_hit, m_statusBits, m_timeTicks, m_wireID, and m_xPosition.

   {
     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 80 of file Cluster3D.h.

80 { m_statusBits &= ~bits; }

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:41

float reco::ClusterHit2D::getArcLenToPoca ( ) const

inline

Definition at line 73 of file Cluster3D.h.

73 { return m_arcLenToPoca; }

reco::ClusterHit2D::m_arcLenToPoca

float m_arcLenToPoca

arc length to POCA along cluster axis

Definition: Cluster3D.h:43

float reco::ClusterHit2D::getDocaToAxis ( ) const

inline

Definition at line 72 of file Cluster3D.h.

72 { return m_docaToAxis; }

reco::ClusterHit2D::m_docaToAxis

float m_docaToAxis

DOCA of hit at POCA to associated cluster axis.

Definition: Cluster3D.h:42

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

inline

Definition at line 77 of file Cluster3D.h.

Referenced by lar_cluster3d::StandardHit3DBuilder::BuildHit3D(), lar_cluster3d::StandardHit3DBuilder::CreateNewRecobHitCollection(), lar_cluster3d::SnippetHit3DBuilder::CreateNewRecobHitCollection(), lar_cluster3d::StandardHit3DBuilder::DistanceFromPointToHitWire(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), lar_cluster3d::Hit2DSetCompare::operator()(), reco::operator<(), reco::operator<<(), lar_cluster3d::SetHitTimeOrder(), and reco::RecobClusterParameters::UpdateParameters().

77 { return m_hit; }

reco::ClusterHit2D::m_hit

const recob::Hit * m_hit

Hit we are augmenting.

Definition: Cluster3D.h:47

unsigned reco::ClusterHit2D::getStatusBits ( ) const

inline

Definition at line 71 of file Cluster3D.h.

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

71 { return m_statusBits; }

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:41

float reco::ClusterHit2D::getTimeTicks ( ) const

inline

Definition at line 75 of file Cluster3D.h.

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

75 { return m_timeTicks; }

reco::ClusterHit2D::m_timeTicks

float m_timeTicks

The time (in ticks) for this hit.

Definition: Cluster3D.h:45

float reco::ClusterHit2D::getXPosition ( ) const

inline

Definition at line 74 of file Cluster3D.h.

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

74 { return m_xPosition; }

reco::ClusterHit2D::m_xPosition

float m_xPosition

The x coordinate for this hit.

Definition: Cluster3D.h:44

ClusterHit2D & reco::ClusterHit2D::operator= ( ClusterHit2D const & toCopy )

Definition at line 54 of file Cluster3D.cxx.

References tmp.

   {
     using std::swap;
     auto tmp = toCopy;
     swap(tmp, *this);
     return *this;
   }

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

inline

Definition at line 82 of file Cluster3D.h.

82 { m_arcLenToPoca = poca; }

reco::ClusterHit2D::m_arcLenToPoca

float m_arcLenToPoca

arc length to POCA along cluster axis

Definition: Cluster3D.h:43

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

inline

Definition at line 81 of file Cluster3D.h.

81 { m_docaToAxis = doca; }

reco::ClusterHit2D::m_docaToAxis

float m_docaToAxis

DOCA of hit at POCA to associated cluster axis.

Definition: Cluster3D.h:42

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

inline

Definition at line 84 of file Cluster3D.h.

References recob::operator<(), and recob::operator<<().

84 { m_hit = hit; }

reco::ClusterHit2D::m_hit

const recob::Hit * m_hit

Hit we are augmenting.

Definition: Cluster3D.h:47

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

inline

Definition at line 79 of file Cluster3D.h.

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

79 { m_statusBits |= bits; }

reco::ClusterHit2D::m_statusBits

unsigned m_statusBits

Volatile status information of this 3D hit.

Definition: Cluster3D.h:41

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

inline

Definition at line 76 of file Cluster3D.h.

Referenced by lar_cluster3d::StandardHit3DBuilder::findGoodHitPairs(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::SnippetHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), reco::RecobClusterParameters::UpdateParameters(), and reco::ClusterParameters::UpdateParameters().

76 { return m_wireID; }

reco::ClusterHit2D::m_wireID

geo::WireID m_wireID

Keep track this particular hit's wireID.

Definition: Cluster3D.h:46

Friends And Related Function Documentation

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

friend

Definition at line 68 of file Cluster3D.cxx.

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

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

friend

Definition at line 62 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 43 of file Cluster3D.h.

Referenced by ClusterHit2D().

float reco::ClusterHit2D::m_docaToAxis

mutableprivate

DOCA of hit at POCA to associated cluster axis.

Definition at line 42 of file Cluster3D.h.

Referenced by ClusterHit2D().

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

private

Hit we are augmenting.

Definition at line 47 of file Cluster3D.h.

Referenced by ClusterHit2D().

unsigned reco::ClusterHit2D::m_statusBits

mutableprivate

Volatile status information of this 3D hit.

Definition at line 41 of file Cluster3D.h.

Referenced by ClusterHit2D().

float reco::ClusterHit2D::m_timeTicks

private

The time (in ticks) for this hit.

Definition at line 45 of file Cluster3D.h.

Referenced by ClusterHit2D().

geo::WireID reco::ClusterHit2D::m_wireID

private

Keep track this particular hit's wireID.

Definition at line 46 of file Cluster3D.h.

Referenced by ClusterHit2D().

float reco::ClusterHit2D::m_xPosition

private

The x coordinate for this hit.

Definition at line 44 of file Cluster3D.h.

Referenced by ClusterHit2D().

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

larreco/v09_25_00/source/larreco/RecoAlg/Cluster3DAlgs/Cluster3D.h
larreco/v09_25_00/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