reco::ClusterHit3D Class Reference

#include <Cluster3D.h>

Public Types
enum	StatusBits {   REJECTEDHIT = 0x80000000, SKELETONHIT = 0x10000000, EDGEHIT = 0x20000000, SEEDHIT = 0x40000000,   MADESPACEPOINT = 0x08000000, CONVEXHULLVTX = 0x04000000, EXTREMEPOINT = 0x02000000, SKELETONPOSAVE = 0x00100000,   CLUSTERVISITED = 0x00008000, CLUSTERNOISE = 0x00004000, CLUSTERATTACHED = 0x00002000, CLUSTERSHARED = 0x00001000,   PATHCHECKED = 0x00000800, SELECTEDBYMST = 0x00000100, PCAOUTLIER = 0x00000080, HITINVIEW0 = 0x00000001,   HITINVIEW1 = 0x00000002, HITINVIEW2 = 0x00000004 }

Public Member Functions
	ClusterHit3D ()
	ClusterHit3D (size_t id, unsigned int statusBits, const Eigen::Vector3f &position, float totalCharge, float avePeakTime, float deltaPeakTime, float sigmaPeakTime, float hitChiSquare, float overlapFraction, float chargeAsymmetry, float docaToAxis, float arclenToPoca, const ClusterHit2DVec &hitVec, const std::vector< float > &hitDelTSigVec, const std::vector< geo::WireID > &wireIDVec)
	ClusterHit3D (const ClusterHit3D &)
void	initialize (size_t id, unsigned int statusBits, const Eigen::Vector3f &position, float totalCharge, float avePeakTime, float deltaPeakTime, float sigmaPeakTime, float hitChiSquare, float overlapFraction, float chargeAsymmetry, float docaToAxis, float arclenToPoca, const ClusterHit2DVec &hitVec, const std::vector< float > &hitDelTSigVec, const std::vector< geo::WireID > &wireIDVec)
size_t	getID () const
unsigned int	getStatusBits () const
const Eigen::Vector3f	getPosition () const
float	getX () const
float	getY () const
float	getZ () const
float	getTotalCharge () const
float	getAvePeakTime () const
float	getDeltaPeakTime () const
float	getSigmaPeakTime () const
float	getHitChiSquare () const
float	getOverlapFraction () const
float	getChargeAsymmetry () const
float	getDocaToAxis () const
float	getArclenToPoca () const
const ClusterHit2DVec &	getHits () const
const std::vector< float >	getHitDelTSigVec () const
const std::vector< geo::WireID > &	getWireIDs () const
ClusterHit2DVec &	getHits ()
bool	bitsAreSet (const unsigned int &bitsToCheck) const
void	setID (const size_t &id) const
void	setStatusBit (unsigned bits) const
void	clearStatusBits (unsigned bits) const
void	setDocaToAxis (double doca) const
void	setArclenToPoca (double poca) const
void	setWireID (const geo::WireID &wid) const
void	setPosition (const Eigen::Vector3f &pos) const
const bool	operator< (const reco::ClusterHit3D &other) const
const bool	operator== (const reco::ClusterHit3D &other) const

Private Attributes
size_t	fID
	"id" of this hit (useful for indexing) More...
unsigned int	fStatusBits
	Volatile status information of this 3D hit. More...
Eigen::Vector3f	fPosition
	position of this hit combination in world coordinates More...
float	fTotalCharge
	Sum of charges of all associated recob::Hits. More...
float	fAvePeakTime
	Average peak time of all associated recob::Hits. More...
float	fDeltaPeakTime
	Largest delta peak time of associated recob::Hits. More...
float	fSigmaPeakTime
	Quad sum of peak time sigmas. More...
float	fHitChiSquare
	Hit ChiSquare relative to the average time. More...
float	fOverlapFraction
	Hit overlap fraction start/stop of triplet. More...
float	fChargeAsymmetry
	Assymetry of average of two closest to third charge. More...
float	fDocaToAxis
	DOCA to the associated cluster axis. More...
