This validation tool Energy states of partlices. More...

#include <EnergyLossMonitor.h>

Inheritance diagram for Trk::EnergyLossMonitor:

Collaboration diagram for Trk::EnergyLossMonitor:

Public Member Functions
	EnergyLossMonitor (const std::string &, const std::string &, const IInterface *)
	standard AlgTool constructor / destructor
	~EnergyLossMonitor ()
StatusCode	initialize ()
	standard Athena methods
StatusCode	finalize ()
virtual void	initializeTrack (double p, double E, double eta, double phi)
	Initialize State.
virtual void	recordTrackState (const Amg::Vector3D &pos, const Amg::Vector3D &mom, double mass)
	Record a single TrackState.
virtual void	finalizeTrack ()
	Finalization State.
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 ()
	Interface ID, declared here, and defined below.

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
ServiceHandle< INTupleSvc >	m_ntupleSvc
	Ntuple Business.
std::string	m_outputNtuplePath
std::string	m_outputNtupleDescription
int	m_currentStep
	Ntuple helper.
NTuple::Item< long >	m_steps
	Step variables.
NTuple::Item< float >	m_initialP
	Initial variables.
NTuple::Item< float >	m_initialE
NTuple::Item< float >	m_initialEta
NTuple::Item< float >	m_initialPhi
NTuple::Array< float >	m_p
NTuple::Array< float >	m_E
NTuple::Array< float >	m_eta
NTuple::Array< float >	m_phi
NTuple::Array< float >	m_hitX
NTuple::Array< float >	m_hitY
NTuple::Array< float >	m_hitR
NTuple::Array< float >	m_hitZ
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 validation tool Energy states of partlices.

Author: Sebas.nosp@m.tian.nosp@m..Flei.nosp@m.schm.nosp@m.ann@c.nosp@m.ern..nosp@m.ch

Definition at line 27 of file EnergyLossMonitor.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

◆ EnergyLossMonitor()

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

standard AlgTool constructor / destructor

Definition at line 17 of file EnergyLossMonitor.cxx.

                                                                                                   :
  AthAlgTool(t,n,p),
  m_ntupleSvc("NTupleSvc", n),
  m_outputNtuplePath("/NTUPLES/FILE1/EnergyLossMonitor/SingleTrackEnergyLoss"),
  m_outputNtupleDescription("Output of the Trk::EnergyLossMonitor AlgTool"),
  m_currentStep(0)
{
   declareInterface<IEnergyLossMonitor>(this);
   declareProperty("NtuplePath",             m_outputNtuplePath);
   declareProperty("NtupleDescription",      m_outputNtupleDescription);
}

◆ ~EnergyLossMonitor()

Trk::EnergyLossMonitor::~EnergyLossMonitor ( )

inline

Definition at line 32 of file EnergyLossMonitor.h.

32{}

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

StatusCode Trk::EnergyLossMonitor::finalize ( )

Definition at line 69 of file EnergyLossMonitor.cxx.

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

◆ finalizeTrack()

void Trk::EnergyLossMonitor::finalizeTrack ( )

virtual

Finalization State.

Implements Trk::IEnergyLossMonitor.

Definition at line 108 of file EnergyLossMonitor.cxx.

{
   m_steps = m_currentStep;
   StatusCode sc = m_ntupleSvc->writeRecord(m_outputNtuplePath);
   if (sc.isFailure()){
     ATH_MSG_WARNING( "Couldn't write ntuple record!" );
   }
}

◆ initialize()

StatusCode Trk::EnergyLossMonitor::initialize ( )

standard Athena methods

Definition at line 31 of file EnergyLossMonitor.cxx.

