#include <HGTD_TdcCalibrationTool.h>

Inheritance diagram for HGTD_TdcCalibrationTool:

Collaboration diagram for HGTD_TdcCalibrationTool:

Public Member Functions
	HGTD_TdcCalibrationTool (const std::string &type, const std::string &name, const IInterface *parent)
float	activeWindowUpperBound (const InDetDD::SolidStateDetectorElementBase *element) const
	AlgTool initialize.
uint8_t	Time2TOA (const InDetDD::SolidStateDetectorElementBase *element, float hit_time) const
	Simulate the TDC digitization.
float	TOA2Time (const InDetDD::SolidStateDetectorElementBase *element, uint8_t toa) const
	Retrieve time of flight from 7-bit TOA code applying the TDC calibration parameters.
bool	checkTOAoverflow (uint8_t toa) const
	Check for the overflow flag within TOA code, which indicates an out of range measurement.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
FloatProperty	m_active_window
FloatProperty	m_lhc_rise_edge
FloatProperty	m_ps_large_step
FloatProperty	m_ps_small_step
FloatProperty	m_toa_bin_size
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 48 of file HGTD_TdcCalibrationTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ HGTD_TdcCalibrationTool()

HGTD_TdcCalibrationTool::HGTD_TdcCalibrationTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 15 of file HGTD_TdcCalibrationTool.cxx.

18 : AthAlgTool(type, name, parent)

19{}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

◆ activeWindowUpperBound()

float HGTD_TdcCalibrationTool::activeWindowUpperBound ( const InDetDD::SolidStateDetectorElementBase * element ) const

AlgTool initialize.

Retrieves the TDC measurment window upper bound based on the sensor placement.

Parameters

[in] element Detector element (module) of the activated sensor.

Returns: Upper bound (in ns) of the TDC measurment window.

Definition at line 25 of file HGTD_TdcCalibrationTool.cxx.

                                                                                                              {
 
  //NB this "expected time" will change once we need to follow the beamspot!!
  float hit_time_expected = element->center().norm() / Gaudi::Units::c_light;
 
  //Should never happen, but testing anyway
  if(hit_time_expected > m_lhc_rise_edge + m_active_window/2){
    ATH_MSG_DEBUG("expected hit above calibration range");
    return m_lhc_rise_edge.value() + m_active_window;
  }
  else if(hit_time_expected < m_lhc_rise_edge - 1.5*m_active_window){
    ATH_MSG_DEBUG("expected hit below calibration range");
    return m_lhc_rise_edge.value() - m_active_window;    
  }
 
  float window_walk = (hit_time_expected + m_active_window/2) - m_lhc_rise_edge;
 
  int window_steps;
  float window_upper_bound;
 
  if(window_walk > m_ps_large_step){
    window_steps = (window_walk - m_ps_large_step)/m_ps_small_step;
    window_upper_bound = m_lhc_rise_edge.value() + m_ps_large_step + window_steps*m_ps_small_step;
  }
  else if(window_walk < - m_ps_large_step){
    window_steps = (window_walk + m_ps_large_step)/m_ps_small_step;
    window_upper_bound = m_lhc_rise_edge.value() - m_ps_large_step + window_steps*m_ps_small_step;
  }
  else{
    window_steps = window_walk/m_ps_small_step;
    window_upper_bound = m_lhc_rise_edge.value() + window_steps*m_ps_small_step;
  }
 
  return window_upper_bound;
}

◆ checkTOAoverflow()

bool HGTD_TdcCalibrationTool::checkTOAoverflow ( uint8_t toa ) const

inline

Check for the overflow flag within TOA code, which indicates an out of range measurement.

Parameters

[in] toa 8-bit TOA code as produced by ALTIROC

Returns: True if overflow bit is set, false otherwise.

Definition at line 94 of file HGTD_TdcCalibrationTool.h.

                                             {
    return toa & HGTD::TOA_OVERLFLOW_MASK;
  }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ Time2TOA()

uint8_t HGTD_TdcCalibrationTool::Time2TOA	(	const InDetDD::SolidStateDetectorElementBase *	element,
		float	hit_time ) const

Simulate the TDC digitization.

Parameters

[in]	element	Detector element (module) of the activated sensor.
[in]	hit_time	Time as measured by the LGAD sensor

Returns: 8-bit TOA ALTIROC code which is stored in the ALTIROC RDO.