float	fArclenToPoca
	arc length along axis to DOCA point More...
ClusterHit2DVec	fHitVector
	Hits comprising this 3D hit. More...
std::vector< float >	fHitDelTSigVec
	Delta t of hit to matching pair / sig. More...
std::vector< geo::WireID >	fWireIDVector
	Wire ID's for the planes making up hit. More...

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

Detailed Description

Definition at line 95 of file Cluster3D.h.

Member Enumeration Documentation

enum reco::ClusterHit3D::StatusBits

Enumerator
REJECTEDHIT	Hit has been rejected for any reason.
SKELETONHIT	Hit is a "skeleton" hit.
EDGEHIT	Hit is an "edge" hit.
SEEDHIT	Hit is part of Seed for track fits.
MADESPACEPOINT	Hit has been made into Space Point.
CONVEXHULLVTX	Point is on primary cluster convex hull.
EXTREMEPOINT	Is a convex hull extreme point.
SKELETONPOSAVE	Skeleton hit position averaged.
CLUSTERVISITED	"visited" by a clustering algorithm
CLUSTERNOISE	Labelled "noise" by a clustering algorithm.
CLUSTERATTACHED	attached to a cluster
CLUSTERSHARED	3D hit has 2D hits shared between clusters
PATHCHECKED	Path checking algorithm has seen this hit.
SELECTEDBYMST	Hit has been used in Cluster Splitting MST.
PCAOUTLIER	Hit labelled outlier in PCA.
HITINVIEW0	Hit contains 2D hit from view 0 (u plane)
HITINVIEW1	Hit contains 2D hit from view 1 (v plane)
HITINVIEW2	Hit contains 2D hit from view 2 (w plane)

Definition at line 99 of file Cluster3D.h.

                    { REJECTEDHIT     = 0x80000000,           ///< Hit has been rejected for any reason
                      SKELETONHIT     = 0x10000000,           ///< Hit is a "skeleton" hit
                      EDGEHIT         = 0x20000000,           ///< Hit is an "edge" hit
                      SEEDHIT         = 0x40000000,           ///< Hit is part of Seed for track fits
                      MADESPACEPOINT  = 0x08000000,           ///< Hit has been made into Space Point
                      CONVEXHULLVTX   = 0x04000000,           ///< Point is on primary cluster convex hull
                      EXTREMEPOINT    = 0x02000000,           ///< Is a convex hull extreme point
                      SKELETONPOSAVE  = 0x00100000,           ///< Skeleton hit position averaged
                      CLUSTERVISITED  = 0x00008000,           ///< "visited" by a clustering algorithm
                      CLUSTERNOISE    = 0x00004000,           ///< Labelled "noise" by a clustering algorithm
                      CLUSTERATTACHED = 0x00002000,           ///< attached to a cluster
                      CLUSTERSHARED   = 0x00001000,           ///< 3D hit has 2D hits shared between clusters
                      PATHCHECKED     = 0x00000800,           ///< Path checking algorithm has seen this hit
                      SELECTEDBYMST   = 0x00000100,           ///< Hit has been used in Cluster Splitting MST
                      PCAOUTLIER      = 0x00000080,           ///< Hit labelled outlier in PCA
                      HITINVIEW0      = 0x00000001,           ///< Hit contains 2D hit from view 0 (u plane)
                      HITINVIEW1      = 0x00000002,           ///< Hit contains 2D hit from view 1 (v plane)
                      HITINVIEW2      = 0x00000004            ///< Hit contains 2D hit from view 2 (w plane)
                    };

Constructor & Destructor Documentation

reco::ClusterHit3D::ClusterHit3D

(

)

