Belle II Software prerelease-11-00-00a
CATFinderParameters Class Reference

DBObject containing parameters used in the CATFinder module. More...

#include <CATFinderParameters.h>

Inheritance diagram for CATFinderParameters:
Collaboration diagram for CATFinderParameters:

Public Member Functions

 CATFinderParameters ()=default
 Default constructor.
 
 ~CATFinderParameters ()=default
 Destructor.
 
void setTDCOffset (float tdcOffset)
 Set the offset applied to TDC counts.
 
void setTDCScale (float tdcScale)
 Set the scale factor for TDC normalization.
 
void setADCClip (float adcClip)
 Set the maximum ADC value used for normalization; values above are clipped.
 
void setSLayerScale (float slayerScale)
 Set the scale factor for normalizing superlayer indices.
 
void setCLayerScale (float clayerScale)
 Set the scale factor for normalizing cell layer indices.
 
void setLayerScale (float layerScale)
 Set the scale factor for normalizing layer indices.
 
void setSpatialCoordinatesScale (float spatialCoordinatesScale)
 Set the scale factor for spatial coordinates.
 
void setNInputFeatures (unsigned int nInputFeatures)
 Set the number of input features per node for the GNN model.
 
void setLatentSpaceNDim (unsigned int latentSpaceNDim)
 Set the dimensionality of the latent space used by the GNN.
 
void setTBeta (float tBeta)
 Set the threshold for the beta value to select candidate condensation points.
 
void setTDistance (float tDistance)
 Set the minimum distance required between condensation points in latent space.
 
void setMaxRadius (float maxRadius)
 Set the maximum radius in latent space to associate hits with a condensation point.
 
void setMinNumberHits (unsigned int minNumberHits)
 Set the minimum number of associated CDC hits required to form a valid track.
 
void setInputTFeaturesName (const std::string &inputTFeaturesName)
 Set the name of the input tensor for hit features.
 
void setOutputTBetaName (const std::string &outputTBetaName)
 Set the name of the output tensor for beta values.
 
void setOutputTCoordinatesName (const std::string &outputTCoordinatesName)
 Set the name of the output tensor for condensation coordinates.
 
void setOutputTMomentumName (const std::string &outputTMomentumName)
 Set the name of the output tensor for predicted momenta.
 
void setOutputTVertexName (const std::string &outputTVertexName)
 Set the name of the output tensor for predicted vertices.
 
void setOutputTChargeName (const std::string &outputTChargeName)
 Set the name of the output tensor for predicted charges.
 
float getTDCOffset () const
 Get the offset applied to TDC counts.
 
float getTDCScale () const
 Get the scale factor for TDC normalization.
 
float getADCClip () const
 Get the maximum ADC value used for normalization; values above are clipped.
 
float getSLayerScale () const
 Get the scale factor for normalizing superlayer indices.
 
float getCLayerScale () const
 Get the scale factor for normalizing cell layer indices.
 
float getLayerScale () const
 Get the scale factor for normalizing layer indices.
 
float getSpatialCoordinatesScale () const
 Get the scale factor for spatial coordinates.
 
unsigned int getNInputFeatures () const
 Get the number of input features per node for the GNN model.
 
unsigned int getLatentSpaceNDim () const
 Get the dimensionality of the latent space used by the GNN.
 
float getTBeta () const
 Get the threshold for the beta value to select candidate condensation points.
 
float getTDistance () const
 Get the minimum distance required between condensation points in latent space.
 
float getMaxRadius () const
 Get the maximum radius in latent space to associate hits with a condensation point.
 
unsigned int getMinNumberHits () const
 Get the minimum number of associated CDC hits required to form a valid track.
 
const std::string & getInputTFeaturesName () const
 Get the name of the input tensor for hit features.
 
const std::string & getOutputTBetaName () const
 Get the name of the output tensor for beta values.
 
const std::string & getOutputTCoordinatesName () const
 Get the name of the output tensor for condensation coordinates.
 
const std::string & getOutputTMomentumName () const
 Get the name of the output tensor for predicted momenta.
 
