Belle II Software development
TOPGeometry Class Reference

Geometry parameters of TOP. More...

#include <TOPGeometry.h>

Inheritance diagram for TOPGeometry:
TOPGeoBase

Public Member Functions

 TOPGeometry ()
 Default constructor.
 
 TOPGeometry (const std::string &name)
 Constructor with name.
 
void appendModule (const TOPGeoModule &module)
 Appends module (if its ID differs from already appended modules)
 
void setFrontEnd (const TOPGeoFrontEnd &frontEnd, unsigned num=4)
 Sets front-end.
 
void setQBB (const TOPGeoQBB &QBB)
 Sets quartz bar box.
 
void setNominalQE (const TOPNominalQE &nominalQE)
 Sets nominal quantum efficiency of PMT.
 
void setNominalTTS (const TOPNominalTTS &nominalTTS)
 Sets nominal time transition spread of PMT.
 
void appendTTS (const TOPNominalTTS &tts)
 Appends time transition spread of a particular PMT type.
 
void appendPDETuningFactor (unsigned type, double factor)
 Appends photon detection efficiency tuning factor of a particular PMT type.
 
void setNominalTDC (const TOPNominalTDC &nominalTDC)
 Sets nominal time-to-digit conversion parameters.
 
void setSignalShape (const TOPSignalShape &signalShape)
 Sets single photon signal shape.
 
void setCalPulseShape (const TOPSignalShape &shape)
 Sets calibration pulse shape.
 
void setWavelengthFilter (const TOPWavelengthFilter &filter)
 Sets wavelength filter transmittance.
 
unsigned getNumModules () const
 Returns number of modules.
 
const TOPGeoModulegetModule (int moduleID) const
 Returns module.
 
const std::vector< TOPGeoModule > & getModules () const
 Returns all modules.
 
bool isModuleIDValid (int moduleID) const
 Checks if module exists in m_modules.
 
const TOPGeoFrontEndgetFrontEnd () const
 Returns front-end.
 
unsigned getNumBoardStacks () const
 Returns number of boardstacks per module.
 
const TOPGeoQBBgetQBB () const
 Returns quartz bar box.
 
const TOPNominalQEgetNominalQE () const
 Returns nominal quantum efficiency of PMT.
 
const TOPNominalTTSgetNominalTTS () const
 Returns nominal time transition spread of PMT.
 
const TOPNominalTTSgetTTS (unsigned type) const
 Returns time transition spread of a given PMT type.
 
double getPDETuningFactor (unsigned type) const
 Returns photon detection efficiency tuning factor of a given PMT type.
 
bool arePDETuningFactorsEmpty () const
 Check for empty PDE tuning factors.
 
const std::map< unsigned, TOPNominalTTS > & getTTSes () const
 Returns PMT dependent time transition spreads.
 
const TOPNominalTDCgetNominalTDC () const
 Returns nominal time-to-digit conversion parameters.
 
const TOPSignalShapegetSignalShape () const
 Returns single photon signal shape.
 
const TOPSignalShapegetCalPulseShape () const
 Returns calibration pulse shape.
 
const TOPWavelengthFiltergetWavelengthFilter () const
 Returns transmittance of wavelength filter.
 
double getInnerRadius () const
 Returns inner radius of the volume devoted to TOP counter.
 
double getOuterRadius () const
 Returns outer radius of the volume devoted to TOP counter.
 
double getRadius () const
 Returns average radius of modules.
 
double getBackwardZ () const
 Returns backward z of the volume devoted to TOP counter.
 
double getForwardZ () const
 Returns forward z of the volume devoted to TOP counter.
 
bool isConsistent () const override
 Check for consistency of data members.
 
void print (const std::string &title="TOP geometry parameters") const override
 Print the content of the class.
 
void setName (const std::string &name)
 Sets object name.
 
const std::string & getName () const
 Returns object name.
 
virtual void printSurface (const GeoOpticalSurface &surface) const
 Print the content of optical surface.
 
double getReflectivity (const GeoOpticalSurface &surface, double energy) const
 Returns reflectivity of optical surface at given photon energy.
 

Static Public Member Functions

static void useBasf2Units ()
 Use basf2 units when returning geometry parameters.
 
static void useGeantUnits ()
 Use Geant units when returning geometry parameters.
 

Protected Member Functions

void printUnderlined (const std::string &title) const
 Print the content of the class.
 
 ClassDef (TOPGeoBase, 1)
 ClassDef.
 

