HGTD_SurfaceChargesGenerator Class Reference

#include <HGTD_SurfaceChargesGenerator.h>

Inheritance diagram for HGTD_SurfaceChargesGenerator:

Collaboration diagram for HGTD_SurfaceChargesGenerator:

Public Member Functions
	HGTD_SurfaceChargesGenerator (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
virtual	~HGTD_SurfaceChargesGenerator ()=default
	Destructor.
StatusCode	initialize () override
	AlgTool initialize.
virtual void	createSurfaceChargesFromHit (const TimedHitPtr< SiHit > &timed_hit_ptr, SiChargedDiodeCollection *diode_coll, const InDetDD::SolidStateDetectorElementBase *element, CLHEP::HepRandomEngine *rndm_engine, const EventContext &ctx) const override final
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
	DeclareInterfaceID (IHGTD_SurfaceChargesGenerator, 1, 0)

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_small_step_length {this, "SmallStepLength", 1, ""}
FloatProperty	m_diffusion_constant {this, "DiffusionConstant", .007, ""}
FloatProperty	m_active_time_window {this, "ActiveTimeWindow", 1.25, "Hits within this time window are used for digitization, the rest are discarded (Given in ns)."}
BooleanProperty	m_smear_meantime {this, "SmearMeanTime", true, "Smear mean time based on radius and luminosity"}
ToolHandle< HGTD_TimeResolutionTool >	m_hgtd_time_resolution_tool
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 29 of file HGTD_SurfaceChargesGenerator.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_SurfaceChargesGenerator()

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

constructor

Definition at line 28 of file HGTD_SurfaceChargesGenerator.cxx.

    : AthAlgTool(type, name, parent) {
}

~HGTD_SurfaceChargesGenerator()

virtual HGTD_SurfaceChargesGenerator::~HGTD_SurfaceChargesGenerator ( )

virtualdefault

Destructor.

Member Function Documentation

createSurfaceChargesFromHit()

void HGTD_SurfaceChargesGenerator::createSurfaceChargesFromHit ( const TimedHitPtr< SiHit > & timed_hit_ptr, SiChargedDiodeCollection * diode_coll, const InDetDD::SolidStateDetectorElementBase * element, CLHEP::HepRandomEngine * rndm_engine, const EventContext & ctx ) const

finaloverridevirtual

Implements IHGTD_SurfaceChargesGenerator.

Definition at line 43 of file HGTD_SurfaceChargesGenerator.cxx.

                                   {
 
  const SiHit& hit = *timed_hit_ptr;
 
  float time_of_flight = timed_hit_ptr.eventTime() + hit.meanTime();
 
  //NB this "expected time" will change once we need to follow the beamspot!!
  float tof_expected = element->center().norm() / Gaudi::Units::c_light;
 
  ATH_MSG_DEBUG("event time = " << timed_hit_ptr.eventTime() << ", mean time ="
                                << hit.meanTime() << ", tof =" << time_of_flight
                                << ", tof exp =" << tof_expected);
 
  // the ALTIROC ASIC has an active window of 2.5ns around the expected TOA, all
  // hits outside that window are ignored (modulo some early hits with large
  // TOT that spill over). So ignore hits outside of this time window
  if (std::abs(time_of_flight - tof_expected) > m_active_time_window) {
    return;
  }
 
  // check the status of truth information for this SiHit
  // some Truth information is cut for pile up events
  const HepMcParticleLink trklink = HepMcParticleLink::getRedirectedLink(hit.particleLink(), timed_hit_ptr.eventId(), ctx); // This link should now correctly resolve to the TruthEvent McEventCollection in the main StoreGateSvc.
  SiCharge::Process hitproc{SiCharge::track};
  if (hit.truthID() != 0 || hit.truthBarcode() != 0) { // if the hit was not caused by a delta-ray then one of these must be true
    if (not trklink.isValid()) {
      // TODO consider extending this check to reject links to
      // GenEvents other than the first one in the McEventCollection,
      // so that the digitization output doesn't change if pile-up
      // truth is saved.
      hitproc = SiCharge::cut_track;
    }
  }
 
  float sensor_thickness = element->design().thickness();
  int readout_side = element->design().readoutSide();
 
  float pixel_size_xphi = element->design().phiPitch();
  float pixel_size_xeta = element->design().etaPitch();
 
  Amg::Vector3D element_center = element->center();
  ATH_MSG_DEBUG("x and y, z are: " << element_center.x() << ", "
                                   << element_center.y() << ", "
                                   << element_center.z());
  float element_r = sqrt(element_center.x() * element_center.x() +
                         element_center.y() * element_center.y());
 
  const CLHEP::Hep3Vector start_pos(hit.localStartPosition());
  const CLHEP::Hep3Vector end_pos(hit.localEndPosition());
 
  ATH_MSG_DEBUG("start_pos xEta=" << start_pos[SiHit::xEta]
                                  << ", xPhi=" << start_pos[SiHit::xPhi]
                                  << ", xDep=" << start_pos[SiHit::xDep]);
 
  CLHEP::Hep3Vector direction = end_pos - start_pos;
  float deposit_length = direction.mag();
  int n_steps = deposit_length / m_small_step_length + 1;
  // the start and end pos can sit at the same position. Resizing the
  // zero-length Hep3Vector would cause an error, so this we protect against
  if (deposit_length > 1.e-10) {
    direction.setMag(deposit_length / static_cast<float>(n_steps));
  }
 
  float tot_eloss = hit.energyLoss();
  // FIXME using the mean ionization energy in Silicon
  const float tot_charge = tot_eloss / (3.62 * CLHEP::eV) * Gaudi::Units::eplus;
 
  float charge_per_step = tot_charge / static_cast<float>(n_steps);
 
  // FIXME is this correct? does the eventTime include a "later" truth event and
  // the meanTime is just the TOF?
  ATH_MSG_DEBUG(">>>>>>> before processing, event_t, t, E, r: "
                << timed_hit_ptr.eventTime() << ", " << hit.meanTime() << ", "
                << tot_eloss << ", " << element_r);
 
  if (m_smear_meantime) {
    time_of_flight += CLHEP::RandGaussZiggurat::shoot(
        rndm_engine, 0.0f,
        m_hgtd_time_resolution_tool->timeResolution(tot_charge, element_r,
                                                    0.0));
  }
  ATH_MSG_DEBUG(">>>>>>> after processing, t: " << time_of_flight);
 
  // FIXME needed to check for deposits in guardrings. This should be taken over
  // by the module design class and not hardcoded here!
 
  float xphi_offset = 9.75;
  float xeta_offset = 19.5;
  // FIXME this should be handled by the module design class in the future
  float interpad = 50 * CLHEP::micrometer;
 
  for (int i_step = 0; i_step < n_steps; i_step++) {
    CLHEP::Hep3Vector surface_pos = start_pos + i_step * direction;
    ATH_MSG_DEBUG("surface_pos x=" << surface_pos.x()
                                   << ", y=" << surface_pos.y()
                                   << ", z=" << surface_pos.z());
    ATH_MSG_DEBUG("surface_pos xEta=" << surface_pos[SiHit::xEta]
                                      << ", xPhi=" << surface_pos[SiHit::xPhi]
                                      << ", xDep=" << surface_pos[SiHit::xDep]);
    // NB! y aka xPhi is the long side of the module!
    // DEBUG surface_pos x=9.08365,  y=-1.17206, z=-0.025
    // DEBUG surface_pos xEta=-0.025, xPhi=-1.17206, xDep=9.08365
    // FIXME: eta, phi andd dep need to be revisited in Rel 22!
 
    // Distance between charge and readout side.  p_design->readoutSide() is
    // +1 if readout side is in +ve depth axis direction and visa-versa.
    // FIXME ask Noemi about what happens here
    float spess =
        0.5 * sensor_thickness - readout_side * surface_pos[SiHit::xDep];
    if (spess < 0) {
      spess = 0; // FIXME this means I am on the surface already?
    }
    // diffusion sigma
    // FIXME where is the 0.3 from?
    float rdif = m_diffusion_constant * std::sqrt(spess / 0.3);
 
    // position at the surface, adding smearing
    // FIXME currently no Lorentz angle considered, can be studied in the future
    float surf_pos_xphi = surface_pos[SiHit::xPhi] +
                          rdif * CLHEP::RandGaussZiggurat::shoot(rndm_engine);
    float surf_pos_xeta = surface_pos[SiHit::xEta] +
                          rdif * CLHEP::RandGaussZiggurat::shoot(rndm_engine);
 
    // if the deposit is outside the guard ring, don't consider it
    if (fabs(surf_pos_xphi) > xphi_offset or
        fabs(surf_pos_xeta) > xeta_offset) {
      ATH_MSG_DEBUG("Hit in guard ring");
      continue;
    }
 
    int bin_xphi = floor(fabs(surf_pos_xphi + xphi_offset) / pixel_size_xphi);
    int bin_xeta = floor(fabs(surf_pos_xeta + xeta_offset) / pixel_size_xeta);
 
    float pos_xphi_inpixel =
        fabs(surf_pos_xphi + xphi_offset) - float(bin_xphi) * pixel_size_xphi;
    float pos_xeta_inpixel =
        fabs(surf_pos_xeta + xeta_offset) - float(bin_xeta) * pixel_size_xeta;
 
    bool is_interpad_xphi = (pos_xphi_inpixel < interpad or
                             pos_xphi_inpixel > (pixel_size_xphi - interpad));
    bool is_interpad_xeta = (pos_xeta_inpixel < interpad or
                             pos_xeta_inpixel > (pixel_size_xeta - interpad));
 
    // check if the charge is sitting in the interpad region
    if (is_interpad_xphi or is_interpad_xeta) {
      ATH_MSG_DEBUG("Hit in interpad region");
      continue;
    }
    // charges deposited within the active sensor get added
    const InDetDD::SiLocalPosition position(
        element->hitLocalToLocal(surf_pos_xeta, surf_pos_xphi));
 
    SiSurfaceCharge surface_charge(
        position, SiCharge(charge_per_step, time_of_flight, hitproc,
                           trklink)); // FIXME is this obj even needed?
 
    InDetDD::SiCellId cell_id =
        element->cellIdOfPosition(surface_charge.position());
    ATH_MSG_DEBUG("cell_id x=" << cell_id);
    if (cell_id.isValid()) {
      // add this charge to the collection (or merge in existing charged diode)
      diode_coll->add(cell_id, surface_charge.charge());
    }
  } // END LOOP over steps
}

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

DeclareInterfaceID()

IHGTD_SurfaceChargesGenerator::DeclareInterfaceID ( IHGTD_SurfaceChargesGenerator , 1 , 0  )

inherited

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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

initialize()

StatusCode HGTD_SurfaceChargesGenerator::initialize ( )

override

AlgTool initialize.

Definition at line 33 of file HGTD_SurfaceChargesGenerator.cxx.

                                                    {
  ATH_MSG_DEBUG("HGTD_SurfaceChargesGenerator::initialize()");
 
  m_small_step_length.setValue(m_small_step_length.value() * CLHEP::micrometer);
 
  ATH_CHECK(m_hgtd_time_resolution_tool.retrieve());
 
  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.

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_active_time_window

FloatProperty HGTD_SurfaceChargesGenerator::m_active_time_window {this, "ActiveTimeWindow", 1.25, "Hits within this time window are used for digitization, the rest are discarded (Given in ns)."}

private

Definition at line 55 of file HGTD_SurfaceChargesGenerator.h.

{this, "ActiveTimeWindow", 1.25, "Hits within this time window are used for digitization, the rest are discarded (Given in ns)."};

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_diffusion_constant

FloatProperty HGTD_SurfaceChargesGenerator::m_diffusion_constant {this, "DiffusionConstant", .007, ""}

private

Definition at line 54 of file HGTD_SurfaceChargesGenerator.h.

{this, "DiffusionConstant", .007, ""};

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_hgtd_time_resolution_tool

ToolHandle<HGTD_TimeResolutionTool> HGTD_SurfaceChargesGenerator::m_hgtd_time_resolution_tool

private

Initial value:

{
      this, "TimeResolutionTool", "HGTD_TimeResolutionTool",
      "Tool for smearing LGAD timing based on integrated luminosity and "
      "radius"}

Definition at line 57 of file HGTD_SurfaceChargesGenerator.h.

                                                                 {
      this, "TimeResolutionTool", "HGTD_TimeResolutionTool",
      "Tool for smearing LGAD timing based on integrated luminosity and "
      "radius"};

m_small_step_length

FloatProperty HGTD_SurfaceChargesGenerator::m_small_step_length {this, "SmallStepLength", 1, ""}

private

Definition at line 53 of file HGTD_SurfaceChargesGenerator.h.

{this, "SmallStepLength", 1, ""}; /*um*/

m_smear_meantime

BooleanProperty HGTD_SurfaceChargesGenerator::m_smear_meantime {this, "SmearMeanTime", true, "Smear mean time based on radius and luminosity"}

private

Definition at line 56 of file HGTD_SurfaceChargesGenerator.h.

{this, "SmearMeanTime", true, "Smear mean time based on radius and luminosity"};

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:

• HGTD_SurfaceChargesGenerator.h
• HGTD_SurfaceChargesGenerator.cxx