const std::string & getOutputTVertexName () const
 Get the name of the output tensor for predicted vertices.
 
const std::string & getOutputTChargeName () const
 Get the name of the output tensor for predicted charges.
 

Private Member Functions

 ClassDef (CATFinderParameters, 1)
 Class version.
 

Private Attributes

float m_tdcOffset = 0.
 Offset applied to TDC counts.
 
float m_tdcScale = 0.
 Scale factor for TDC normalization.
 
float m_adcClip = 0.
 Maximum ADC value used for normalization; values above are clipped.
 
float m_slayerScale = 0.
 Scale factor for normalizing superlayer indices.
 
float m_clayerScale = 0.
 Scale factor for normalizing cell layer indices.
 
float m_layerScale = 0.
 Scale factor for normalizing layer indices.
 
float m_spatialCoordinatesScale = 0.
 Scale factor for spatial coordinates (from basf2 units to internal GNN units).
 
unsigned int m_nInputFeatures = 0
 Number of input features per node for the GNN model.
 
unsigned int m_latentSpaceNDim = 0
 Dimensionality of the latent space used by the GNN.
 
float m_tBeta = 0.
 Threshold for the beta value to select candidate condensation points.
 
float m_tDistance = 0.
 Minimum distance required between condensation points in latent space.
 
float m_maxRadius = 0.
 Maximum radius in latent space to associate hits with a condensation point.
 
unsigned int m_minNumberHits = 0
 Minimum number of associated CDC hits required to form a valid track.
 
std::string m_inputTFeaturesName
 Name of the input tensor carrying the per-hit features.
 
std::string m_outputTBetaName
 Name of the output tensor carrying the per-hit beta (condensation score) values.
 
std::string m_outputTCoordinatesName
 Name of the output tensor carrying the per-hit condensation coordinates.
 
std::string m_outputTMomentumName
 Name of the output tensor carrying the predicted momenta.
 
std::string m_outputTVertexName
 Name of the output tensor carrying the predicted vertices.
 
std::string m_outputTChargeName
 Name of the output tensor carrying the predicted charges.
 

Detailed Description

DBObject containing parameters used in the CATFinder module.

Definition at line 26 of file CATFinderParameters.h.

Member Function Documentation

◆ getADCClip()

float getADCClip ( ) const
inline

Get the maximum ADC value used for normalization; values above are clipped.

Definition at line 123 of file CATFinderParameters.h.

123{ return m_adcClip; }

◆ getCLayerScale()

float getCLayerScale ( ) const
inline

Get the scale factor for normalizing cell layer indices.

Definition at line 129 of file CATFinderParameters.h.

129{ return m_clayerScale; }

◆ getInputTFeaturesName()

const std::string & getInputTFeaturesName ( ) const
inline

Get the name of the input tensor for hit features.

Definition at line 156 of file CATFinderParameters.h.

156{ return m_inputTFeaturesName; }

◆ getLatentSpaceNDim()

unsigned int getLatentSpaceNDim ( ) const
inline

Get the dimensionality of the latent space used by the GNN.

Definition at line 141 of file CATFinderParameters.h.

141{ return m_latentSpaceNDim; }

◆ getLayerScale()

float getLayerScale ( ) const
inline

Get the scale factor for normalizing layer indices.

Definition at line 132 of file CATFinderParameters.h.

132{ return m_layerScale; }

◆ getMaxRadius()

float getMaxRadius ( ) const
inline

Get the maximum radius in latent space to associate hits with a condensation point.

Definition at line 150 of file CATFinderParameters.h.

150{ return m_maxRadius; }

◆ getMinNumberHits()

unsigned int getMinNumberHits ( ) const
inline

Get the minimum number of associated CDC hits required to form a valid track.

Definition at line 153 of file CATFinderParameters.h.

153{ return m_minNumberHits; }

◆ getNInputFeatures()

unsigned int getNInputFeatures ( ) const
inline

Get the number of input features per node for the GNN model.

