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

#include <RawCluster.h>

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.

	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.

bool	add (VxdID vxdID, bool isUside, struct StripInRawCluster &aStrip)
	Add a Strip to the current cluster.

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< StripInRawCluster >	getStripsInRawCluster () const

int	getSeedMaxSample () const

int	getSeedInternalIndex () const

void	setStripCharge (int index, double charge)
	set the strip charge

void	setStripTime (int index, double time)
	set the strip time

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< StripInRawCluster >	m_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/3]

RawCluster ( )

inline

Default Constructor to create an empty RawCluster.

Definition at line 40 of file RawCluster.h.

40{};

◆ RawCluster() [2/3]

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

Constructor to create an empty RawCluster.

Parameters

vxdID	sensorID
isUside	true if the RawCluster is on the U-side
cutSeed	minimum SNR of the seed strip
cutAdjacent	minimum SNR of a strip belonging to the cluster

Definition at line 30 of file RawCluster.cc.

      : m_vxdID(vxdID)
      , m_isUside(isUside)
      , m_cutSeed(cutSeed)
      , m_cutAdjacent(cutAdjacent)
      , m_seedMaxSample(-1)
      , m_seedSNR(-1)
      , m_seedIndex(-1)
      , m_seedInternalIndex(-1)
      , m_storeShaperDigitsName("SVDShaperDigits")
    {m_strips.clear();};

◆ RawCluster() [3/3]

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

vxdID	sensorID
isUside	true if the RawCluster is on the U-side
cutSeed	minimum SNR of the seed strip
cutAdjacent	minimum SNR of a strip belonging to the cluster
storeShaperDigitsName	name of the SVDShaperDigit StoreArray

Definition at line 42 of file RawCluster.cc.

      : m_vxdID(vxdID)
      , m_isUside(isUside)
      , m_cutSeed(cutSeed)
      , m_cutAdjacent(cutAdjacent)
      , m_seedMaxSample(-1)
      , m_seedSNR(-1)
      , m_seedIndex(-1)
      , m_seedInternalIndex(-1)
      , m_storeShaperDigitsName(storeShaperDigitsName)
    {m_strips.clear();};

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

vxdID	sensorID
isUside	true if the RawCluster is on the U-side
aStrip	the 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.

    {
 
      bool added = false;
 
      //do not add if you are on the wrong sensor or side
      if ((m_vxdID != vxdID) || (m_isUside != isUside))
        return false;
 
      //do not add if its SNR is below the minimum SNR for adjacents strips
      if ((float)aStrip.maxSample / aStrip.noise < m_cutAdjacent)
        return false;
 
      //add if it's the first strip
      if (m_strips.size() == 0)
        added = true;
 
      //add if it is adjacent to the last strip added
      //(we assume that SVDShaperDigits are ordered)
      if ((m_strips.size() > 0 && (aStrip.cellID == m_strips.at(m_strips.size() - 1).cellID + 1)))
        added  = true;
 
      //add it to the vector of strips, update the seed max sample and index:
      if (added) {
        m_strips.push_back(aStrip);
 
        if (aStrip.maxSample > m_seedMaxSample) {
          m_seedMaxSample = aStrip.maxSample;
          m_seedSNR = (float)aStrip.maxSample / (float)aStrip.noise;
          m_seedInternalIndex = m_strips.size() - 1;
          m_seedIndex = aStrip.shaperDigitIndex;
        }
      }
      return added;
 
    };

◆ getClsSamples()

Belle2::SVDShaperDigit::APVFloatSamples getClsSamples ( bool inElectrons ) const

Parameters

inElectrons if 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.

    {
 
      if (m_strips.size() == 0)
        B2ERROR("oopps ... you are asking for the cluster samples of a cluster candidate with no strips");
 
      //steps:
      //1.loop on m_strips
      //2. access the index of the shaperdigit from the element of m_strip
      //3. sum each sample for each strip accessed in the loop
      //4. you are done
 
      Belle2::SVDShaperDigit::APVFloatSamples returnSamples = {0, 0, 0, 0, 0, 0};
 
      const StoreArray<SVDShaperDigit> m_storeShaperDigits(m_storeShaperDigitsName.c_str());
 
      SVDPulseShapeCalibrations pulseShapeCal;
 
      for (auto istrip : m_strips) {
        const SVDShaperDigit* shaperdigit = m_storeShaperDigits[istrip.shaperDigitIndex];
        if (!shaperdigit) B2ERROR("No SVDShaperDigit for this strip! Are you sure you set the correct SVDShaperDigit StoreArray name?");
        Belle2::SVDShaperDigit::APVFloatSamples APVsamples = shaperdigit->getSamples();
        for (int iSample = 0; iSample < static_cast<int>(APVsamples.size()); ++iSample)
          if (inElectrons)
            returnSamples.at(iSample) += pulseShapeCal.getChargeFromADC(m_vxdID, m_isUside, shaperdigit->getCellID(), APVsamples.at(iSample));
          else
            returnSamples.at(iSample) += APVsamples.at(iSample);
      }
 
 
      return returnSamples;
    }