Definition at line 62 of file HGTD_TdcCalibrationTool.cxx.

                                                                                                                   {
  
  float  window_upper_bound = activeWindowUpperBound(element);
  
  //TOA time will be the distance between hit_time and upper bound of active window 
  float tdc_time =  window_upper_bound - hit_time;
 
  // Check if hit is within the measurement window, if not return overflow flag
  if( tdc_time < 0 || tdc_time > 2.5){
    ATH_MSG_DEBUG("charge at " << hit_time
                                << " outside of TOA TDC range ["
                                << window_upper_bound - 2.5 << ", " 
                                << window_upper_bound << "]" );
   return HGTD::TOA_OVERLFLOW_MASK;
  }
 
  //TOOD: Include TOA TDC bin size smearing here, for now only using nominal value
  uint8_t toa = tdc_time/m_toa_bin_size;
 
  ATH_MSG_DEBUG("hit time: "<< hit_time << 
    " hit time digitized: " << TOA2Time(element, toa) << 
    " TOA: " <<  static_cast<unsigned int>(toa));
  
  return toa; 
 
}

◆ TOA2Time()

float HGTD_TdcCalibrationTool::TOA2Time	(	const InDetDD::SolidStateDetectorElementBase *	element,
		uint8_t	toa ) const

Retrieve time of flight from 7-bit TOA code applying the TDC calibration parameters.

Parameters

[in]	element	Detector element (module) the RDOs were found on.
[in]	toa	7-bit TOA code as stored in the RDO

Returns: Absolute time to be used on the HGTD_Clusters.

Definition at line 89 of file HGTD_TdcCalibrationTool.cxx.

                                                                                                             {
  // Using middle of bin as estimate to recover the digitized time
  return activeWindowUpperBound(element) - (toa + 0.5)*m_toa_bin_size;
}

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_active_window

FloatProperty HGTD_TdcCalibrationTool::m_active_window

private

Initial value:

{this, "PS_ActiveRange", 2.5 * Athena::Units::nanosecond,

"ALTIROC PS active range" }

Definition at line 101 of file HGTD_TdcCalibrationTool.h.

101 {this, "PS_ActiveRange", 2.5 * Athena::Units::nanosecond,

102 "ALTIROC PS active range" };

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_lhc_rise_edge

FloatProperty HGTD_TdcCalibrationTool::m_lhc_rise_edge

private

Initial value:

{this, "LHC_RiseEdge",12.5 * Athena::Units::nanosecond,

"LHC clock rise edge time" }

Definition at line 104 of file HGTD_TdcCalibrationTool.h.

104 {this, "LHC_RiseEdge",12.5 * Athena::Units::nanosecond,

105 "LHC clock rise edge time" };

◆ m_ps_large_step

FloatProperty HGTD_TdcCalibrationTool::m_ps_large_step

private

Initial value:

{this, "PS_LargeStep", 1.562 * Athena::Units::nanosecond,

"ALTIROC PS large step"}

Definition at line 107 of file HGTD_TdcCalibrationTool.h.

107 {this, "PS_LargeStep", 1.562 * Athena::Units::nanosecond,

108 "ALTIROC PS large step"};

◆ m_ps_small_step

FloatProperty HGTD_TdcCalibrationTool::m_ps_small_step

private

Initial value:

{this, "PS_SmallStep", 9.7 * Athena::Units::picosecond,

"ALTIROC PS small step"}

Definition at line 110 of file HGTD_TdcCalibrationTool.h.

110 {this, "PS_SmallStep", 9.7 * Athena::Units::picosecond,

111 "ALTIROC PS small step"};

◆ m_toa_bin_size

FloatProperty HGTD_TdcCalibrationTool::m_toa_bin_size

private

Initial value:

{this, "TOABinSize", 20 * Athena::Units::picosecond,

"Nominal TDC TOA bin size"}

Definition at line 113 of file HGTD_TdcCalibrationTool.h.

113 {this, "TOABinSize", 20 * Athena::Units::picosecond,

114 "Nominal TDC TOA bin size"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HGTD_TdcCalibrationTool()

Member Function Documentation

◆ activeWindowUpperBound()

◆ checkTOAoverflow()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ Time2TOA()

◆ TOA2Time()

◆ updateVHKA()

Member Data Documentation

◆ m_active_window

◆ m_detStore

◆ m_evtStore

◆ m_lhc_rise_edge

◆ m_ps_large_step

◆ m_ps_small_step

◆ m_toa_bin_size

◆ m_varHandleArraysDeclared

◆ m_vhka