Protected Attributes

std::string m_name
 geometry object name
 

Static Protected Attributes

static double s_unit = Unit::cm
 conversion unit for length
 
static std::string s_unitName
 conversion unit name
 

Private Member Functions

 ClassDefOverride (TOPGeometry, 8)
 ClassDef.
 

Private Attributes

std::vector< TOPGeoModulem_modules
 geometry parameters of modules
 
TOPGeoFrontEnd m_frontEnd
 geometry parameters of front-end electronics
 
TOPGeoQBB m_QBB
 geometry parameters of quartz bar box
 
unsigned m_numBoardStacks = 0
 number of boardstacks per module
 
TOPNominalQE m_nominalQE
 nominal quantum efficiency of PMT
 
TOPNominalTTS m_nominalTTS
 nominal time transition spread of PMT
 
TOPNominalTDC m_nominalTDC
 nominal time-to-digit conversion parameters
 
TOPSignalShape m_signalShape
 shape of single photon signal
 
TOPSignalShape m_calPulseShape
 shape of the calibration pulse
 
TOPWavelengthFilter m_wavelengthFilter
 transmittance of wavelength filter
 
std::map< unsigned, TOPNominalTTSm_tts
 TTS of PMT types.
 
std::map< unsigned, float > m_tuneFactorsPDE
 PDE tuning factors of PMT types.
 

Detailed Description

Geometry parameters of TOP.

Definition at line 34 of file TOPGeometry.h.

Constructor & Destructor Documentation

◆ TOPGeometry() [1/2]

TOPGeometry ( )
inline

Default constructor.

Definition at line 40 of file TOPGeometry.h.

41 {}

◆ TOPGeometry() [2/2]

TOPGeometry ( const std::string &  name)
inlineexplicit

Constructor with name.

Parameters
nameobject name

Definition at line 47 of file TOPGeometry.h.

47 : TOPGeoBase(name)
48 {}
TOPGeoBase()
Default constructor.
Definition: TOPGeoBase.h:31

Member Function Documentation

◆ appendPDETuningFactor()

void appendPDETuningFactor ( unsigned  type,
double  factor 
)
inline

Appends photon detection efficiency tuning factor of a particular PMT type.

Parameters
typePMT type
factortuning factor

Definition at line 106 of file TOPGeometry.h.

106{m_tuneFactorsPDE[type] = factor;}
std::map< unsigned, float > m_tuneFactorsPDE
PDE tuning factors of PMT types.
Definition: TOPGeometry.h:294

◆ appendTTS()

void appendTTS ( const TOPNominalTTS tts)
inline

Appends time transition spread of a particular PMT type.

Parameters
ttsTTS of a particular PMT type

Definition at line 99 of file TOPGeometry.h.

99{m_tts[tts.getPMTType()] = tts;}
std::map< unsigned, TOPNominalTTS > m_tts
TTS of PMT types.
Definition: TOPGeometry.h:293

◆ arePDETuningFactorsEmpty()

bool arePDETuningFactorsEmpty ( ) const
inline

Check for empty PDE tuning factors.

Returns
true if empty

Definition at line 206 of file TOPGeometry.h.

206{return m_tuneFactorsPDE.empty();}

◆ getCalPulseShape()

const TOPSignalShape & getCalPulseShape ( ) const
inline

Returns calibration pulse shape.

Returns
calibration pulse shape

Definition at line 230 of file TOPGeometry.h.

230{return m_calPulseShape;}
TOPSignalShape m_calPulseShape
shape of the calibration pulse
Definition: TOPGeometry.h:291

◆ getFrontEnd()

const TOPGeoFrontEnd & getFrontEnd ( ) const
inline

Returns front-end.

Returns
front-end geometry parameters

Definition at line 162 of file TOPGeometry.h.

162{return m_frontEnd;}
TOPGeoFrontEnd m_frontEnd
geometry parameters of front-end electronics
Definition: TOPGeometry.h:284

◆ getModules()

const std::vector< TOPGeoModule > & getModules ( ) const
inline

Returns all modules.

Returns
modules

Definition at line 149 of file TOPGeometry.h.

149{return m_modules;}
std::vector< TOPGeoModule > m_modules
geometry parameters of modules
Definition: TOPGeometry.h:283

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns object name.

Returns
object name

Definition at line 51 of file TOPGeoBase.h.