◆ getMaxSum3Samples()

std::pair< int, std::vector< float > > getMaxSum3Samples ( bool inElectrons = false ) const

Parameters

inElectrons if 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.

    {
 
      //take the cluster samples
      Belle2::SVDShaperDigit::APVFloatSamples clsSamples = getClsSamples(inElectrons);
 
      SVDMaxSumAlgorithm maxSum = SVDMaxSumAlgorithm(clsSamples);
      return std::make_pair(maxSum.getFirstFrame(), maxSum.getSelectedSamples());
 
    }

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

115{return m_seedMaxSample;};

◆ getSensorID()

VxdID getSensorID ( ) const

inline

Returns: the VxdID of the cluster sensor

Definition at line 80 of file RawCluster.h.

80{return m_vxdID;}

◆ getSize()

int getSize ( ) const

inline

Returns: the cluster size (number of strips of the cluster)

Definition at line 105 of file RawCluster.h.

105{ return m_strips.size(); }

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

110{ return m_strips; };

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

    {
 
      bool isGood = false;
 
      if (m_seedMaxSample > 0 && m_seedSNR >= m_cutSeed)
        isGood = true;
 
      return isGood;
    };

◆ isUSide()

bool isUSide ( ) const

inline

Returns: true if the cluster is on the U/P side

Definition at line 85 of file RawCluster.h.

85{return m_isUside;}

◆ setStripCharge()

void setStripCharge	(	int	index,
		double	charge
	)

inline

set the strip charge

Parameters

index	of the strip in the cluster
charge	of the strip

Definition at line 127 of file RawCluster.h.

127{m_strips.at(index).charge = charge;}

Belle2::EvtPDLUtil::charge

double charge(int pdgCode)

Returns electric charge of a particle with given pdg code.

Definition: EvtPDLUtil.cc:44

◆ setStripTime()

void setStripTime	(	int	index,
		double	time
	)

inline

set the strip time

Parameters

index	of the strip in the cluster
time	of the strip

Definition at line 133 of file RawCluster.h.

133{m_strips.at(index).time = time;}

Member Data Documentation

◆ m_cutAdjacent

double m_cutAdjacent = 3

protected

SNR above which the strip can be considered for clustering.

Definition at line 147 of file RawCluster.h.

◆ m_cutSeed

double m_cutSeed = 5

protected

SNR above which the strip can be considered as seed.

Definition at line 144 of file RawCluster.h.

◆ m_isUside

bool m_isUside

protected

side of the cluster

Definition at line 141 of file RawCluster.h.

◆ m_seedIndex

int m_seedIndex = -1

protected

SVDShaperDigit index of the seed strip of the cluster.

Definition at line 156 of file RawCluster.h.

◆ m_seedInternalIndex

int m_seedInternalIndex = -1

protected

stripsInRawCluster index of the seed strip of the cluster

Definition at line 159 of file RawCluster.h.

◆ m_seedMaxSample

int m_seedMaxSample = -1

protected

ADC MaxSample of the seed strip.

Definition at line 150 of file RawCluster.h.

◆ m_seedSNR

float m_seedSNR = -1

protected

SNR (using MaxSample) of the seed strip.

Definition at line 153 of file RawCluster.h.

◆ m_storeShaperDigitsName

std::string m_storeShaperDigitsName

protected

Name of the collection to use for the SVDShaperDigits.

Definition at line 165 of file RawCluster.h.

◆ m_strips

std::vector<StripInRawCluster> m_strips

protected

vector containing the strips in the cluster

Definition at line 162 of file RawCluster.h.

◆ m_vxdID

VxdID m_vxdID

protected

VxdID of the cluster.

Definition at line 138 of file RawCluster.h.

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

svd/reconstruction/include/RawCluster.h
svd/reconstruction/src/RawCluster.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RawCluster() [1/3]

◆ RawCluster() [2/3]

◆ RawCluster() [3/3]

Member Function Documentation

◆ add()

◆ getClsSamples()

◆ getMaxSum3Samples()

◆ getSeedInternalIndex()

◆ getSeedMaxSample()

◆ getSensorID()

◆ getSize()

◆ getStripsInRawCluster()

◆ isGoodRawCluster()

◆ isUSide()

◆ setStripCharge()

◆ setStripTime()

Member Data Documentation

◆ m_cutAdjacent

◆ m_cutSeed

◆ m_isUside

◆ m_seedIndex

◆ m_seedInternalIndex

◆ m_seedMaxSample

◆ m_seedSNR

◆ m_storeShaperDigitsName

◆ m_strips

◆ m_vxdID