Belle II Software  release-08-01-10
MCVXDPurityInfo Class Reference

The MC VXD Purity info container class. More...

#include <MCVXDPurityInfo.h>

Collaboration diagram for MCVXDPurityInfo:

Public Member Functions

 MCVXDPurityInfo ()
 empty constructor
 
 MCVXDPurityInfo (int iD, unsigned int nPXDClustersTotal, unsigned int nSVDUClustersTotal, unsigned int nSVDVClustersTotal, unsigned int nPXDClusters, unsigned int nSVDUClusters, unsigned int nSVDVClusters)
 constructor parameters: iD, the particleID nPXDClustersTotal, the number of PXDClusters the TrackCandidate container had (no matter which particleID was connected to the clusters) nSVDUClustersTotal, the number of SVDClusters for u-strips the TrackCandidate container had (no matter which particleID was connected to the clusters) nSVDVClustersTotal, the number of SVDClusters for v-strips the TrackCandidate container had (no matter which particleID was connected to the clusters) nPXDClusters, the number of PXDClusters connected to iD nSVDUClusters, the number of SVDClusters for u-strips connected to iD nSVDVClusters, the number of SVDClusters for v-strips connected to iD
 
 MCVXDPurityInfo (int iD, std::array< unsigned int, 3 > nClustersTotal, std::array< unsigned int, 3 > nMCClusters)
 constructor More...
 
bool operator> (const MCVXDPurityInfo &b) const
 operator for sorting. More...
 
bool operator< (const MCVXDPurityInfo &b) const
 operator for sorting. More...
 
std::pair< int, float > getPurity () const
 getter - returns overal purity (.second) for this particleID (.first). More...
 
std::pair< int, float > getPurityPXD () const
 getter - returns purity for PXDClusters (.second) for this particleID (.first)
 
std::pair< int, float > getPuritySVD () const
 getter - returns purity for SVDClusters (.second) for this particleID (.first)
 
std::pair< int, float > getPuritySVDU () const
 getter - returns purity for SVDClusters of u-type (.second) for this particleID (.first)
 
std::pair< int, float > getPuritySVDV () const
 getter - returns purity for SVDClusters of v-type (.second) for this particleID (.first)
 
int getParticleID () const
 getter - returns the ID of the particle, if value is -1 no particle has been able to be found for it
 
unsigned int getNClustersTotal () const
 returns total number of clusters the trackCandidate had
 
unsigned int getNPXDClustersTotal () const
 getter - returns total number of PXDClusters in the TrackCandidate
 
unsigned int getNSVDUClustersTotal () const
 getter - returns total number of u-type SVDClustes in the TrackCandidate
 
unsigned int getNSVDVClustersTotal () const
 getter - returns total number of v-type SVDClustes in the TrackCandidate
 
unsigned int getNClustersFound () const
 returns number of clusters the trackCandidate had assigned to this iD
 
unsigned int getNPXDClusters () const
 getter - returns number of PXDClusters found to this iD
 
unsigned int getNSVDUClusters () const
 getter - returns number of u-type SVDClustes found to this iD
 
unsigned int getNSVDVClusters () const
 getter - returns number of v-type SVDClustes found to this iD
 
unsigned int getNDFTotal () const
 getter - returns number of degrees of freedom for all Clusters in TC total
 
unsigned int getNDFFound () const
 getter - returns number of degrees of freedom for all Clusters in TC found
 
unsigned int getNDFPXDTotal () const
 getter - returns number of degrees of freedom for PXD Clusters in TC total
 
unsigned int getNDFPXDFound () const
 getter - returns number of degrees of freedom for PXD Clusters in TC found
 
unsigned int getNDFSVDTotal () const
 getter - returns number of degrees of freedom for SVD Clusters in TC total
 
unsigned int getNDFSVDFound () const
 getter - returns number of degrees of freedom for SVD Clusters in TC found
 
unsigned int getNDFSVDUTotal () const
 getter - returns number of degrees of freedom for u-type SVDClustes in the TrackCandidate
 
unsigned int getNDFSVDVTotal () const
 getter - returns number of degrees of freedom for v-type SVDClustes in the TrackCandidate
 
unsigned int getNDFSVDUFound () const
 getter - returns number of degrees of freedom for u-type SVDClustes found to this iD
 
unsigned int getNDFSVDVFound () const
 getter - returns number of degrees of freedom for v-type SVDClustes found to this iD
 
std::string dumpToString () const
 dump the contents to a string (for easier debugging)
 

Protected Attributes

int m_iD
 stores the particleID
 
std::array< unsigned int, 3 > m_nTotalClusters
 stores the number of clusters the TrackCandidate container had. More...
 
std::array< unsigned int, 3 > m_nFoundClusters
 stores the number for each ClusterType, PXD in [0], SVD-U in [1], and SVD-V in [2]
 

Detailed Description

The MC VXD Purity info container class.

This class stores for a particleID the number of clusters found in a TrackCandidate container.

Definition at line 27 of file MCVXDPurityInfo.h.

Constructor & Destructor Documentation

◆ MCVXDPurityInfo()

MCVXDPurityInfo ( int  iD,
std::array< unsigned int, 3 >  nClustersTotal,
std::array< unsigned int, 3 >  nMCClusters 
)
inline

constructor

Parameters
iDparticle Id
nClustersTotalthe total number of Clusters in the container as array ([0] is PXDClusters, [1]/[2] are SVD U-/V- Clusters)
nMCClustersthe number of Clusters in the container connectoed to iD as array

Definition at line 75 of file MCVXDPurityInfo.h.

75  :
76  m_iD(iD), m_nTotalClusters(nClustersTotal), m_nFoundClusters(nMCClusters) { }
std::array< unsigned int, 3 > m_nFoundClusters
stores the number for each ClusterType, PXD in [0], SVD-U in [1], and SVD-V in [2]
std::array< unsigned int, 3 > m_nTotalClusters
stores the number of clusters the TrackCandidate container had.
int m_iD
stores the particleID

Member Function Documentation

◆ getPurity()

std::pair<int, float> getPurity ( ) const
inline

getter - returns overal purity (.second) for this particleID (.first).

since PXD-Clusters are counting as two measurements, they count twice.

Definition at line 104 of file MCVXDPurityInfo.h.

◆ operator<()

bool operator< ( const MCVXDPurityInfo b) const
inline

operator for sorting.

will be compared using overal purity NOTE: only the purity will be compared (i.e. .second), the iD is not used!

Definition at line 94 of file MCVXDPurityInfo.h.

◆ operator>()

bool operator> ( const MCVXDPurityInfo b) const
inline

operator for sorting.

will be compared using overal purity NOTE: only the purity will be compared (i.e. .second), the iD is not used!

Definition at line 83 of file MCVXDPurityInfo.h.

Member Data Documentation

◆ m_nTotalClusters

std::array<unsigned int, 3> m_nTotalClusters
protected

stores the number of clusters the TrackCandidate container had.

(no matter which particleID was connected to the clusters) for each ClusterType, PXD in [0], SVD-U in [1], and SVD-V in [2]

Definition at line 35 of file MCVXDPurityInfo.h.


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