{ 
    // Retrieve the NTuple Service
    ATH_CHECK( m_ntupleSvc.retrieve() );
    NTuplePtr ntr(m_ntupleSvc.get(), m_outputNtuplePath);
    StatusCode sc;
    if (!ntr) {
      ntr = m_ntupleSvc->book(m_outputNtuplePath, CLID_ColumnWiseTuple, m_outputNtupleDescription);
    }
    if (ntr){
      sc = ntr->addItem("Steps",             m_steps, 0, 5000);
      // Initial paramters
      sc = ntr->addItem("InitialP",          m_initialP, 0., 1000000.);
      sc = ntr->addItem("InitialE",          m_initialE, 0., 1000000.);
      sc = ntr->addItem("InitialEta",        m_initialEta, -4., 4.);
      sc = ntr->addItem("InitialPhi",        m_initialPhi, -4., 4.);
      // kinematics
      sc = ntr->addItem("Eta",               m_steps, m_eta);
      sc = ntr->addItem("Phi",               m_steps, m_phi);
      // Beam Pipe
      sc = ntr->addItem("Energy",            m_steps, m_E);
      sc = ntr->addItem("Momentum",          m_steps, m_p);
      sc = ntr->addItem("Eta",               m_steps, m_eta);
      sc = ntr->addItem("Phi",               m_steps, m_phi);
      sc = ntr->addItem("MaterialHitX",      m_steps, m_hitX);
      sc = ntr->addItem("MaterialHitY",      m_steps, m_hitY);
      sc = ntr->addItem("MaterialHitZ",      m_steps, m_hitZ);
      sc = ntr->addItem("MaterialHitR",      m_steps, m_hitR);
 
    } else {
      ATH_MSG_ERROR( "Ntuple booking failed!" );
      return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG("initialize() successful" );
    return sc;
}

◆ initializeTrack()

void Trk::EnergyLossMonitor::initializeTrack	(	double	p,
		double	E,
		double	eta,
		double	phi )

virtual

Initialize State.

Implements Trk::IEnergyLossMonitor.

Definition at line 76 of file EnergyLossMonitor.cxx.

{
    m_initialP   = p;
    m_initialE   = E;
    m_initialEta = eta;
    m_initialPhi = phi;
    m_currentStep = 0;
}

◆ 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::IEnergyLossMonitor::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 47 of file IEnergyLossMonitor.h.

                                                               {
    return IID_IEnergyLossMonitor;
  }

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

◆ recordTrackState()

void Trk::EnergyLossMonitor::recordTrackState	(	const Amg::Vector3D &	pos,
		const Amg::Vector3D &	mom,
		double	mass )

virtual

Record a single TrackState.

Implements Trk::IEnergyLossMonitor.

Definition at line 88 of file EnergyLossMonitor.cxx.

{
 
  // Geant4 first step protection 
  if (pos.mag() > 0.01 && m_currentStep < 5000){ 
    double p                = mom.mag();
    m_E[m_currentStep]      = sqrt(p*p+mass*mass);
    m_p[m_currentStep]      = p;
    m_eta[m_currentStep]    = mom.eta();
    m_phi[m_currentStep]    = mom.phi();
    m_hitX[m_currentStep]   = pos.x();
    m_hitY[m_currentStep]   = pos.y();
    m_hitZ[m_currentStep]   = pos.z();
    m_hitR[m_currentStep]   = pos.perp();
    m_currentStep++;
  }
}

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

int Trk::EnergyLossMonitor::m_currentStep

private

Ntuple helper.

Definition at line 59 of file EnergyLossMonitor.h.

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

NTuple::Array<float> Trk::EnergyLossMonitor::m_E

private

Definition at line 70 of file EnergyLossMonitor.h.

◆ m_eta

NTuple::Array<float> Trk::EnergyLossMonitor::m_eta

private

Definition at line 71 of file EnergyLossMonitor.h.

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

NTuple::Array<float> Trk::EnergyLossMonitor::m_hitR

private

Definition at line 75 of file EnergyLossMonitor.h.

◆ m_hitX

NTuple::Array<float> Trk::EnergyLossMonitor::m_hitX

private

Definition at line 73 of file EnergyLossMonitor.h.

◆ m_hitY

NTuple::Array<float> Trk::EnergyLossMonitor::m_hitY

private

Definition at line 74 of file EnergyLossMonitor.h.

◆ m_hitZ

NTuple::Array<float> Trk::EnergyLossMonitor::m_hitZ

private

Definition at line 76 of file EnergyLossMonitor.h.

◆ m_initialE

NTuple::Item<float> Trk::EnergyLossMonitor::m_initialE

private

Definition at line 65 of file EnergyLossMonitor.h.

◆ m_initialEta

NTuple::Item<float> Trk::EnergyLossMonitor::m_initialEta

private

Definition at line 66 of file EnergyLossMonitor.h.

◆ m_initialP

NTuple::Item<float> Trk::EnergyLossMonitor::m_initialP

private

Initial variables.

Definition at line 64 of file EnergyLossMonitor.h.

◆ m_initialPhi

NTuple::Item<float> Trk::EnergyLossMonitor::m_initialPhi

private

Definition at line 67 of file EnergyLossMonitor.h.

◆ m_ntupleSvc

ServiceHandle<INTupleSvc> Trk::EnergyLossMonitor::m_ntupleSvc

private

Ntuple Business.

Definition at line 54 of file EnergyLossMonitor.h.

◆ m_outputNtupleDescription

std::string Trk::EnergyLossMonitor::m_outputNtupleDescription

private

Definition at line 56 of file EnergyLossMonitor.h.

◆ m_outputNtuplePath

std::string Trk::EnergyLossMonitor::m_outputNtuplePath

private

Definition at line 55 of file EnergyLossMonitor.h.

◆ m_p

NTuple::Array<float> Trk::EnergyLossMonitor::m_p

private

Definition at line 69 of file EnergyLossMonitor.h.

◆ m_phi

NTuple::Array<float> Trk::EnergyLossMonitor::m_phi

private

Definition at line 72 of file EnergyLossMonitor.h.

◆ m_steps

NTuple::Item<long> Trk::EnergyLossMonitor::m_steps

private

Step variables.

Definition at line 62 of file EnergyLossMonitor.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EnergyLossMonitor()

◆ ~EnergyLossMonitor()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ finalizeTrack()

◆ initialize()

◆ initializeTrack()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ recordTrackState()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_currentStep

◆ m_detStore

◆ m_E

◆ m_eta

◆ m_evtStore

◆ m_hitR

◆ m_hitX

◆ m_hitY

◆ m_hitZ

◆ m_initialE

◆ m_initialEta

◆ m_initialP

◆ m_initialPhi

◆ m_ntupleSvc

◆ m_outputNtupleDescription

◆ m_outputNtuplePath

◆ m_p

◆ m_phi

◆ m_steps

◆ m_varHandleArraysDeclared

◆ m_vhka