#include <SensorSimTool.h>

Inheritance diagram for SensorSimTool:

Collaboration diagram for SensorSimTool:

Public Types
enum	RadiationDamageSimulationType { NO_RADIATION_DAMAGE = 0 , RAMO_POTENTIAL = 1 , TEMPLATE_CORRECTION = 2 }

Public Member Functions
	SensorSimTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual	~SensorSimTool ()
virtual StatusCode	induceCharge (const TimedHitPtr< SiHit > &phit, SiChargedDiodeCollection &chargedDiodes, const InDetDD::SiDetectorElement &Module, const InDetDD::PixelModuleDesign &p_design, std::vector< std::pair< double, double > > &trfHitRecord, std::vector< double > &initialConditions, CLHEP::HepRandomEngine *rndmEngine, const EventContext &ctx) const =0
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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.

Protected Attributes
ToolHandle< ISiPropertiesTool >	m_siPropertiesTool
SG::ReadCondHandleKey< PixelModuleData >	m_moduleDataKey
Gaudi::Property< int >	m_radiationDamageSimulationType
Gaudi::Property< std::string >	m_templateCorrectionRootFile
Gaudi::Property< std::vector< std::string > >	m_lorentzAngleCorrectionHistos
Gaudi::Property< std::vector< std::string > >	m_chargeCorrectionHistos
Gaudi::Property< std::vector< std::string > >	m_distanceCorrectionHistos
SG::ReadCondHandleKey< PixelRadiationDamageFluenceMapData >	m_fluenceDataKey
Gaudi::Property< bool >	m_digitizeITk3Das3D

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
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 38 of file SensorSimTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ RadiationDamageSimulationType

enum SensorSimTool::RadiationDamageSimulationType

Enumerator
NO_RADIATION_DAMAGE
RAMO_POTENTIAL
TEMPLATE_CORRECTION

Definition at line 41 of file SensorSimTool.h.

                                     {
    NO_RADIATION_DAMAGE = 0,
    RAMO_POTENTIAL = 1,
    TEMPLATE_CORRECTION = 2
  };

Constructor & Destructor Documentation

◆ SensorSimTool() [1/2]

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

inline

Definition at line 47 of file SensorSimTool.h.

                                                                                        :
    AthAlgTool(type, name, parent) {
    declareInterface<SensorSimTool>(this);
  }

◆ ~SensorSimTool()

virtual SensorSimTool::~SensorSimTool ( )

inlinevirtual

Definition at line 64 of file SensorSimTool.h.

64{}

◆ SensorSimTool() [2/2]

SensorSimTool::SensorSimTool ( )

private

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

◆ finalize()

virtual StatusCode SensorSimTool::finalize ( )

inlinevirtual

Reimplemented in SensorSim3DTool, and SensorSimPlanarTool.

Definition at line 63 of file SensorSimTool.h.

63{return StatusCode::FAILURE;}

◆ induceCharge()

virtual StatusCode SensorSimTool::induceCharge	(	const TimedHitPtr< SiHit > &	phit,
		SiChargedDiodeCollection &	chargedDiodes,
		const InDetDD::SiDetectorElement &	Module,
		const InDetDD::PixelModuleDesign &	p_design,
		std::vector< std::pair< double, double > > &	trfHitRecord,
		std::vector< double > &	initialConditions,
		CLHEP::HepRandomEngine *	rndmEngine,
		const EventContext &	ctx ) const

pure virtual

Implemented in SensorSim3DTool, and SensorSimPlanarTool.

◆ initialize()

virtual StatusCode SensorSimTool::initialize ( )

inlinevirtual

Reimplemented in SensorSim3DTool, and SensorSimPlanarTool.

Definition at line 54 of file SensorSimTool.h.

                                  {
    ATH_CHECK(AthAlgTool::initialize());
    ATH_CHECK(m_siPropertiesTool.retrieve());
    ATH_CHECK(m_moduleDataKey.initialize());
    ATH_CHECK(m_fluenceDataKey.initialize(m_radiationDamageSimulationType != RadiationDamageSimulationType::NO_RADIATION_DAMAGE && !m_fluenceDataKey.empty()));
 
    return StatusCode::SUCCESS;
  }

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

◆ interfaceID()

const InterfaceID & SensorSimTool::interfaceID ( )

inlinestatic

Definition at line 52 of file SensorSimTool.h.

52{return IID_ISensorSimTool;}

IID_ISensorSimTool

static const InterfaceID IID_ISensorSimTool("SensorSimTool", 1, 0)

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

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

Gaudi::Property<std::vector<std::string> > SensorSimTool::m_chargeCorrectionHistos

protected

Initial value:

