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

Class representing a raw cluster candidate during clustering of the SVD. More...

#include <RawCluster.h>

Collaboration diagram for RawCluster:

Public Member Functions

 RawCluster ()
 Default Constructor to create an empty RawCluster.
 
 RawCluster (VxdID vxdID, bool isUside, double cutSeed, double cutAdjacent)
 Constructor to create an empty RawCluster. More...
 
 RawCluster (VxdID vxdID, bool isUside, double cutSeed, double cutAdjacent, const std::string &storeShaperDigitsName)
 You can specify the name of StoreArray<SVDShaperDigit> which are needed to get clustered samples. More...
 
bool add (VxdID vxdID, bool isUside, struct StripInRawCluster &aStrip)
 Add a Strip to the current cluster. More...
 
bool isGoodRawCluster ()
 
VxdID getSensorID () const
 
bool isUSide () const
 
Belle2::SVDShaperDigit::APVFloatSamples getClsSamples (bool inElectrons) const
 
std::pair< int, std::vector< float > > getMaxSum3Samples (bool inElectrons=false) const
 
int getSize () const
 
const std::vector< StripInRawClustergetStripsInRawCluster () const
 
int getSeedMaxSample () const
 
int getSeedInternalIndex () const
 
void setStripCharge (int index, double charge)
 set the strip charge More...
 
void setStripTime (int index, double time)
 set the strip time More...
 

Protected Attributes

VxdID m_vxdID
 VxdID of the cluster.
 
bool m_isUside
 side of the cluster
 
double m_cutSeed = 5
 SNR above which the strip can be considered as seed.
 
double m_cutAdjacent = 3
 SNR above which the strip can be considered for clustering.
 
int m_seedMaxSample = -1
 ADC MaxSample of the seed strip.
 
float m_seedSNR = -1
 SNR (using MaxSample) of the seed strip.
 
int m_seedIndex = -1
 SVDShaperDigit index of the seed strip of the cluster.
 
int m_seedInternalIndex = -1
 stripsInRawCluster index of the seed strip of the cluster
 
std::vector< StripInRawClusterm_strips
 vector containing the strips in the cluster
 
std::string m_storeShaperDigitsName
 Name of the collection to use for the SVDShaperDigits.
 

Detailed Description

Class representing a raw cluster candidate during clustering of the SVD.

Definition at line 33 of file RawCluster.h.

Constructor & Destructor Documentation

◆ RawCluster() [1/2]

RawCluster ( VxdID  vxdID,
bool  isUside,
double  cutSeed,
double  cutAdjacent 
)

Constructor to create an empty RawCluster.

Parameters
vxdIDsensorID
isUsidetrue if the RawCluster is on the U-side
cutSeedminimum SNR of the seed strip
cutAdjacentminimum SNR of a strip belonging to the cluster

Definition at line 30 of file RawCluster.cc.

31  : m_vxdID(vxdID)
32  , m_isUside(isUside)
33  , m_cutSeed(cutSeed)
34  , m_cutAdjacent(cutAdjacent)
35  , m_seedMaxSample(-1)
36  , m_seedSNR(-1)
37  , m_seedIndex(-1)
39  , m_storeShaperDigitsName("SVDShaperDigits")
40  {m_strips.clear();};
std::string m_storeShaperDigitsName
Name of the collection to use for the SVDShaperDigits.
Definition: RawCluster.h:165
int m_seedInternalIndex
stripsInRawCluster index of the seed strip of the cluster
Definition: RawCluster.h:159
bool m_isUside
side of the cluster
Definition: RawCluster.h:141
VxdID m_vxdID
VxdID of the cluster.
Definition: RawCluster.h:138
float m_seedSNR
SNR (using MaxSample) of the seed strip.
Definition: RawCluster.h:153
int m_seedMaxSample
ADC MaxSample of the seed strip.
Definition: RawCluster.h:150
double m_cutSeed
SNR above which the strip can be considered as seed.
Definition: RawCluster.h:144
int m_seedIndex
SVDShaperDigit index of the seed strip of the cluster.
Definition: RawCluster.h:156
std::vector< StripInRawCluster > m_strips
vector containing the strips in the cluster
Definition: RawCluster.h:162
double m_cutAdjacent
SNR above which the strip can be considered for clustering.
Definition: RawCluster.h:147

