Trk::MaterialEffectsEngine Class Reference

Material effects engine interface for charged and neutral (fast track simulation) , the update is alwyas on the: More...

#include <MaterialEffectsEngine.h>

Inheritance diagram for Trk::MaterialEffectsEngine:

Collaboration diagram for Trk::MaterialEffectsEngine:

Public Member Functions
	MaterialEffectsEngine (const std::string &, const std::string &, const IInterface *)
	Constructor.
	~MaterialEffectsEngine ()
	Destructor.
StatusCode	initialize ()
	AlgTool initialize method.
StatusCode	finalize ()
	AlgTool finalize method.
virtual ExtrapolationCode	handleMaterial (ExCellCharged &ecCharged, PropDirection dir=alongMomentum, MaterialUpdateStage matupstage=fullUpdate) const
	charged extrapolation
virtual ExtrapolationCode	handleMaterial (ExCellNeutral &ecNeutral, PropDirection dir=alongMomentum, MaterialUpdateStage matupstage=fullUpdate) const
	neutral extrapolation - only for Fatras, dummy implementation here
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 ()
	AlgTool interface methods.

Protected Member Functions
TrackParameters *	updateTrackParameters (Trk::TrackParameters &parameters, Trk::ExCellCharged &eCell, Trk::PropDirection dir, Trk::MaterialUpdateStage matupstage) const
	charged extrapolation
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
MaterialInteraction	m_interactionFormulae
	the formulas concentrated
BooleanProperty	m_eLossCorrection
BooleanProperty	m_eLossMpv
BooleanProperty	m_mscCorrection
StringProperty	m_sopPrefix_prop {this, "OutputPrefix", ""}
StringProperty	m_sopPostfix_prop {this, "OutputPostfix", ""}
std::string	m_sopPrefix
	prefix for screen output
std::string	m_sopPostfix
	prefix for screen output

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

Material effects engine interface for charged and neutral (fast track simulation) , the update is alwyas on the:

• eCell.leadParmaeters && eCell.leadLayer
• if eCell.leadPameters == eCell.startParamters clone to new parameters else : update the new parameters

Author

Andreas Salzburger -at - cern.ch

Definition at line 38 of file MaterialEffectsEngine.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

MaterialEffectsEngine()

Trk::MaterialEffectsEngine::MaterialEffectsEngine	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor.

Definition at line 16 of file MaterialEffectsEngine.cxx.

: AthAlgTool(t,n,p)
{
    declareInterface<Trk::IMaterialEffectsEngine>(this);
}

~MaterialEffectsEngine()

Trk::MaterialEffectsEngine::~MaterialEffectsEngine ( )

default

Destructor.

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.

{ 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

finalize()

StatusCode Trk::MaterialEffectsEngine::finalize

(

)

AlgTool finalize method.

Definition at line 38 of file MaterialEffectsEngine.cxx.

{
    EX_MSG_DEBUG( "", "finalize","",  "successful" );
    return StatusCode::SUCCESS;
}

handleMaterial() [1/2]

Trk::ExtrapolationCode Trk::MaterialEffectsEngine::handleMaterial ( Trk::ExCellCharged & eCell, Trk::PropDirection dir = alongMomentum, Trk::MaterialUpdateStage matupstage = fullUpdate ) const

virtual

charged extrapolation

Implements Trk::IMaterialEffectsEngine.

Definition at line 91 of file MaterialEffectsEngine.cxx.

{
 
    // the Extrapolator made sure that the layer is the lead layer && the parameters are the lead parameters
    if (eCell.leadLayer && eCell.leadLayer->layerMaterialProperties()){
        EX_MSG_DEBUG( ++eCell.navigationStep, "layer",  eCell.leadLayer->layerIndex().value(), "handleMaterial for charged parameters called.");
        // update the track parameters
        eCell.leadParameters = updateTrackParameters(*eCell.leadParameters,eCell,dir,matupstage);
    }
    // only in case of post update it should not return InProgress
    return Trk::ExtrapolationCode::InProgress;
}

handleMaterial() [2/2]

Trk::ExtrapolationCode Trk::MaterialEffectsEngine::handleMaterial ( Trk::ExCellNeutral & eCell, Trk::PropDirection dir = alongMomentum, Trk::MaterialUpdateStage matupstage = fullUpdate ) const

virtual

neutral extrapolation - only for Fatras, dummy implementation here

neutral extrapolation - just collect material

Implements Trk::IMaterialEffectsEngine.

Definition at line 45 of file MaterialEffectsEngine.cxx.

{
 
    // the Extrapolator made sure that the layer is the lead layer && the parameters are the lead parameters
    if (eCell.leadLayer && eCell.leadLayer->layerMaterialProperties()){
        EX_MSG_DEBUG( ++eCell.navigationStep, "layer",  eCell.leadLayer->layerIndex().value(), "handleMaterial for neutral parameters called - collect material.");
        // now calculate the pathCorrection from the layer surface - it is signed, gives you the relative direction to the layer
        const Trk::Layer* layer = eCell.leadLayer;
        // path correction
        double pathCorrection = layer->surfaceRepresentation().pathCorrection(eCell.leadParameters->position(),dir*(eCell.leadParameters->momentum()));
        // the relative direction wrt with the layer
        Trk::PropDirection rlDir = (pathCorrection >= 0. ? Trk::alongMomentum : Trk::oppositeMomentum);
        // multiply by the pre-and post-update factor
        double mFactor = layer->layerMaterialProperties()->factor(rlDir, matupstage);
        if (mFactor == 0.){
            EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material collection with "  << (matupstage > 0. ? "pre " : "post ")  << "factor 0.");
            // return the parameters untouched -
            return Trk::ExtrapolationCode::InProgress;
        }
        pathCorrection = mFactor*pathCorrection;
        // screen output
        EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material update with corr factor = " << pathCorrection);
        // get the actual material bin
        const Trk::MaterialProperties* materialProperties = layer->layerMaterialProperties()->fullMaterial(eCell.leadParameters->position());
        // and let's check if there's acutally something to do
        if (materialProperties && std::abs(pathCorrection)>0.){
            // thickness in X0
            double thicknessInX0          = materialProperties->thicknessInX0();
            // check if material filling was requested
            if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::CollectMaterial)){
                EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "collecting material of [t/X0] = " << thicknessInX0);
                eCell.stepMaterial(eCell.leadParameters->associatedSurface(), layer, eCell.leadParameters->position(), pathCorrection, materialProperties);
            } else {
                EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "adding material of [t/X0] = " << thicknessInX0);
                eCell.addMaterial(pathCorrection, materialProperties);
            }
        }
    }
    // only in case of post update it should not return InProgress
    return Trk::ExtrapolationCode::InProgress;
}

initialize()

StatusCode Trk::MaterialEffectsEngine::initialize

(

)

AlgTool initialize method.

Definition at line 28 of file MaterialEffectsEngine.cxx.