Definition at line 63 of file Cluster3D.cxx.

                           : fID(std::numeric_limits<size_t>::max()),
                               fStatusBits(0),
                               fPosition(Eigen::Vector3f::Zero()),
                               fTotalCharge(0.),
                               fAvePeakTime(-1.),
                               fDeltaPeakTime(0.),
                               fSigmaPeakTime(0.),
                               fHitChiSquare(0.),
                               fOverlapFraction(0.),
                               fChargeAsymmetry(0.),
                               fDocaToAxis(0.),
                               fArclenToPoca(0.)
{
    fHitDelTSigVec.clear();
    fWireIDVector.clear();
    fHitVector.clear();
    fHitDelTSigVec.resize(3, 0.);
    fWireIDVector.resize(3, geo::WireID());
    fHitVector.resize(3, NULL);
}

reco::ClusterHit3D::ClusterHit3D	(	size_t	id,
		unsigned int	statusBits,
		const Eigen::Vector3f &	position,
		float	totalCharge,
		float	avePeakTime,
		float	deltaPeakTime,
		float	sigmaPeakTime,
		float	hitChiSquare,
		float	overlapFraction,
		float	chargeAsymmetry,
		float	docaToAxis,
		float	arclenToPoca,
		const ClusterHit2DVec &	hitVec,
		const std::vector< float > &	hitDelTSigVec,
		const std::vector< geo::WireID > &	wireIDVec
	)

Definition at line 84 of file Cluster3D.cxx.

                                                                :
              fID(id),
              fStatusBits(statusBits),
              fPosition(position),
              fTotalCharge(totalCharge),
              fAvePeakTime(avePeakTime),
              fDeltaPeakTime(deltaPeakTime),
              fSigmaPeakTime(sigmaPeakTime),
              fHitChiSquare(hitChiSquare),
              fOverlapFraction(overlapFraction),
              fChargeAsymmetry(chargeAsymmetry),
              fDocaToAxis(docaToAxis),
              fArclenToPoca(arclenToPoca),
              fHitDelTSigVec(hitDelTSigVec),
              fWireIDVector(wireIDs)
{
    fHitVector.resize(3,NULL);
    std::copy(hitVec.begin(),hitVec.end(),fHitVector.begin());
}

reco::ClusterHit3D::ClusterHit3D

(

const ClusterHit3D &

toCopy

)

Definition at line 118 of file Cluster3D.cxx.

{
    fID              = toCopy.fID;
    fStatusBits      = toCopy.fStatusBits;
    fPosition        = toCopy.fPosition;
    fTotalCharge     = toCopy.fTotalCharge;
    fAvePeakTime     = toCopy.fAvePeakTime;
    fDeltaPeakTime   = toCopy.fDeltaPeakTime;
    fSigmaPeakTime   = toCopy.fSigmaPeakTime;
    fHitChiSquare    = toCopy.fHitChiSquare;
    fOverlapFraction = toCopy.fOverlapFraction;
    fChargeAsymmetry = toCopy.fChargeAsymmetry;
    fDocaToAxis      = toCopy.fDocaToAxis;
    fArclenToPoca    = toCopy.fArclenToPoca;
    fHitVector       = toCopy.fHitVector;
    fHitDelTSigVec   = toCopy.fHitDelTSigVec;
    fWireIDVector    = toCopy.fWireIDVector;
}

Member Function Documentation

bool reco::ClusterHit3D::bitsAreSet ( const unsigned int &  bitsToCheck ) const

inline

Definition at line 177 of file Cluster3D.h.

{return fStatusBits & bitsToCheck;}

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

inline

Definition at line 181 of file Cluster3D.h.

{fStatusBits   &= ~bits;}

float reco::ClusterHit3D::getArclenToPoca ( ) const

inline

Definition at line 170 of file Cluster3D.h.

{return fArclenToPoca;}

float reco::ClusterHit3D::getAvePeakTime ( ) const

inline

Definition at line 163 of file Cluster3D.h.

{return fAvePeakTime;}

float reco::ClusterHit3D::getChargeAsymmetry ( ) const

inline

Definition at line 168 of file Cluster3D.h.

{return fChargeAsymmetry;}

float reco::ClusterHit3D::getDeltaPeakTime ( ) const

inline