◆ RawCluster() [2/2]

RawCluster ( VxdID  vxdID,
bool  isUside,
double  cutSeed,
double  cutAdjacent,
const std::string &  storeShaperDigitsName 
)

You can specify the name of StoreArray<SVDShaperDigit> which are needed to get clustered samples.

Parameters
vxdIDsensorID
isUsidetrue if the RawCluster is on the U-side
cutSeedminimum SNR of the seed strip
cutAdjacentminimum SNR of a strip belonging to the cluster
storeShaperDigitsNamename of the SVDShaperDigit StoreArray

Definition at line 42 of file RawCluster.cc.

Member Function Documentation

◆ add()

bool add ( VxdID  vxdID,
bool  isUside,
struct StripInRawCluster aStrip 
)

Add a Strip to the current cluster.

Update the cluster seed strip.

Parameters
vxdIDsensorID
isUsidetrue if the RawCluster is on the U-side
aStripthe raw strip to be added to the cluster
Returns
true if the strip is on the expected side and sensor and it's next to the last strip added to the cluster candidate

Definition at line 54 of file RawCluster.cc.

◆ getClsSamples()

Belle2::SVDShaperDigit::APVFloatSamples getClsSamples ( bool  inElectrons) const
Parameters
inElectronsif true samples are returned in electrons instead of ADC
Returns
the APVFloatSamples obtained summing sample-by-sample all the strips on the cluster

Definition at line 104 of file RawCluster.cc.

◆ getMaxSum3Samples()

std::pair< int, std::vector< float > > getMaxSum3Samples ( bool  inElectrons = false) const
Parameters
inElectronsif true samples are returned in electrons instead of ADC
Returns
the float vector of clustered 3-samples selected by the MaxSum method with First Frame of the selection

Definition at line 137 of file RawCluster.cc.

◆ getSeedInternalIndex()

int getSeedInternalIndex ( ) const
inline
Returns
the internal index (in the stripsInRawCluster vector) of the seed strip

Definition at line 120 of file RawCluster.h.

120 {return m_seedInternalIndex;};

◆ getSeedMaxSample()

int getSeedMaxSample ( ) const
inline
Returns
the max sample (in ADC) of the seed strip

Definition at line 115 of file RawCluster.h.

◆ getSensorID()

VxdID getSensorID ( void  ) const
inline
Returns
the VxdID of the cluster sensor

Definition at line 80 of file RawCluster.h.

◆ getSize()

int getSize ( ) const
inline
Returns
the cluster size (number of strips of the cluster)

Definition at line 105 of file RawCluster.h.

◆ getStripsInRawCluster()

const std::vector<StripInRawCluster> getStripsInRawCluster ( ) const
inline
Returns
the vector of the strips in the cluster

Definition at line 110 of file RawCluster.h.

◆ isGoodRawCluster()

bool isGoodRawCluster ( )
Returns
true if the raw cluster candidate can be promoted to raw cluster (seedMaxSample > 0 and seedSNR > cutSeed)

Definition at line 92 of file RawCluster.cc.

◆ isUSide()

bool isUSide ( ) const
inline
Returns
true if the cluster is on the U/P side

Definition at line 85 of file RawCluster.h.

◆ setStripCharge()

void setStripCharge ( int  index,
double  charge 
)
inline

set the strip charge

Parameters
indexof the strip in the cluster
chargeof the strip

Definition at line 127 of file RawCluster.h.

◆ setStripTime()

void setStripTime ( int  index,
double  time 
)
inline

set the strip time

Parameters
indexof the strip in the cluster
timeof the strip

Definition at line 133 of file RawCluster.h.


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