This is for the Doxygen-Documentation. More...

#include <MaterialOnTrackValidation.h>

Inheritance diagram for Trk::MaterialOnTrackValidation:

Collaboration diagram for Trk::MaterialOnTrackValidation:

Public Member Functions
	MaterialOnTrackValidation (const std::string &name, ISvcLocator *pSvcLocator)
	Standard Athena-Algorithm Constructor.
	~MaterialOnTrackValidation ()
	Default Destructor.
StatusCode	initialize ()
	standard Athena-Algorithm method
StatusCode	execute ()
	standard Athena-Algorithm method
StatusCode	finalize ()
	standard Athena-Algorithm method
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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
void	bookTree ()
	booking the tree
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_inputTrackCollection
	properties from JobOptions:
TTree *	m_Tree {}
int	m_updates {}
	variables
float	m_positionX [MAXUPDATES] {}
	x position of the update
float	m_positionY [MAXUPDATES] {}
	y position of the update
float	m_positionZ [MAXUPDATES] {}
	z position of the update
float	m_positionR [MAXUPDATES] {}
	r value of the material update
float	m_momentum [MAXUPDATES] {}
	momentum before the update is applied
float	m_momentumChange [MAXUPDATES] {}
	change of the momentum
float	m_traversedPathInX0 [MAXUPDATES] {}
	accumulated traversed path in rlength
double	m_currentPathInX0 {}
	accumulation variable
float	m_traversedStepInX0 [MAXUPDATES] {}
	the step path in x0
double	m_eta [MAXUPDATES] {}
	eta
double	m_stepInX0 {}
	traversed thickness in radiation length
DataObjIDColl	m_extendedExtraObjects
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

This is for the Doxygen-Documentation.

Please delete these lines and fill in information about the Algorithm! Please precede every member function declaration with a short Doxygen comment stating the purpose of this function.

Author: Markus Haider marku.nosp@m.s.ha.nosp@m.ider@.nosp@m.stud.nosp@m.ent.u.nosp@m.ibk..nosp@m.ac.at

Definition at line 35 of file MaterialOnTrackValidation.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MaterialOnTrackValidation()

Trk::MaterialOnTrackValidation::MaterialOnTrackValidation	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Standard Athena-Algorithm Constructor.

Definition at line 23 of file MaterialOnTrackValidation.cxx.

                                                                                                      :
  AthAlgorithm(name,pSvcLocator),
  m_inputTrackCollection("Tracks"),
  m_Tree(nullptr),
  m_updates(0), // Coverity complaints about this and the following members not to be initialised, although they are before usage.
  m_currentPathInX0(0),
  m_stepInX0(0)
{
 
 
  // Get Parameter values from JobOptions file
  declareProperty("InputTrackCollection",       m_inputTrackCollection);
}

◆ ~MaterialOnTrackValidation()

Trk::MaterialOnTrackValidation::~MaterialOnTrackValidation ( )

default

Default Destructor.

Member Function Documentation

◆ bookTree()

void Trk::MaterialOnTrackValidation::bookTree ( )

private

booking the tree