Definition at line 164 of file Cluster3D.h.

{return fDeltaPeakTime;}

float reco::ClusterHit3D::getDocaToAxis ( ) const

inline

Definition at line 169 of file Cluster3D.h.

{return fDocaToAxis;}

float reco::ClusterHit3D::getHitChiSquare ( ) const

inline

Definition at line 166 of file Cluster3D.h.

{return fHitChiSquare;}

const std::vector<float> reco::ClusterHit3D::getHitDelTSigVec ( ) const

inline

Definition at line 172 of file Cluster3D.h.

{return fHitDelTSigVec;}

const ClusterHit2DVec& reco::ClusterHit3D::getHits ( ) const

inline

Definition at line 171 of file Cluster3D.h.

{return fHitVector;}

ClusterHit2DVec& reco::ClusterHit3D::getHits ( )

inline

Definition at line 175 of file Cluster3D.h.

{return fHitVector;}

size_t reco::ClusterHit3D::getID ( ) const

inline

Definition at line 156 of file Cluster3D.h.

{return fID;}

float reco::ClusterHit3D::getOverlapFraction ( ) const

inline

Definition at line 167 of file Cluster3D.h.

{return fOverlapFraction;}

const Eigen::Vector3f reco::ClusterHit3D::getPosition ( ) const

inline

Definition at line 158 of file Cluster3D.h.

{return fPosition;}

float reco::ClusterHit3D::getSigmaPeakTime ( ) const

inline

Definition at line 165 of file Cluster3D.h.

{return fSigmaPeakTime;}

unsigned int reco::ClusterHit3D::getStatusBits ( ) const

inline

Definition at line 157 of file Cluster3D.h.

{return fStatusBits;}

float reco::ClusterHit3D::getTotalCharge ( ) const

inline

Definition at line 162 of file Cluster3D.h.

{return fTotalCharge;}

const std::vector<geo::WireID>& reco::ClusterHit3D::getWireIDs ( ) const

inline

Definition at line 173 of file Cluster3D.h.

{return fWireIDVector;}

float reco::ClusterHit3D::getX ( ) const

inline

Definition at line 159 of file Cluster3D.h.

{return fPosition[0];}

float reco::ClusterHit3D::getY ( ) const

inline

Definition at line 160 of file Cluster3D.h.

{return fPosition[1];}

float reco::ClusterHit3D::getZ ( ) const

inline

Definition at line 161 of file Cluster3D.h.

{return fPosition[2];}

void reco::ClusterHit3D::initialize	(	size_t	id,
		unsigned int	statusBits,
		const Eigen::Vector3f &	position,
		float	totalCharge,
		float	avePeakTime,
		float	deltaPeakTime,
		float	sigmaPeakTime,
		float	hitChiSquare,
		float	overlapFraction,
		float	chargeAsymmetry,
		float	docaToAxis,
		float	arclenToPoca,
		const ClusterHit2DVec &	hitVec,
		const std::vector< float > &	hitDelTSigVec,
		const std::vector< geo::WireID > &	wireIDVec
	)

Definition at line 137 of file Cluster3D.cxx.

{
    fID              = id;
    fStatusBits      = statusBits;
    fPosition        = position;
    fTotalCharge     = totalCharge;
    fAvePeakTime     = avePeakTime;
    fDeltaPeakTime   = deltaPeakTime;
    fSigmaPeakTime   = sigmaPeakTime;
    fHitChiSquare    = hitChiSquare;
    fOverlapFraction = overlapFraction;
    fChargeAsymmetry = chargeAsymmetry;
    fDocaToAxis      = docaToAxis;
    fArclenToPoca    = arclenToPoca;
    fHitVector       = hitVec;
    fHitDelTSigVec   = hitDelTSigVec;
    fWireIDVector    = wireIDs;

    return;
}

const bool reco::ClusterHit3D::operator< ( const reco::ClusterHit3D &  other ) const

inline

