Project
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
o2::tpc::KrBoxClusterFinder Class Reference

#include <KrBoxClusterFinder.h>

Public Member Functions

 KrBoxClusterFinder ()=default
 
 KrBoxClusterFinder (int sector)
 
void loadGainMapFromFile (const std::string_view calDetFileName, const std::string_view gainMapName="GainMap")
 
std::vector< std::tuple< int, int, int > > findLocalMaxima (bool directFilling=true, const int timeOffset=0)
 After the map is created, we look for local maxima with this function:
 
KrCluster buildCluster (int clusterCenterPad, int clusterCenterRow, int clusterCenterTime, bool directFilling=false, const int timeOffset=0)
 
void resetClusters ()
 reset cluster vector
 
std::vector< KrCluster > & getClusters ()
 
const std::vector< KrCluster > & getClusters () const
 
void setSector (int sector)
 set sector of this instance
 
int getSector () const
 ger sector of this instance
 
void init ()
 initialize the parameters from KrBoxClusterFinderParam
 
void setMinNumberOfNeighbours (int minNumberOfNeighbours)
 Set Function for minimum number of direct neighbours required.
 
void setMinQTreshold (int minQThreshold)
 Set Function for minimal charge required for maxCharge of a cluster.
 
void setMaxTimes (int maxTimes)
 Set Function for minimal charge required for maxCharge of a cluster.
 
void setMaxClusterSize (int maxClusterSizeRowIROC, int maxClusterSizeRowOROC1, int maxClusterSizeRowOROC2, int maxClusterSizeRowOROC3, int maxClusterSizePadIROC, int maxClusterSizePadOROC1, int maxClusterSizePadOROC2, int maxClusterSizePadOROC3, int maxClusterSizeTime)
 Set Function for maximal cluster sizes in different ROCs.
 
void loopOverSector (const gsl::span< const Digit > eventSector, const int sector)
 
void loopOverSector (const std::vector< Digit > &eventSector, const int sector)
 

Detailed Description

KrBoxClusterFinder class can be used to analyze X-ray and Krypton data

It creates a 3D map of all digits in one event. Afterwards the Function findLocalMaxima() can be used to get the coordinates of all local maxima. Around these maxima, the cluster is then built with the function buildCluster. In a box around the center (defined by maxClusterSize....) it looks for digits that can be assigned to the cluster.

Definition at line 105 of file KrBoxClusterFinder.h.

Constructor & Destructor Documentation

◆ KrBoxClusterFinder() [1/2]

o2::tpc::KrBoxClusterFinder::KrBoxClusterFinder ( )
explicitdefault

Constructor: The constructor allocates a three dimensional array (Pad,Row,Time) which is later filled with the recorded charges for each digit

◆ KrBoxClusterFinder() [2/2]

o2::tpc::KrBoxClusterFinder::KrBoxClusterFinder ( int  sector)
inlineexplicit

Definition at line 120 of file KrBoxClusterFinder.h.

Member Function Documentation

◆ buildCluster()

KrCluster KrBoxClusterFinder::buildCluster ( int  clusterCenterPad,
int  clusterCenterRow,
int  clusterCenterTime,
bool  directFilling = false,
const int  timeOffset = 0 
)

After finding the local maxima, we can now build clusters around it. It works according to the explanation at the beginning of the header file.

Definition at line 385 of file KrBoxClusterFinder.cxx.

◆ findLocalMaxima()

std::vector< std::tuple< int, int, int > > KrBoxClusterFinder::findLocalMaxima ( bool  directFilling = true,
const int  timeOffset = 0 
)

After the map is created, we look for local maxima with this function:

Definition at line 233 of file KrBoxClusterFinder.cxx.

◆ getClusters() [1/2]

std::vector< KrCluster > & o2::tpc::KrBoxClusterFinder::getClusters ( )
inline

Definition at line 136 of file KrBoxClusterFinder.h.

◆ getClusters() [2/2]

const std::vector< KrCluster > & o2::tpc::KrBoxClusterFinder::getClusters ( ) const
inline

Definition at line 137 of file KrBoxClusterFinder.h.

◆ getSector()

int o2::tpc::KrBoxClusterFinder::getSector ( ) const
inline

ger sector of this instance

Definition at line 143 of file KrBoxClusterFinder.h.

◆ init()

void KrBoxClusterFinder::init ( )

initialize the parameters from KrBoxClusterFinderParam

Definition at line 130 of file KrBoxClusterFinder.cxx.

◆ loadGainMapFromFile()

void KrBoxClusterFinder::loadGainMapFromFile ( const std::string_view  calDetFileName,
const std::string_view  gainMapName = "GainMap" 
)

If a gain map exists, the map can be loaded with this function The function expects a CalDet file with a gain map (gain entry for each pad).

Definition at line 28 of file KrBoxClusterFinder.cxx.

◆ loopOverSector() [1/2]

void KrBoxClusterFinder::loopOverSector ( const gsl::span< const Digit >  eventSector,
const int  sector 
)

Definition at line 109 of file KrBoxClusterFinder.cxx.

◆ loopOverSector() [2/2]

void o2::tpc::KrBoxClusterFinder::loopOverSector ( const std::vector< Digit > &  eventSector,
const int  sector 
)
inline

Definition at line 177 of file KrBoxClusterFinder.h.

◆ resetClusters()

void o2::tpc::KrBoxClusterFinder::resetClusters ( )
inline

reset cluster vector

Definition at line 134 of file KrBoxClusterFinder.h.

◆ setMaxClusterSize()

void o2::tpc::KrBoxClusterFinder::setMaxClusterSize ( int  maxClusterSizeRowIROC,
int  maxClusterSizeRowOROC1,
int  maxClusterSizeRowOROC2,
int  maxClusterSizeRowOROC3,
int  maxClusterSizePadIROC,
int  maxClusterSizePadOROC1,
int  maxClusterSizePadOROC2,
int  maxClusterSizePadOROC3,
int  maxClusterSizeTime 
)
inline

Set Function for maximal cluster sizes in different ROCs.

Definition at line 158 of file KrBoxClusterFinder.h.

◆ setMaxTimes()

void o2::tpc::KrBoxClusterFinder::setMaxTimes ( int  maxTimes)
inline

Set Function for minimal charge required for maxCharge of a cluster.

Definition at line 155 of file KrBoxClusterFinder.h.

◆ setMinNumberOfNeighbours()

void o2::tpc::KrBoxClusterFinder::setMinNumberOfNeighbours ( int  minNumberOfNeighbours)
inline

Set Function for minimum number of direct neighbours required.

Definition at line 149 of file KrBoxClusterFinder.h.

◆ setMinQTreshold()

void o2::tpc::KrBoxClusterFinder::setMinQTreshold ( int  minQThreshold)
inline

Set Function for minimal charge required for maxCharge of a cluster.

Definition at line 152 of file KrBoxClusterFinder.h.

◆ setSector()

void o2::tpc::KrBoxClusterFinder::setSector ( int  sector)
inline

set sector of this instance

Definition at line 140 of file KrBoxClusterFinder.h.

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