#include <HGTD_TimeResolutionTool.h>

Inheritance diagram for HGTD_TimeResolutionTool:

Collaboration diagram for HGTD_TimeResolutionTool:

Public Member Functions
	HGTD_TimeResolutionTool (const std::string &type, const std::string &name, const IInterface *parent)
float	timeResolution (const double depositedCharge, const double radius, const double integratedLumi) const
	Returns the time resolution of an HGTD pixel.
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
double	replacementCorrectedLuminosity (const double integratedLumi, const double radius) const
	Corrects the integrated luminosity for possible module replacements.
double	latestReplacementLuminosity (const double integratedLumi, const std::vector< double > &replacementLumis) const
	Helper function to determine the latest replacement luminosity.
double	sensorFluence (const double sensorAccumulatedLumi, const double radius) const
	Returns the fluence received by the sensor in neq/cm^2.
double	sigmaLandau (const double fluence) const
	Returns the time resolution contribution from Landau fluctuations.
double	sigmaALTIROCJitter (const double depositedCharge, const double fluence) const
	Returns the time resolution contribution from the electronics jitter of ALTIROC.
double	sigmaTDC () const
	Returns the time resolution contribution from TDC digitization smearing.
double	sigmaClock () const
	Returns the time resolution contribution from the LHC clock.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< double >	m_chargedNeutralRatio
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 20 of file HGTD_TimeResolutionTool.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_TimeResolutionTool()

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

Definition at line 18 of file HGTD_TimeResolutionTool.cxx.

21 : AthAlgTool(type, name, parent) {}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

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

◆ latestReplacementLuminosity()

double HGTD_TimeResolutionTool::latestReplacementLuminosity	(	const double	integratedLumi,
		const std::vector< double > &	replacementLumis ) const

private

Helper function to determine the latest replacement luminosity.

Given a list of integrated luminosities at which replacements of HGTD modules occured, this function finds and returns the most recent replacement luminosity.

Parameters

integratedLumi	The total integrated luminosity since the start of Run 4.
replacementLumis	A vector containing luminosities at which replacements occured (sorted low-to-high).

Definition at line 74 of file HGTD_TimeResolutionTool.cxx.

                                                     {
 
  auto it = std::lower_bound(replacementLumis.begin(), replacementLumis.end(),
                             integratedLumi);
 
  return it == replacementLumis.begin() ? 0.0 : *(--it);
}

◆ 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();
  }

◆ replacementCorrectedLuminosity()

double HGTD_TimeResolutionTool::replacementCorrectedLuminosity	(	const double	integratedLumi,
		const double	radius ) const

private

Corrects the integrated luminosity for possible module replacements.

This function takes the total integrated luminosity since the start of Run 4 and corrects it by accounting for any replacements of HGTD modules done at a given radius.

Parameters

integratedLumi	The total integrated luminosity since the start of Run 4. Has to be given in units of fb^-1.
radius	The radial distance of the pixel from the beam pipe.

Returns: The integrated luminosity the sensor was exposed to.

Definition at line 42 of file HGTD_TimeResolutionTool.cxx.

                                                            {
 
  constexpr double innerRingRadius{230.0 * Athena::Units::mm};
  constexpr double middleRingRadius{470.0 * Athena::Units::mm};
 
  const std::vector<double> innerRingReplacementLumis{
      // Unit is fb^-1
      1000.0,
      2000.0,
      3000.0,
  };
 
  const std::vector<double> middleRingReplacementLumis{
      // Unit is fb^-1
      2000.0,
  };
 
  double replacementLumi{0.0};
 
  if (radius < innerRingRadius) {
    replacementLumi =
        latestReplacementLuminosity(integratedLumi, innerRingReplacementLumis);
  } else if (radius < middleRingRadius) {
    replacementLumi =
        latestReplacementLuminosity(integratedLumi, middleRingReplacementLumis);
  }
  // Outer ring does not have replacements - replacement lumi is 0.0
 
  return integratedLumi - replacementLumi;
}

◆ sensorFluence()

double HGTD_TimeResolutionTool::sensorFluence	(	const double	sensorAccumulatedLumi,
		const double	radius ) const

private

Returns the fluence received by the sensor in neq/cm^2.

Parameters

sensorAccumulatedLumi	The integrated luminosity the sensor was exposed to. Has to be given in units of fb^-1.
radius	The radial distance of the pixel from the beam pipe.

Definition at line 84 of file HGTD_TimeResolutionTool.cxx.

                                                                   {
 
  // Maximum luminosity expected by sensors in fb^-1
  constexpr double maxSensorLuminosity{4000.0};
 
  // 4th order polynomial parametrization of the neutron fluence as function of
  // radius in cm.
  ROOT::Math::Polynomial neutral(2.82428e+08, -5.22843e+10, 3.62182e+12,
                                 -1.4085e+14, 4.08821e+15);
 
  // Equivalent as line above, but for charged hadrons.
  ROOT::Math::Polynomial charged(1.03139e+09, -2.06558e+11, 1.53897e+13,
                                 -5.18627e+14, 7.17046e+15);
 
  return (neutral(radius / Athena::Units::cm) +
          m_chargedNeutralRatio * charged(radius / Athena::Units::cm)) *
         sensorAccumulatedLumi / maxSensorLuminosity;
}

◆ sigmaALTIROCJitter()

double HGTD_TimeResolutionTool::sigmaALTIROCJitter	(	const double	depositedCharge,
		const double	fluence ) const

private

Returns the time resolution contribution from the electronics jitter of ALTIROC.

This function computes the standard deviation of the time resolution contribution coming from the jitter due to electronics noise of the ALTIROC ASIC.

Parameters

depositedCharge	The charge deposited in the sensor (in unit of electrons).
fluence	The radiation fluence in neq/cm^2 the sensor was exposed to.