Definition at line 138 of file CATFinderParameters.h.

138{ return m_nInputFeatures; }

◆ getOutputTBetaName()

const std::string & getOutputTBetaName ( ) const
inline

Get the name of the output tensor for beta values.

Definition at line 159 of file CATFinderParameters.h.

159{ return m_outputTBetaName; }

◆ getOutputTChargeName()

const std::string & getOutputTChargeName ( ) const
inline

Get the name of the output tensor for predicted charges.

Definition at line 171 of file CATFinderParameters.h.

171{ return m_outputTChargeName; }

◆ getOutputTCoordinatesName()

const std::string & getOutputTCoordinatesName ( ) const
inline

Get the name of the output tensor for condensation coordinates.

Definition at line 162 of file CATFinderParameters.h.

162{ return m_outputTCoordinatesName; }

◆ getOutputTMomentumName()

const std::string & getOutputTMomentumName ( ) const
inline

Get the name of the output tensor for predicted momenta.

Definition at line 165 of file CATFinderParameters.h.

165{ return m_outputTMomentumName; }

◆ getOutputTVertexName()

const std::string & getOutputTVertexName ( ) const
inline

Get the name of the output tensor for predicted vertices.

Definition at line 168 of file CATFinderParameters.h.

168{ return m_outputTVertexName; }

◆ getSLayerScale()

float getSLayerScale ( ) const
inline

Get the scale factor for normalizing superlayer indices.

Definition at line 126 of file CATFinderParameters.h.

126{ return m_slayerScale; }

◆ getSpatialCoordinatesScale()

float getSpatialCoordinatesScale ( ) const
inline

Get the scale factor for spatial coordinates.

Definition at line 135 of file CATFinderParameters.h.

135{ return m_spatialCoordinatesScale; }

◆ getTBeta()

float getTBeta ( ) const
inline

Get the threshold for the beta value to select candidate condensation points.

Definition at line 144 of file CATFinderParameters.h.

144{ return m_tBeta; }

◆ getTDCOffset()

float getTDCOffset ( ) const
inline

Get the offset applied to TDC counts.

Definition at line 117 of file CATFinderParameters.h.

117{ return m_tdcOffset; }

◆ getTDCScale()

float getTDCScale ( ) const
inline

Get the scale factor for TDC normalization.

Definition at line 120 of file CATFinderParameters.h.

120{ return m_tdcScale; }

◆ getTDistance()

float getTDistance ( ) const
inline

Get the minimum distance required between condensation points in latent space.

Definition at line 147 of file CATFinderParameters.h.

147{ return m_tDistance; }

◆ setADCClip()

void setADCClip ( float adcClip)
inline

Set the maximum ADC value used for normalization; values above are clipped.

Parameters
[in]adcClipADC clip value.

Definition at line 50 of file CATFinderParameters.h.

50{ m_adcClip = adcClip; }

◆ setCLayerScale()

void setCLayerScale ( float clayerScale)
inline

Set the scale factor for normalizing cell layer indices.

Parameters
[in]clayerScaleCell layer scale.

Definition at line 58 of file CATFinderParameters.h.

58{ m_clayerScale = clayerScale; }

◆ setInputTFeaturesName()

void setInputTFeaturesName ( const std::string & inputTFeaturesName)
inline

Set the name of the input tensor for hit features.

Parameters
[in]inputTFeaturesNameInput tensor name.

Definition at line 94 of file CATFinderParameters.h.

94{ m_inputTFeaturesName = inputTFeaturesName; }

◆ setLatentSpaceNDim()

void setLatentSpaceNDim ( unsigned int latentSpaceNDim)
inline

Set the dimensionality of the latent space used by the GNN.

Parameters
[in]latentSpaceNDimLatent space dimensionality.

Definition at line 74 of file CATFinderParameters.h.

74{ m_latentSpaceNDim = latentSpaceNDim; }

◆ setLayerScale()

void setLayerScale ( float layerScale)
inline

Set the scale factor for normalizing layer indices.

Parameters
[in]layerScaleLayer scale.