Definition at line 188 of file Cluster3D.h.

    {
        if (fPosition[2] != other.fPosition[2]) return fPosition[2] < other.fPosition[2];
        else return fPosition[0] < other.fPosition[0];
    }

const bool reco::ClusterHit3D::operator== ( const reco::ClusterHit3D &  other ) const

inline

Definition at line 194 of file Cluster3D.h.

    {
        return fID == other.fID;
    }

void reco::ClusterHit3D::setArclenToPoca ( double  poca ) const

inline

Definition at line 183 of file Cluster3D.h.

{fArclenToPoca  = poca;}

void reco::ClusterHit3D::setDocaToAxis ( double  doca ) const

inline

Definition at line 182 of file Cluster3D.h.

{fDocaToAxis    = doca;}

void reco::ClusterHit3D::setID ( const size_t &  id ) const

inline

Definition at line 179 of file Cluster3D.h.

{fID            = id;}

void reco::ClusterHit3D::setPosition ( const Eigen::Vector3f &  pos ) const

inline

Definition at line 186 of file Cluster3D.h.

{fPosition = pos;}

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

inline

Definition at line 180 of file Cluster3D.h.

{fStatusBits   |= bits;}

void reco::ClusterHit3D::setWireID

(

const geo::WireID &

wid

)

const

Definition at line 172 of file Cluster3D.cxx.

{
    fWireIDVector[wid.Plane] = wid;
}

Friends And Related Function Documentation

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

friend

Definition at line 177 of file Cluster3D.cxx.

{
    o << "ClusterHit3D has " << c.getHits().size() << " hits associated";

    return o;
}

Member Data Documentation

float reco::ClusterHit3D::fArclenToPoca

mutableprivate

arc length along axis to DOCA point

Definition at line 215 of file Cluster3D.h.

float reco::ClusterHit3D::fAvePeakTime

private

Average peak time of all associated recob::Hits.

Definition at line 208 of file Cluster3D.h.

float reco::ClusterHit3D::fChargeAsymmetry

private

Assymetry of average of two closest to third charge.

Definition at line 213 of file Cluster3D.h.

float reco::ClusterHit3D::fDeltaPeakTime

private

Largest delta peak time of associated recob::Hits.

Definition at line 209 of file Cluster3D.h.

float reco::ClusterHit3D::fDocaToAxis

mutableprivate

DOCA to the associated cluster axis.

Definition at line 214 of file Cluster3D.h.

float reco::ClusterHit3D::fHitChiSquare

private

Hit ChiSquare relative to the average time.

Definition at line 211 of file Cluster3D.h.

std::vector<float> reco::ClusterHit3D::fHitDelTSigVec

mutableprivate

Delta t of hit to matching pair / sig.

Definition at line 217 of file Cluster3D.h.

ClusterHit2DVec reco::ClusterHit3D::fHitVector

private

Hits comprising this 3D hit.

Definition at line 216 of file Cluster3D.h.

size_t reco::ClusterHit3D::fID

mutableprivate

"id" of this hit (useful for indexing)

Definition at line 204 of file Cluster3D.h.

float reco::ClusterHit3D::fOverlapFraction

private

Hit overlap fraction start/stop of triplet.

Definition at line 212 of file Cluster3D.h.

Eigen::Vector3f reco::ClusterHit3D::fPosition

mutableprivate

position of this hit combination in world coordinates

Definition at line 206 of file Cluster3D.h.

float reco::ClusterHit3D::fSigmaPeakTime

private

Quad sum of peak time sigmas.

Definition at line 210 of file Cluster3D.h.

unsigned int reco::ClusterHit3D::fStatusBits

mutableprivate

Volatile status information of this 3D hit.

Definition at line 205 of file Cluster3D.h.

float reco::ClusterHit3D::fTotalCharge

private

Sum of charges of all associated recob::Hits.

Definition at line 207 of file Cluster3D.h.

std::vector<geo::WireID> reco::ClusterHit3D::fWireIDVector

mutableprivate

Wire ID's for the planes making up hit.

Definition at line 218 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