51{return m_name;}
std::string m_name
geometry object name
Definition: TOPGeoBase.h:89

◆ getNominalQE()

const TOPNominalQE & getNominalQE ( ) const
inline

Returns nominal quantum efficiency of PMT.

Returns
nominal quantum efficiency

Definition at line 180 of file TOPGeometry.h.

180{return m_nominalQE;}
TOPNominalQE m_nominalQE
nominal quantum efficiency of PMT
Definition: TOPGeometry.h:287

◆ getNominalTDC()

const TOPNominalTDC & getNominalTDC ( ) const
inline

Returns nominal time-to-digit conversion parameters.

Returns
nominal TDC parameters

Definition at line 218 of file TOPGeometry.h.

218{return m_nominalTDC;}
TOPNominalTDC m_nominalTDC
nominal time-to-digit conversion parameters
Definition: TOPGeometry.h:289

◆ getNominalTTS()

const TOPNominalTTS & getNominalTTS ( ) const
inline

Returns nominal time transition spread of PMT.

Returns
nominal TTS

Definition at line 186 of file TOPGeometry.h.

186{return m_nominalTTS;}
TOPNominalTTS m_nominalTTS
nominal time transition spread of PMT
Definition: TOPGeometry.h:288

◆ getNumBoardStacks()

unsigned getNumBoardStacks ( ) const
inline

Returns number of boardstacks per module.

Returns
number of boardstacks per module

Definition at line 168 of file TOPGeometry.h.

168{return m_numBoardStacks;}
unsigned m_numBoardStacks
number of boardstacks per module
Definition: TOPGeometry.h:286

◆ getNumModules()

unsigned getNumModules ( ) const
inline

Returns number of modules.

Returns
number of modules

Definition at line 136 of file TOPGeometry.h.

136{return m_modules.size();}

◆ getQBB()

const TOPGeoQBB & getQBB ( ) const
inline

Returns quartz bar box.

Returns
quartz bar box geometry parameters

Definition at line 174 of file TOPGeometry.h.

174{return m_QBB;}
TOPGeoQBB m_QBB
geometry parameters of quartz bar box
Definition: TOPGeometry.h:285

◆ getSignalShape()

const TOPSignalShape & getSignalShape ( ) const
inline

Returns single photon signal shape.

Returns
signal shape

Definition at line 224 of file TOPGeometry.h.

224{return m_signalShape;}
TOPSignalShape m_signalShape
shape of single photon signal
Definition: TOPGeometry.h:290

◆ getTTSes()

const std::map< unsigned, TOPNominalTTS > & getTTSes ( ) const
inline

Returns PMT dependent time transition spreads.

Returns
a map of PMT dependent time transition spreads

Definition at line 212 of file TOPGeometry.h.

212{return m_tts;}

◆ getWavelengthFilter()

const TOPWavelengthFilter & getWavelengthFilter ( ) const
inline

Returns transmittance of wavelength filter.

Returns
transmittance of wavelength filter

Definition at line 236 of file TOPGeometry.h.

236{return m_wavelengthFilter;}
TOPWavelengthFilter m_wavelengthFilter
transmittance of wavelength filter
Definition: TOPGeometry.h:292

◆ setCalPulseShape()

void setCalPulseShape ( const TOPSignalShape shape)
inline

Sets calibration pulse shape.

Parameters
shapecalibration pulse shape

Definition at line 124 of file TOPGeometry.h.

124{m_calPulseShape = shape;}

◆ setFrontEnd()

void setFrontEnd ( const TOPGeoFrontEnd frontEnd,
unsigned  num = 4 
)
inline

Sets front-end.

Parameters
frontEndfront-end geometry parameters
numnumber of board stacks per module

Definition at line 71 of file TOPGeometry.h.

72 {
73 m_frontEnd = frontEnd;
74 m_numBoardStacks = num;
75 }

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Sets object name.

Parameters
nameobject name

Definition at line 45 of file TOPGeoBase.h.

45{m_name = name;}

◆ setNominalQE()

void setNominalQE ( const TOPNominalQE nominalQE)
inline

Sets nominal quantum efficiency of PMT.

Parameters
nominalQEnominal quantum efficiency

Definition at line 87 of file TOPGeometry.h.

87{m_nominalQE = nominalQE;}

◆ setNominalTDC()

void setNominalTDC ( const TOPNominalTDC nominalTDC)
inline

Sets nominal time-to-digit conversion parameters.

Parameters
nominalTDCnominal TDC parameters