Definition at line 126 of file HGTD_TimeResolutionTool.cxx.

                                                                               {
 
  constexpr double maxJitter{999.9 * Athena::Units::ns};
 
  // Handle the case where insufficient charge is collected at high fluence and
  // jitter goes to infinity.
  if (fluence > 3.313e15 || depositedCharge == 0.0) {
    return maxJitter;
  }
 
  // Convert deposited charge to fC
  const double chargeInfC{depositedCharge / (1.0e-15 * Gaudi::Units::coulomb)};
 
  // Parametrization of the collected charge as a function of fluence in 1e14
  // neq/cm^2 for a reference 0.56 fC deposited charge.
  ROOT::Math::Polynomial referenceCollectedChargeVsFluence(-0.01598, -0.0752,
                                                           20.04);
 
  const double collectedCharge{
      referenceCollectedChargeVsFluence(fluence / 1.0e14) * chargeInfC / 0.56};
 
  return std::min((11.5201 + 36576.2 * std::pow(collectedCharge, -3.87335)) *
                      Athena::Units::picosecond,
                  maxJitter);
}

◆ sigmaClock()

double HGTD_TimeResolutionTool::sigmaClock ( ) const

private

Returns the time resolution contribution from the LHC clock.

Definition at line 158 of file HGTD_TimeResolutionTool.cxx.

                                                 {
 
  return 14.0 * Athena::Units::picosecond;
}

◆ sigmaLandau()

double HGTD_TimeResolutionTool::sigmaLandau ( const double fluence ) const

private

Returns the time resolution contribution from Landau fluctuations.

This function computes the standard deviation of the time resolution contribution coming from Landau fluctuations, which arise from the variablity in charge deposition and collection in the sensor active region.

Parameters

fluence The radiation fluence in neq/cm^2 the sensor was exposed to.

Definition at line 104 of file HGTD_TimeResolutionTool.cxx.

                                                                      {
 
  // Parametrization of sensor bias voltage as a function of fluence in 1e14
  // neq/cm^2. Returns voltage in V.
  ROOT::Math::Polynomial biasVoltageVsFluence(20.59, 96.26);
 
  // LGADs can be biased at max 550 V due to single-event burnout. Unit V
  const double operatingBiasVoltage{
      std::min(biasVoltageVsFluence(fluence / 1.0e14), 550.0)};
 
  constexpr double sensorActiveThickness{50.0 * Athena::Units::um};
  constexpr double gainLayerVoltage{25.0};  // Unit V
 
  const double averageElectricField{
      (operatingBiasVoltage - gainLayerVoltage) /
      (sensorActiveThickness / Athena::Units::um)};  // Unit V/um
 
  // Parametrization of the Landau fluctuation contribution to time resolution
  // as a function of average electric field in V/um:  c1 + c2 / <E>
  return (24.441 + 20.2311 / averageElectricField) * Athena::Units::picosecond;
}

◆ sigmaTDC()

double HGTD_TimeResolutionTool::sigmaTDC ( ) const

private

Returns the time resolution contribution from TDC digitization smearing.

This function computes the standard deviation of the time resolution contribution coming from the time smearing introduced by the TDC digitization, mainly due to the finite TDC bin size, but also including effects such as TDC bin size smearing etc.

Definition at line 153 of file HGTD_TimeResolutionTool.cxx.

                                               {
 
  return 20.0 / std::sqrt(12.0) * Athena::Units::picosecond;
}

◆ 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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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

◆ timeResolution()

float HGTD_TimeResolutionTool::timeResolution	(	const double	depositedCharge,
		const double	radius,
		const double	integratedLumi ) const

Returns the time resolution of an HGTD pixel.

This function computes the expected time resolution of a hit on a single HGTD pixel based on the deposited charge, the radial position within the detector, and integrated luminosity.

Parameters

depositedCharge	The charge deposited in the pixel.
radius	The radial distance of the pixel from the beam pipe.
integratedLumi	The total integrated luminosity since the start of Run 4. Has to be given in units of fb^-1.

Definition at line 23 of file HGTD_TimeResolutionTool.cxx.

                                       {
 
  const double receivedFluence{sensorFluence(
      replacementCorrectedLuminosity(integratedLumi, radius), radius)};
 
  // Multiple processes contribute to the total time resolution. They are added
  // here in quadrature one-by-one.
  double timeResVariance{0.0};
  timeResVariance += std::pow(sigmaLandau(receivedFluence), 2.0);
  timeResVariance +=
      std::pow(sigmaALTIROCJitter(depositedCharge, receivedFluence), 2.0);
  timeResVariance += std::pow(sigmaTDC(), 2.0);
  timeResVariance += std::pow(sigmaClock(), 2.0);
 
  return std::sqrt(timeResVariance);
}

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

Gaudi::Property<double> HGTD_TimeResolutionTool::m_chargedNeutralRatio

private

Initial value:

{
      this, "ChargedNeutralRatio", 3.0,
      "Ratio of radiation damage from charged hadrons vs neutrons"}

Definition at line 42 of file HGTD_TimeResolutionTool.h.

                                             {
      this, "ChargedNeutralRatio", 3.0,
      "Ratio of radiation damage from charged hadrons vs neutrons"};

◆ 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_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_TimeResolutionTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ inputHandles()

◆ latestReplacementLuminosity()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ replacementCorrectedLuminosity()

◆ sensorFluence()

◆ sigmaALTIROCJitter()

◆ sigmaClock()

◆ sigmaLandau()

◆ sigmaTDC()

◆ sysInitialize()

◆ sysStart()

◆ timeResolution()

◆ updateVHKA()

Member Data Documentation

◆ m_chargedNeutralRatio

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka