gdynamicDigitization
Loading...
Searching...
No Matches
GReadoutSpecs Class Reference

Specifies the readout electronics parameters. More...

#include <greadoutSpecs.h>

Collaboration diagram for GReadoutSpecs:
Collaboration graph

Public Member Functions

 GReadoutSpecs (const double tw, const double gst, const HitBitSet hbs, const std::shared_ptr< GLogger > &log)
 Constructs a GReadoutSpecs object.
 
HitBitSet getHitBitSet () const
 Retrieves the hit bitset.
 
int timeCellIndex (double time) const
 Computes the time cell index for a given time.
 

Detailed Description

This class holds parameters such as the electronic readout time-window, grid start time, and the hit bitset. These values are used to determine which information is stored in a hit and to compute the corresponding time cell index.

Definition at line 44 of file greadoutSpecs.h.

Constructor & Destructor Documentation

◆ GReadoutSpecs()

GReadoutSpecs::GReadoutSpecs ( const double tw,
const double gst,
const HitBitSet hbs,
const std::shared_ptr< GLogger > & log )
inline

This constructor is intended to be called by plugins to set readout specifications.

Parameters
twThe electronic readout time-window.
gstThe grid start time.
hbsThe hit bitset defining what information to store.
logPointer to a GLogger instance for logging.

Definition at line 62 of file greadoutSpecs.h.

Member Function Documentation

◆ getHitBitSet()

HitBitSet GReadoutSpecs::getHitBitSet ( ) const
inline
Returns
The HitBitSet defining the stored hit information.

Definition at line 76 of file greadoutSpecs.h.

◆ timeCellIndex()

int GReadoutSpecs::timeCellIndex ( double time) const
inline

For readout detectors, this function calculates the cell index within the electronic time window. The formula used is:

\[
\text{cell index} = \left\lfloor \frac{\text{time} - \text{gridStartTime}}{\text{timeWindow}} \right\rfloor + 1
\]

Parameters
timeThe time value (e.g., global time from the simulation).
Returns
The computed time cell index as an integer.

Definition at line 90 of file greadoutSpecs.h.


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