{
    m_sopPrefix = m_sopPrefix_prop;
    m_sopPostfix = m_sopPostfix_prop;
 
    EX_MSG_DEBUG( "", "initialize","",  "successful" );
    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 & Trk::IMaterialEffectsEngine::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 47 of file IMaterialEffectsEngine.h.

{ return IID_IMaterialEffectsEngine; }

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.

updateTrackParameters()

Trk::TrackParameters * Trk::MaterialEffectsEngine::updateTrackParameters ( Trk::TrackParameters & parameters, Trk::ExCellCharged & eCell, Trk::PropDirection dir, Trk::MaterialUpdateStage matupstage ) const

protected

charged extrapolation

dE/dl ionization energy loss per path unit

multiple scattering as function of dInX0

Definition at line 107 of file MaterialEffectsEngine.cxx.

{
    // now calculate the pathCorrection from the layer surface - it is signed, gives you the relative direction to the layer
    const Trk::Layer* layer = eCell.leadLayer;
    // path correction
    double pathCorrection = layer->surfaceRepresentation().pathCorrection(parameters.position(),dir*(parameters.momentum()));
    // the relative direction wrt with the layer
    Trk::PropDirection rlDir = (pathCorrection >= 0. ? Trk::alongMomentum : Trk::oppositeMomentum);
    // multiply by the pre-and post-update factor
    double mFactor = layer->layerMaterialProperties()->factor(rlDir, matupstage);
    if (mFactor == 0.){
        EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material update with "  << (matupstage > 0. ? "pre " : "post ")  << "factor 0. No update done.");
        // return the parameters untouched -
        return (&parameters);
    }
    pathCorrection = mFactor*pathCorrection;
    // screen output
    EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material update with corr factor = " << pathCorrection);
    // get the actual material bin
    const Trk::MaterialProperties* materialProperties = layer->layerMaterialProperties()->fullMaterial(parameters.position());
    // and let's check if there's acutally something to do
    if (materialProperties && std::abs(pathCorrection)>0. &&
    ( m_eLossCorrection || m_mscCorrection || eCell.checkConfigurationMode(Trk::ExtrapolationMode::CollectMaterial)) ){
        // and add them
        int sign = int(eCell.materialUpdateMode);
        // a simple cross-check if the parameters are the initial ones
        AmgVector(5)      uParameters = parameters.parameters();
        std::unique_ptr<AmgSymMatrix(5)> uCovariance =
          parameters.covariance()
            ? std::make_unique<AmgSymMatrix(5)>(*parameters.covariance())
            : nullptr;
        // get the material itself & its parameters
        const Trk::Material& material = materialProperties->material();
        double thicknessInX0          = materialProperties->thicknessInX0();
        double thickness              = materialProperties->thickness();
        // calculate energy loss and multiple scattering
        double p      = parameters.momentum().mag();
        double m      = Trk::ParticleMasses::mass[eCell.pHypothesis];
        double E      = sqrt(p*p+m*m);
        double beta   = p/E;
        // (A) - energy loss correction
        if (m_eLossCorrection){
            double sigmaP = 0.;
            double kazl   = 0.;
            double dEdl = sign*dir*Trk::MaterialInteraction::dEdl_ionization(p, material, eCell.pHypothesis, sigmaP, kazl);
            double dE   = thickness*pathCorrection*dEdl;
            sigmaP *= thickness*pathCorrection;
            // calcuate the new momentum
            double newP = sqrt((E+dE)*(E+dE)-m*m);
            uParameters[Trk::qOverP] = parameters.charge()/newP;
            double sigmaDeltaE = thickness*pathCorrection*sigmaP;
            double sigmaQoverP = sigmaDeltaE/std::pow(beta*p,2);
            // update the covariance if needed
            if (uCovariance)
               (*uCovariance)(Trk::qOverP, Trk::qOverP) += sign*sigmaQoverP*sigmaQoverP;
    }
        // (B) - update the covariance if needed
        if (uCovariance && m_mscCorrection){
            double sigmaMS = Trk::MaterialInteraction::sigmaMS(thicknessInX0*pathCorrection, p, beta);
            double sinTheta = sin(parameters.parameters()[Trk::theta]);
            double sigmaDeltaPhiSq = sigmaMS*sigmaMS/(sinTheta*sinTheta);
            double sigmaDeltaThetaSq = sigmaMS*sigmaMS;
            // add or remove @TODO implement check for covariance matrix -> 0
            (*uCovariance)(Trk::phi,Trk::phi)      += sign*sigmaDeltaPhiSq;
            (*uCovariance)(Trk::theta, Trk::theta) += sign*sigmaDeltaThetaSq;
        }
        // check if material filling was requested
        if (eCell.checkConfigurationMode(Trk::ExtrapolationMode::CollectMaterial)){
            EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "collecting material of [t/X0] = " << thicknessInX0);
            eCell.stepMaterial(parameters.associatedSurface(), layer, parameters.position(), pathCorrection, materialProperties);
        } else {
            EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "adding material of [t/X0] = " << thicknessInX0);
            eCell.addMaterial(pathCorrection, materialProperties);
        }
        // now either create new ones or update - only start parameters can not be updated
        if (eCell.leadParameters != eCell.startParameters ){
            EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material update on non-initial parameters.");
            if (uCovariance)
              parameters.updateParameters(uParameters,*uCovariance);
            else
              parameters.updateParameters(uParameters);
        } else {
            EX_MSG_VERBOSE(eCell.navigationStep, "layer",  layer->layerIndex().value(), "material update on initial parameters, creating new ones.");
            // create new parameters
            const Trk::Surface& tSurface = parameters.associatedSurface();
            Trk::TrackParameters* tParameters = tSurface.createUniqueTrackParameters(uParameters[Trk::loc1],
                                                                                     uParameters[Trk::loc2],
                                                                                     uParameters[Trk::phi],
                                                                                     uParameters[Trk::theta],
                                                                                     uParameters[Trk::qOverP],
                                                                                     *uCovariance).release();
            // these are newly created
            return tParameters;
        }
    }
    //note aliasing input ...
    return (&parameters);
}

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_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_eLossCorrection

BooleanProperty Trk::MaterialEffectsEngine::m_eLossCorrection

protected

Initial value:

{this, "EnergyLossCorrection", true,
    "apply the energy loss correction"}

Definition at line 71 of file MaterialEffectsEngine.h.

                                       {this, "EnergyLossCorrection", true,
    "apply the energy loss correction"};

m_eLossMpv

BooleanProperty Trk::MaterialEffectsEngine::m_eLossMpv

protected

Initial value:

{this, "MostProbableEnergyLoss", true,
    "apply the energy loss correction as most probable value"}

Definition at line 73 of file MaterialEffectsEngine.h.

                                {this, "MostProbableEnergyLoss", true,
    "apply the energy loss correction as most probable value"};

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_interactionFormulae

MaterialInteraction Trk::MaterialEffectsEngine::m_interactionFormulae

protected

the formulas concentrated

Definition at line 70 of file MaterialEffectsEngine.h.

m_mscCorrection

BooleanProperty Trk::MaterialEffectsEngine::m_mscCorrection

protected

Initial value:

{this, "MultipleScatteringCorrection", true,
    "apply the multiple (coulomb) scattering correction"}

Definition at line 75 of file MaterialEffectsEngine.h.

                                     {this, "MultipleScatteringCorrection", true,
    "apply the multiple (coulomb) scattering correction"};

m_sopPostfix

std::string Trk::IMaterialEffectsEngine::m_sopPostfix

protectedinherited

prefix for screen output

Definition at line 62 of file IMaterialEffectsEngine.h.

m_sopPostfix_prop

StringProperty Trk::MaterialEffectsEngine::m_sopPostfix_prop {this, "OutputPostfix", ""}

protected

Definition at line 79 of file MaterialEffectsEngine.h.

{this, "OutputPostfix", ""};

m_sopPrefix

std::string Trk::IMaterialEffectsEngine::m_sopPrefix

protectedinherited

prefix for screen output

Definition at line 61 of file IMaterialEffectsEngine.h.

m_sopPrefix_prop

StringProperty Trk::MaterialEffectsEngine::m_sopPrefix_prop {this, "OutputPrefix", ""}

protected

Definition at line 78 of file MaterialEffectsEngine.h.

{this, "OutputPrefix", ""};

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:

• MaterialEffectsEngine.h
• MaterialEffectsEngine.cxx