Definition at line 62 of file CATFinderParameters.h.

62{ m_layerScale = layerScale; }

◆ setMaxRadius()

void setMaxRadius ( float maxRadius)
inline

Set the maximum radius in latent space to associate hits with a condensation point.

Parameters
[in]maxRadiusMaximum latent-space radius.

Definition at line 86 of file CATFinderParameters.h.

86{ m_maxRadius = maxRadius; }

◆ setMinNumberHits()

void setMinNumberHits ( unsigned int minNumberHits)
inline

Set the minimum number of associated CDC hits required to form a valid track.

Parameters
[in]minNumberHitsMinimum hit count.

Definition at line 90 of file CATFinderParameters.h.

90{ m_minNumberHits = minNumberHits; }

◆ setNInputFeatures()

void setNInputFeatures ( unsigned int nInputFeatures)
inline

Set the number of input features per node for the GNN model.

Parameters
[in]nInputFeaturesNumber of input features.

Definition at line 70 of file CATFinderParameters.h.

70{ m_nInputFeatures = nInputFeatures; }

◆ setOutputTBetaName()

void setOutputTBetaName ( const std::string & outputTBetaName)
inline

Set the name of the output tensor for beta values.

Parameters
[in]outputTBetaNameOutput beta tensor name.

Definition at line 98 of file CATFinderParameters.h.

98{ m_outputTBetaName = outputTBetaName; }

◆ setOutputTChargeName()

void setOutputTChargeName ( const std::string & outputTChargeName)
inline

Set the name of the output tensor for predicted charges.

Parameters
[in]outputTChargeNameOutput charge tensor name.

Definition at line 114 of file CATFinderParameters.h.

114{ m_outputTChargeName = outputTChargeName; }

◆ setOutputTCoordinatesName()

void setOutputTCoordinatesName ( const std::string & outputTCoordinatesName)
inline

Set the name of the output tensor for condensation coordinates.

Parameters
[in]outputTCoordinatesNameOutput coordinates tensor name.

Definition at line 102 of file CATFinderParameters.h.

102{ m_outputTCoordinatesName = outputTCoordinatesName; }

◆ setOutputTMomentumName()

void setOutputTMomentumName ( const std::string & outputTMomentumName)
inline

Set the name of the output tensor for predicted momenta.

Parameters
[in]outputTMomentumNameOutput momentum tensor name.

Definition at line 106 of file CATFinderParameters.h.

106{ m_outputTMomentumName = outputTMomentumName; }

◆ setOutputTVertexName()

void setOutputTVertexName ( const std::string & outputTVertexName)
inline

Set the name of the output tensor for predicted vertices.

Parameters
[in]outputTVertexNameOutput vertex tensor name.

Definition at line 110 of file CATFinderParameters.h.

110{ m_outputTVertexName = outputTVertexName; }

◆ setSLayerScale()

void setSLayerScale ( float slayerScale)
inline

Set the scale factor for normalizing superlayer indices.

Parameters
[in]slayerScaleSuperlayer scale.

Definition at line 54 of file CATFinderParameters.h.

54{ m_slayerScale = slayerScale; }

◆ setSpatialCoordinatesScale()

void setSpatialCoordinatesScale ( float spatialCoordinatesScale)
inline

Set the scale factor for spatial coordinates.

Parameters
[in]spatialCoordinatesScaleSpatial coordinates scale.

Definition at line 66 of file CATFinderParameters.h.

66{ m_spatialCoordinatesScale = spatialCoordinatesScale; }

◆ setTBeta()

void setTBeta ( float tBeta)
inline

Set the threshold for the beta value to select candidate condensation points.

Parameters
[in]tBetaBeta threshold.

Definition at line 78 of file CATFinderParameters.h.

78{ m_tBeta = tBeta; }

◆ setTDCOffset()

void setTDCOffset ( float tdcOffset)
inline

Set the offset applied to TDC counts.

Parameters
[in]tdcOffsetTDC offset.

Definition at line 42 of file CATFinderParameters.h.