Definition at line 112 of file TOPGeometry.h.

112{m_nominalTDC = nominalTDC;}

◆ setNominalTTS()

void setNominalTTS ( const TOPNominalTTS nominalTTS)
inline

Sets nominal time transition spread of PMT.

Parameters
nominalTTSnominal TTS

Definition at line 93 of file TOPGeometry.h.

93{m_nominalTTS = nominalTTS;}

◆ setQBB()

void setQBB ( const TOPGeoQBB QBB)
inline

Sets quartz bar box.

Parameters
QBBquartz bar box geometry parameters

Definition at line 81 of file TOPGeometry.h.

81{m_QBB = QBB;}

◆ setSignalShape()

void setSignalShape ( const TOPSignalShape signalShape)
inline

Sets single photon signal shape.

Parameters
signalShapesignal shape

Definition at line 118 of file TOPGeometry.h.

118{m_signalShape = signalShape;}

◆ setWavelengthFilter()

void setWavelengthFilter ( const TOPWavelengthFilter filter)
inline

Sets wavelength filter transmittance.

Parameters
filterwavelength filter transmittance

Definition at line 130 of file TOPGeometry.h.

std::map< ExpRun, std::pair< double, double > > filter(const std::map< ExpRun, std::pair< double, double > > &runs, double cut, std::map< ExpRun, std::pair< double, double > > &runsRemoved)
filter events to remove runs shorter than cut, it stores removed runs in runsRemoved
Definition: Splitter.cc:38

◆ useBasf2Units()

static void useBasf2Units ( )
inlinestatic

Use basf2 units when returning geometry parameters.

Definition at line 53 of file TOPGeometry.h.

53{s_unit = Unit::cm; s_unitName = "cm";}
static const double cm
Standard units with the value = 1.
Definition: Unit.h:47
static double s_unit
conversion unit for length
Definition: TOPGeoBase.h:86
static std::string s_unitName
conversion unit name
Definition: TOPGeoBase.h:87

◆ useGeantUnits()

static void useGeantUnits ( )
inlinestatic

Use Geant units when returning geometry parameters.

Definition at line 58 of file TOPGeometry.h.

58{s_unit = Unit::mm; s_unitName = "mm";}
static const double mm
[millimeters]
Definition: Unit.h:70

Member Data Documentation

◆ m_calPulseShape

TOPSignalShape m_calPulseShape
private

shape of the calibration pulse

Definition at line 291 of file TOPGeometry.h.

◆ m_frontEnd

TOPGeoFrontEnd m_frontEnd
private

geometry parameters of front-end electronics

Definition at line 284 of file TOPGeometry.h.

◆ m_modules

std::vector<TOPGeoModule> m_modules
private

geometry parameters of modules

Definition at line 283 of file TOPGeometry.h.

◆ m_name

std::string m_name
protectedinherited

geometry object name

Definition at line 89 of file TOPGeoBase.h.

◆ m_nominalQE

TOPNominalQE m_nominalQE
private

nominal quantum efficiency of PMT

Definition at line 287 of file TOPGeometry.h.

◆ m_nominalTDC

TOPNominalTDC m_nominalTDC
private

nominal time-to-digit conversion parameters

Definition at line 289 of file TOPGeometry.h.

◆ m_nominalTTS

TOPNominalTTS m_nominalTTS
private

nominal time transition spread of PMT

Definition at line 288 of file TOPGeometry.h.

◆ m_numBoardStacks

unsigned m_numBoardStacks = 0
private

number of boardstacks per module

Definition at line 286 of file TOPGeometry.h.

◆ m_QBB

TOPGeoQBB m_QBB
private

geometry parameters of quartz bar box

Definition at line 285 of file TOPGeometry.h.

◆ m_signalShape

TOPSignalShape m_signalShape
private

shape of single photon signal

Definition at line 290 of file TOPGeometry.h.

◆ m_tts

std::map<unsigned, TOPNominalTTS> m_tts
private

TTS of PMT types.

Definition at line 293 of file TOPGeometry.h.

◆ m_tuneFactorsPDE

std::map<unsigned, float> m_tuneFactorsPDE
private

PDE tuning factors of PMT types.

Definition at line 294 of file TOPGeometry.h.

◆ m_wavelengthFilter

TOPWavelengthFilter m_wavelengthFilter
private

transmittance of wavelength filter

Definition at line 292 of file TOPGeometry.h.


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