#include <RT_Relation_DB_DigiTool.h>

Inheritance diagram for RT_Relation_DB_DigiTool:

Collaboration diagram for RT_Relation_DB_DigiTool:

Public Member Functions
	RT_Relation_DB_DigiTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual StatusCode	initialize () override
virtual MdtDigiToolOutput	digitize (const EventContext &ctx, const MdtDigiToolInput &input, CLHEP::HepRandomEngine *rndmEngine) 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 (IMDT_DigitizationTool, 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
double	getDriftTime (const EventContext &ctx, double measRadius, double innerTubeRadius, const Identifier &DigitId, CLHEP::HepRandomEngine *rndmEngine) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static double	getAdcResponse (double radius, CLHEP::HepRandomEngine *rndmEngine)

Private Attributes
SG::ReadCondHandleKey< MuonCalib::MdtCalibDataContainer >	m_calibDbKey
SG::ReadCondHandleKey< MuonGM::MuonDetectorManager >	m_detMgrKey {this, "DetMgr", "MuonDetectorManager", ""}
Gaudi::Property< double >	m_effRadius {this, "EffectiveRadius", 14.4275}
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 32 of file RT_Relation_DB_DigiTool.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

◆ RT_Relation_DB_DigiTool()

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

Definition at line 15 of file RT_Relation_DB_DigiTool.cxx.

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

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

◆ DeclareInterfaceID()

IMDT_DigitizationTool::DeclareInterfaceID	(	IMDT_DigitizationTool	,
		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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ digitize()

MdtDigiToolOutput RT_Relation_DB_DigiTool::digitize	(	const EventContext &	ctx,
		const MdtDigiToolInput &	input,
		CLHEP::HepRandomEngine *	rndmEngine ) const

finaloverridevirtual

Implements IMDT_DigitizationTool.

Definition at line 27 of file RT_Relation_DB_DigiTool.cxx.

                                                                                            {
    ATH_MSG_DEBUG("Digitizing input ");
    SG::ReadCondHandle<MuonGM::MuonDetectorManager> detMgr{m_detMgrKey, ctx};
    const Identifier DigitId = input.getHitID();
    const double maxTubeRadius{detMgr->getMdtReadoutElement(DigitId)->innerTubeRadius()};
    const double radius{input.radius()};
    const double eff = 1.0 - (m_effRadius - radius) / (m_effRadius - maxTubeRadius);
    if ((radius < 0) || (radius > maxTubeRadius) || 
        (radius >=m_effRadius  &&  CLHEP::RandFlat::shoot(rndmEngine, 0.0, 1.0) > eff)) {
        return MdtDigiToolOutput{false, 0., 0.};
    } 
         
    MdtDigiToolOutput output(true, getDriftTime(ctx, radius, maxTubeRadius, DigitId, rndmEngine), 
                                   getAdcResponse(radius, rndmEngine));
    return output;
}

◆ 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

◆ getAdcResponse()

double RT_Relation_DB_DigiTool::getAdcResponse	(	double	radius,
		CLHEP::HepRandomEngine *	rndmEngine )

staticprivate

Definition at line 126 of file RT_Relation_DB_DigiTool.cxx.

                                                                                              {
    // parametrization of the average adc value with respect to radius
    constexpr double p0 = 57.38141;
    constexpr double p1 = 8.616943;
    constexpr double p2 = 2.497827;
    constexpr double p3 = -1.625900;
    constexpr double p4 = 0.3125281;
    constexpr double p5 = -0.02929554;
    constexpr double p6 = 0.001367115;
    constexpr double p7 = -0.00002541936;
 
    double adcfunc = p0 + p1 * radius + p2 * std::pow(radius, 2) + p3 * std::pow(radius, 3) + p4 * std::pow(radius, 4) +
                     p5 * std::pow(radius, 5) + p6 * std::pow(radius, 6) + p7 * std::pow(radius, 7);
 
    // now the resolution function
    constexpr double g0 = 10.27808;
    constexpr double g1 = -0.3774593;
    constexpr double g2 = 0.02751001;
    constexpr double g3 = -0.0005994742;
 
    double adcWidth = g0 + g1 * radius + g2 * std::pow(radius, 2) + g3 * std::pow(radius, 3);
 
    // now smear according to adc width
    double adc = CLHEP::RandGaussZiggurat::shoot(rndmEngine, adcfunc, adcWidth);
 
    return adc;
}

◆ getDriftTime()

double RT_Relation_DB_DigiTool::getDriftTime	(	const EventContext &	ctx,
		double	measRadius,
		double	innerTubeRadius,
		const Identifier &	DigitId,
		CLHEP::HepRandomEngine *	rndmEngine ) const

private

Definition at line 46 of file RT_Relation_DB_DigiTool.cxx.

                                                                                     {
    // Get RT relation from DB
    SG::ReadCondHandle<MuonCalib::MdtCalibDataContainer> calibConstants{m_calibDbKey, ctx};
 
    if (!calibConstants.isValid()) {
        ATH_MSG_FATAL("Failed to retrieve calib constants "<<m_calibDbKey.fullKey());
        throw std::runtime_error("No Mdt calibration constants");
    }
    using RtRelationPtr = MuonCalib::MdtCalibDataContainer::RtRelationPtr;
    const RtRelationPtr& data{calibConstants->getCalibData(DigitId, msgStream())->rtRelation};
 
    double time = 0.0;
    double t = 0.0;
 
    if (data) {
        // get RT relation and resolution function
        const MuonCalib::IRtRelation *rtRelation = data->rt();
        const MuonCalib::IRtResolution *rtResolution = data->rtRes();
 
        // get inverse rt and calculate time resolution
        const MuonCalib::ITrRelation *trRelation = data->tr();
        time = trRelation->driftTime(std::abs(measRadius)).value_or(0.);
 
        if (time < 0.0) {
            time = 0.0;
            ATH_MSG_WARNING("Drift time <0 ! Returning 0.0 as drift time");
            return (time);
        }
 
        double radiusWidth = rtResolution->resolution(time);
        double velocity = rtRelation->driftVelocity(time);
        // std::cout << "time = " << time << "  drift radius = " << measRadius << "  outOfBound = "<< outOfBound << "  velocity = " << velocity <<
        // std::endl;
 
        if (velocity <= 0) {
            ATH_MSG_WARNING("Drift velocity <=0 ! Time will not be smeared with resolution but will take the default measRadius-t value");
            return time;
        }
        double timeWidth = radiusWidth / velocity;
 
        // now smear t according to t resolution
        double tUp = rtRelation->tUpper();
        // double tLow = rtRelation->tLower();
 
        double tmin = time - 3.4 * timeWidth;
        double tmax = time + 3.4 * timeWidth;
 
        if (tmin < 0.0) tmin = 0.0;
        if (tmax > tUp)
            tmax = trRelation->driftTime(innerTubeRadius).value_or(0.);  // tmax = tUp+tLow; //means: tmax  = (tmax of rt relation) + (one binwidth )
 
        double gaussian;
        constexpr double sqrt_one_over_two_pi = 0.39894228;
        double p1r = 0.8480 * std::exp(-0.5879 * measRadius);
        int flag = 0;
        int cutoff = 0;
 
        do {
            cutoff++;  // avoid eternal loop in case of problems
            t = CLHEP::RandFlat::shoot(rndmEngine, tmin, tmax);
 
            gaussian = (1 - p1r) * sqrt_one_over_two_pi * exp(-(t - time) * (t - time) / (2.0 * timeWidth * timeWidth));
            if (gaussian >= CLHEP::RandFlat::shoot(rndmEngine, 0.0, 1.0) || cutoff > 200) { flag = 1; }
        } while (flag == 0);
 
        // print summary
        ATH_MSG_DEBUG("t from r = " << time << "  t resolution = " << timeWidth << "\nr resolution = " << radiusWidth
                                    << "  driftvelocity = " << velocity << "\nsmeared t = " << t << "  cutoff = " << cutoff);
    } else {
        ATH_MSG_ERROR("Null pointer returned from CalibDBSvc. Returning 0.0 as drift time");
        return 0.0;
    }
 
    return t;
}

◆ initialize()

StatusCode RT_Relation_DB_DigiTool::initialize ( )

overridevirtual

Definition at line 20 of file RT_Relation_DB_DigiTool.cxx.

                                               {
    ATH_MSG_INFO("Initializing RT_Relation_DB_DigiTool");
    ATH_CHECK(m_calibDbKey.initialize());
    ATH_CHECK(m_detMgrKey.initialize());
    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_calibDbKey

SG::ReadCondHandleKey<MuonCalib::MdtCalibDataContainer> RT_Relation_DB_DigiTool::m_calibDbKey

private

Initial value:

{this, "CalibDataKey", "MdtCalibConstants",

"Conditions object containing the calibrations"}

Definition at line 53 of file RT_Relation_DB_DigiTool.h.

53 {this, "CalibDataKey", "MdtCalibConstants",

54 "Conditions object containing the calibrations"};

◆ m_detMgrKey

SG::ReadCondHandleKey<MuonGM::MuonDetectorManager> RT_Relation_DB_DigiTool::m_detMgrKey {this, "DetMgr", "MuonDetectorManager", ""}

private

Definition at line 56 of file RT_Relation_DB_DigiTool.h.

56{this, "DetMgr", "MuonDetectorManager", ""};

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

Gaudi::Property<double> RT_Relation_DB_DigiTool::m_effRadius {this, "EffectiveRadius", 14.4275}

private

Definition at line 58 of file RT_Relation_DB_DigiTool.h.

58{this, "EffectiveRadius", 14.4275};

◆ 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

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ RT_Relation_DB_DigiTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ digitize()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getAdcResponse()

◆ getDriftTime()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_calibDbKey

◆ m_detMgrKey

◆ m_detStore

◆ m_effRadius

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka