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

Geometry parameters of TOP. More...

#include <TOPGeometry.h>

Inheritance diagram for TOPGeometry:
Collaboration diagram for TOPGeometry:

Public Member Functions

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

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. More...
 
 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()

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.

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

◆ arePDETuningFactorsEmpty()

bool arePDETuningFactorsEmpty ( ) const
inline

Check for empty PDE tuning factors.

Returns
true if empty

Definition at line 206 of file TOPGeometry.h.

◆ getCalPulseShape()

const TOPSignalShape& getCalPulseShape ( ) const
inline

Returns calibration pulse shape.

Returns
calibration pulse shape

Definition at line 230 of file TOPGeometry.h.

◆ getFrontEnd()

const TOPGeoFrontEnd& getFrontEnd ( ) const
inline

Returns front-end.

Returns
front-end geometry parameters

Definition at line 162 of file TOPGeometry.h.

◆ getModules()

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

Returns all modules.

Returns
modules

Definition at line 149 of file TOPGeometry.h.

◆ getName()

const std::string& getName ( void  ) const
inlineinherited

Returns object name.

Returns
object name

Definition at line 51 of file TOPGeoBase.h.

◆ getNominalQE()

const TOPNominalQE& getNominalQE ( ) const
inline

Returns nominal quantum efficiency of PMT.

Returns
nominal quantum efficiency

Definition at line 180 of file TOPGeometry.h.

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

◆ getNominalTTS()

const TOPNominalTTS& getNominalTTS ( ) const
inline

Returns nominal time transition spread of PMT.

Returns
nominal TTS

Definition at line 186 of file TOPGeometry.h.

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

◆ getNumModules()

unsigned getNumModules ( ) const
inline

Returns number of modules.

Returns
number of modules

Definition at line 136 of file TOPGeometry.h.

◆ getQBB()

const TOPGeoQBB& getQBB ( ) const
inline

Returns quartz bar box.

Returns
quartz bar box geometry parameters

Definition at line 174 of file TOPGeometry.h.

◆ getSignalShape()

const TOPSignalShape& getSignalShape ( ) const
inline

Returns single photon signal shape.

Returns
signal shape

Definition at line 224 of file TOPGeometry.h.

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

◆ getWavelengthFilter()

const TOPWavelengthFilter& getWavelengthFilter ( ) const
inline

Returns transmittance of wavelength filter.

Returns
transmittance of wavelength filter

Definition at line 236 of file TOPGeometry.h.

◆ setCalPulseShape()

void setCalPulseShape ( const TOPSignalShape shape)
inline

Sets calibration pulse shape.

Parameters
shapecalibration pulse shape

Definition at line 124 of file TOPGeometry.h.

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

◆ setName()

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

Sets object name.

Parameters
nameobject name

Definition at line 45 of file TOPGeoBase.h.

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

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

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

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

◆ setSignalShape()

void setSignalShape ( const TOPSignalShape signalShape)
inline

Sets single photon signal shape.

Parameters
signalShapesignal shape

Definition at line 118 of file TOPGeometry.h.

◆ setWavelengthFilter()

void setWavelengthFilter ( const TOPWavelengthFilter filter)
inline

Sets wavelength filter transmittance.

Parameters
filterwavelength filter transmittance

Definition at line 130 of file TOPGeometry.h.


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