Definition at line 165 of file MaterialOnTrackValidation.cxx.

                                            {
 
  // Booking the Tree
  ATH_MSG_VERBOSE("Booking the tree ...");
  m_Tree = new TTree("MaterialOnTrackValidation","Material on track validation");
 
  // Adding the branches
  m_Tree->Branch("Updates"        ,&m_updates           , "updates/I");
  m_Tree->Branch("UpdatePositionX", m_positionX         , "updateX[updates]/F");
  m_Tree->Branch("UpdatePositionR", m_positionR         , "updateR[updates]/F");
  m_Tree->Branch("PreMomentum"    , m_momentum          , "preMomentum[updates]/F");
  m_Tree->Branch("MomentumChange" , m_momentumChange    , "momentumChange[updates]/F");
  m_Tree->Branch("PathInX0"       , m_traversedPathInX0 , "PathInX0[updates]/F");
  m_Tree->Branch("StepInX0"       , m_traversedStepInX0 , "StepInX0[updates]/F");
  m_Tree->Branch("Eta"            , m_eta               , "Eta[updates]/F");
 
 
  // Registering the Tree
  SmartIF<ITHistSvc> tHistSvc{service("THistSvc")};
  if (!tHistSvc) {
    ATH_MSG_ERROR("initialize() Could not find Hist Service -> Switching ValidationMode Off !");
    delete m_Tree; m_Tree = nullptr;
    return;
  }
 
  if ((tHistSvc->regTree("/val/MaterialOnTrackValidation", m_Tree)).isFailure()) {
    ATH_MSG_ERROR("initialize() Could not register the Tree -> Switching ValidationMode Off !");
    delete m_Tree; m_Tree = nullptr;
    return;
  }
 
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode Trk::MaterialOnTrackValidation::execute ( )

standard Athena-Algorithm method

Definition at line 66 of file MaterialOnTrackValidation.cxx.

{
  // Code entered here will be executed once per event
 
  // Retrieving the Trackcollection specified via m_inputTrackCollection
  StatusCode sc = StatusCode::SUCCESS;
  const TrackCollection* trackCollection = nullptr;
 
  if (!m_inputTrackCollection.empty()) {
      sc = evtStore()->retrieve(trackCollection,m_inputTrackCollection);
      if (sc.isFailure())
         ATH_MSG_ERROR( "TrackCollection "<<m_inputTrackCollection<<" not found!" );
      else
         ATH_MSG_VERBOSE("TrackCollection " << m_inputTrackCollection<<" found." );
 
    } else {
         ATH_MSG_ERROR("No Track collection given!" );
         return StatusCode::FAILURE;
  }
 
  // Looping over the tracks of retrieved trackcollection
 
  // Creating the iterators for the loop
  TrackCollection::const_iterator itTracks = trackCollection->begin();
  TrackCollection::const_iterator endTracks = trackCollection->end();
 
  for (;itTracks!=endTracks;++itTracks) {
 
    // Getting the TrackStateOnSurface for every track
    const Trk::TrackStates *currentTSOSList =(*itTracks)->trackStateOnSurfaces();
 
    // Iterators for loop inside track
    DataVector< const Trk::TrackStateOnSurface >::const_iterator itTSOS = currentTSOSList->begin();
    DataVector< const Trk::TrackStateOnSurface >::const_iterator endTSOS = currentTSOSList->end();
 
    // Initialize variables
    m_updates            = 0;
    m_currentPathInX0    = 0.;
 
    // Loop over all TrackStatesOnSurface
    for (;itTSOS!=endTSOS;++itTSOS) {
 
      // Get the Pointer to a trackStateOnSurface
      const MaterialEffectsBase* mEffect = (*itTSOS)->materialEffectsOnTrack();
 
      // Get the Pointer to Trackparameters
      const TrackParameters* tParameter = (*itTSOS)->trackParameters();
 
      // Getting all the parameters
      if (mEffect&&tParameter) {                          //protection against zero pointers
 
        m_stepInX0         = mEffect->thicknessInX0();    //traversed thickness in radiation length
        m_currentPathInX0 += m_stepInX0;                  //accumulated traversed path in rlength
 
        // Get hit parameters
        m_positionR[m_updates] = tParameter->position().perp();
        m_positionX[m_updates] = tParameter->position().x();
        m_positionY[m_updates] = tParameter->position().y();
        m_positionZ[m_updates] = tParameter->position().z();
 
        // Get momentum parameters
        m_momentum[m_updates]          = tParameter->momentum().mag();
        const Trk::EstimatedBremOnTrack* eb = 
          dynamic_cast<const Trk::EstimatedBremOnTrack*>(mEffect);
        const Trk::MaterialEffectsOnTrack* mef =
          dynamic_cast<const Trk::MaterialEffectsOnTrack*>(mEffect);
        if (eb!=nullptr) {
          m_momentumChange[m_updates]    = (1.0-eb->retainedEnFraction()) * tParameter->momentum().mag();
        } else if ( (mef!=nullptr) && (mef->energyLoss() != nullptr) ) {
          m_momentumChange[m_updates] = mef->energyLoss()->deltaE();
        } else m_momentumChange[m_updates] = 0.0;
 
        m_eta[m_updates]               = tParameter->position().eta();
        m_traversedStepInX0[m_updates] = m_stepInX0;        //current traversed thickness/radiation length
        m_traversedPathInX0[m_updates] = m_currentPathInX0; //accumulated traversed path/radiation length
 
        ++m_updates;                     //increases m_updates everytime the trackparameters are nonzero
        if (m_updates>=MAXUPDATES) {
          ATH_MSG_ERROR("Maximum number of updates reached!");
          // @TODO still fill the tree ? 
          return StatusCode::FAILURE;
        } 
        
      } //protection end
 
 
    } //loop TSOS end
 
    if (m_Tree)
      m_Tree->Fill();
 
  }   //loop tracks end
 
 
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode Trk::MaterialOnTrackValidation::finalize ( )

standard Athena-Algorithm method

Definition at line 58 of file MaterialOnTrackValidation.cxx.

{
  // Code entered here will be executed once at the end of the program run.
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::MaterialOnTrackValidation::initialize ( )

standard Athena-Algorithm method

Definition at line 45 of file MaterialOnTrackValidation.cxx.

{
  ATH_MSG_INFO( "initialize() successful in " << name() );
 
  // Book the Tree
  bookTree();
 
  return StatusCode::SUCCESS;
 
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_currentPathInX0

double Trk::MaterialOnTrackValidation::m_currentPathInX0 {}

private

accumulation variable

Definition at line 69 of file MaterialOnTrackValidation.h.

69{};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eta

double Trk::MaterialOnTrackValidation::m_eta[MAXUPDATES] {}

private

eta

Definition at line 71 of file MaterialOnTrackValidation.h.

71{};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_inputTrackCollection

std::string Trk::MaterialOnTrackValidation::m_inputTrackCollection

private

properties from JobOptions:

Definition at line 54 of file MaterialOnTrackValidation.h.

◆ m_momentum

float Trk::MaterialOnTrackValidation::m_momentum[MAXUPDATES] {}

private

momentum before the update is applied

Definition at line 66 of file MaterialOnTrackValidation.h.

66{};

◆ m_momentumChange

float Trk::MaterialOnTrackValidation::m_momentumChange[MAXUPDATES] {}

private

change of the momentum

Definition at line 67 of file MaterialOnTrackValidation.h.

67{};

◆ m_positionR

float Trk::MaterialOnTrackValidation::m_positionR[MAXUPDATES] {}

private

r value of the material update

Definition at line 65 of file MaterialOnTrackValidation.h.

65{};

◆ m_positionX

float Trk::MaterialOnTrackValidation::m_positionX[MAXUPDATES] {}

private

x position of the update

Definition at line 62 of file MaterialOnTrackValidation.h.

62{};

◆ m_positionY

float Trk::MaterialOnTrackValidation::m_positionY[MAXUPDATES] {}

private

y position of the update

Definition at line 63 of file MaterialOnTrackValidation.h.

63{};

◆ m_positionZ

float Trk::MaterialOnTrackValidation::m_positionZ[MAXUPDATES] {}

private

z position of the update

Definition at line 64 of file MaterialOnTrackValidation.h.

64{};

◆ m_stepInX0

double Trk::MaterialOnTrackValidation::m_stepInX0 {}

private

traversed thickness in radiation length

Definition at line 72 of file MaterialOnTrackValidation.h.

72{};

◆ m_traversedPathInX0

float Trk::MaterialOnTrackValidation::m_traversedPathInX0[MAXUPDATES] {}

private

accumulated traversed path in rlength

Definition at line 68 of file MaterialOnTrackValidation.h.

68{};

◆ m_traversedStepInX0

float Trk::MaterialOnTrackValidation::m_traversedStepInX0[MAXUPDATES] {}

private

the step path in x0

Definition at line 70 of file MaterialOnTrackValidation.h.

70{};

◆ m_Tree

TTree* Trk::MaterialOnTrackValidation::m_Tree {}

private

Definition at line 58 of file MaterialOnTrackValidation.h.

58{};

◆ m_updates

int Trk::MaterialOnTrackValidation::m_updates {}

private

variables

number of updates, for max value MAXUPDATES in line 14

Definition at line 61 of file MaterialOnTrackValidation.h.

61{};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ MaterialOnTrackValidation()

◆ ~MaterialOnTrackValidation()

Member Function Documentation

◆ bookTree()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_currentPathInX0

◆ m_detStore

◆ m_eta

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputTrackCollection

◆ m_momentum

◆ m_momentumChange

◆ m_positionR

◆ m_positionX

◆ m_positionY

◆ m_positionZ

◆ m_stepInX0

◆ m_traversedPathInX0

◆ m_traversedStepInX0

◆ m_Tree

◆ m_updates

◆ m_varHandleArraysDeclared

◆ m_vhka