{
    this, "ChargeCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for radiation damage charge correction"
  }

Definition at line 103 of file SensorSimTool.h.

  {
    this, "ChargeCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for radiation damage charge correction"
  };

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

Gaudi::Property<bool> SensorSimTool::m_digitizeITk3Das3D

protected

Initial value:

{
    this, "DigitizeITk3Das3D", false,
    "Flag to tell the code if the 3D sensors for ITK should be treated as 3D or as planar sensors for digitization"
  }

Definition at line 121 of file SensorSimTool.h.

  {
    this, "DigitizeITk3Das3D", false,
    "Flag to tell the code if the 3D sensors for ITK should be treated as 3D or as planar sensors for digitization"
  };

◆ m_distanceCorrectionHistos

Gaudi::Property<std::vector<std::string> > SensorSimTool::m_distanceCorrectionHistos

protected

Initial value:

{
    this, "DistanceCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for radiation damage distance correction"
  }

Definition at line 109 of file SensorSimTool.h.

  {
    this, "DistanceCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for radiation damage distance correction"
  };

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

SG::ReadCondHandleKey<PixelRadiationDamageFluenceMapData> SensorSimTool::m_fluenceDataKey

protected

Initial value:

{
    this, "PixelRadiationDamageFluenceMapData", "PixelRadiationDamageFluenceMapData", "Pixel fluence map data for radiation damage"
  }

Definition at line 115 of file SensorSimTool.h.

  {
    this, "PixelRadiationDamageFluenceMapData", "PixelRadiationDamageFluenceMapData", "Pixel fluence map data for radiation damage"
  };

◆ m_lorentzAngleCorrectionHistos

Gaudi::Property<std::vector<std::string> > SensorSimTool::m_lorentzAngleCorrectionHistos

protected

Initial value:

{
    this, "LorentzAngleCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for Lorentz angle correction"
  }

Definition at line 97 of file SensorSimTool.h.

  {
    this, "LorentzAngleCorrectionHistos", {},
    "Paths to the histograms inside the ROOT file for Lorentz angle correction"
  };

◆ m_moduleDataKey

SG::ReadCondHandleKey<PixelModuleData> SensorSimTool::m_moduleDataKey

protected

Initial value:

{
    this, "PixelModuleData", "PixelModuleData", "Pixel module data"
  }

Definition at line 81 of file SensorSimTool.h.

  {
    this, "PixelModuleData", "PixelModuleData", "Pixel module data"
  };

◆ m_radiationDamageSimulationType

Gaudi::Property<int> SensorSimTool::m_radiationDamageSimulationType

protected

Initial value:

{
    this, "RadiationDamageSimulationType", RadiationDamageSimulationType::NO_RADIATION_DAMAGE, "Option to simualte the effects of radiation damage"
  }

Definition at line 86 of file SensorSimTool.h.

  {
    this, "RadiationDamageSimulationType", RadiationDamageSimulationType::NO_RADIATION_DAMAGE, "Option to simualte the effects of radiation damage"
  };

◆ m_siPropertiesTool

ToolHandle<ISiPropertiesTool> SensorSimTool::m_siPropertiesTool

protected

Initial value:

{
    this, "SiPropertiesTool", "SiPropertiesTool", "Tool to retrieve SiProperties"
  }

Definition at line 76 of file SensorSimTool.h.

  {
    this, "SiPropertiesTool", "SiPropertiesTool", "Tool to retrieve SiProperties"
  };

◆ m_templateCorrectionRootFile

Gaudi::Property<std::string> SensorSimTool::m_templateCorrectionRootFile

protected

Initial value:

{
    this, "TemplateCorrectionROOTfile", "",
    "Path to the ROOT file with histograms for radiation damage template corrections"
  }

Definition at line 91 of file SensorSimTool.h.

  {
    this, "TemplateCorrectionROOTfile", "",
    "Path to the ROOT file with histograms for radiation damage template corrections"
  };

◆ 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 file:

SensorSimTool.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ RadiationDamageSimulationType

Constructor & Destructor Documentation

◆ SensorSimTool() [1/2]

◆ ~SensorSimTool()

◆ SensorSimTool() [2/2]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ induceCharge()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chargeCorrectionHistos

◆ m_detStore

◆ m_digitizeITk3Das3D

◆ m_distanceCorrectionHistos

◆ m_evtStore

◆ m_fluenceDataKey

◆ m_lorentzAngleCorrectionHistos

◆ m_moduleDataKey

◆ m_radiationDamageSimulationType

◆ m_siPropertiesTool

◆ m_templateCorrectionRootFile

◆ m_varHandleArraysDeclared

◆ m_vhka