42{ m_tdcOffset = tdcOffset; }

◆ setTDCScale()

void setTDCScale ( float tdcScale)
inline

Set the scale factor for TDC normalization.

Parameters
[in]tdcScaleTDC scale.

Definition at line 46 of file CATFinderParameters.h.

46{ m_tdcScale = tdcScale; }

◆ setTDistance()

void setTDistance ( float tDistance)
inline

Set the minimum distance required between condensation points in latent space.

Parameters
[in]tDistanceMinimum condensation-point distance.

Definition at line 82 of file CATFinderParameters.h.

82{ m_tDistance = tDistance; }

Member Data Documentation

◆ m_adcClip

float m_adcClip = 0.
private

Maximum ADC value used for normalization; values above are clipped.

Definition at line 184 of file CATFinderParameters.h.

◆ m_clayerScale

float m_clayerScale = 0.
private

Scale factor for normalizing cell layer indices.

Definition at line 190 of file CATFinderParameters.h.

◆ m_inputTFeaturesName

std::string m_inputTFeaturesName
private

Name of the input tensor carrying the per-hit features.

Definition at line 225 of file CATFinderParameters.h.

◆ m_latentSpaceNDim

unsigned int m_latentSpaceNDim = 0
private

Dimensionality of the latent space used by the GNN.

Definition at line 204 of file CATFinderParameters.h.

◆ m_layerScale

float m_layerScale = 0.
private

Scale factor for normalizing layer indices.

Definition at line 193 of file CATFinderParameters.h.

◆ m_maxRadius

float m_maxRadius = 0.
private

Maximum radius in latent space to associate hits with a condensation point.

Definition at line 215 of file CATFinderParameters.h.

◆ m_minNumberHits

unsigned int m_minNumberHits = 0
private

Minimum number of associated CDC hits required to form a valid track.

Definition at line 220 of file CATFinderParameters.h.

◆ m_nInputFeatures

unsigned int m_nInputFeatures = 0
private

Number of input features per node for the GNN model.

Definition at line 201 of file CATFinderParameters.h.

◆ m_outputTBetaName

std::string m_outputTBetaName
private

Name of the output tensor carrying the per-hit beta (condensation score) values.

Definition at line 228 of file CATFinderParameters.h.

◆ m_outputTChargeName

std::string m_outputTChargeName
private

Name of the output tensor carrying the predicted charges.

Definition at line 240 of file CATFinderParameters.h.

◆ m_outputTCoordinatesName

std::string m_outputTCoordinatesName
private

Name of the output tensor carrying the per-hit condensation coordinates.

Definition at line 231 of file CATFinderParameters.h.

◆ m_outputTMomentumName

std::string m_outputTMomentumName
private

Name of the output tensor carrying the predicted momenta.

Definition at line 234 of file CATFinderParameters.h.

◆ m_outputTVertexName

std::string m_outputTVertexName
private

Name of the output tensor carrying the predicted vertices.

Definition at line 237 of file CATFinderParameters.h.

◆ m_slayerScale

float m_slayerScale = 0.
private

Scale factor for normalizing superlayer indices.

Definition at line 187 of file CATFinderParameters.h.

◆ m_spatialCoordinatesScale

float m_spatialCoordinatesScale = 0.
private

Scale factor for spatial coordinates (from basf2 units to internal GNN units).

Definition at line 196 of file CATFinderParameters.h.

◆ m_tBeta

float m_tBeta = 0.
private

Threshold for the beta value to select candidate condensation points.

Definition at line 209 of file CATFinderParameters.h.

◆ m_tdcOffset

float m_tdcOffset = 0.
private

Offset applied to TDC counts.

Definition at line 178 of file CATFinderParameters.h.

◆ m_tdcScale

float m_tdcScale = 0.
private

Scale factor for TDC normalization.

Definition at line 181 of file CATFinderParameters.h.

◆ m_tDistance

float m_tDistance = 0.
private

Minimum distance required between condensation points in latent space.

Definition at line 212 of file CATFinderParameters.h.


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