This validation tool writes information about track positions. More...

#include <TrackPositionNtupleHelper.h>

Inheritance diagram for Trk::TrackPositionNtupleHelper:

Collaboration diagram for Trk::TrackPositionNtupleHelper:

Public Member Functions
	TrackPositionNtupleHelper (const std::string &, const std::string &, const IInterface *)
	~TrackPositionNtupleHelper ()
StatusCode	initialize ()
	initialize
StatusCode	finalize ()
	finalize
virtual StatusCode	fillMeasurementData (const Trk::MeasurementBase , const Trk::TrackParameters , const int &detectorType, const bool &isOutlier)
	fill hit position data
virtual StatusCode	fillHoleData (const Trk::TrackStateOnSurface &, const int &)
	fill special data about holes on track (here: do nothing)
virtual StatusCode	addNtupleItems (TTree *tree, const int &detectorType)
	add items to the ntuple and configure the helper tool: should be called once (per detector type) by the steering tool (Trk::ITrackValidationNtupleTool)
virtual StatusCode	resetVariables (const int &detectorType)
	reset ntuple variables
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
bool	m_trkParametersWarning
	warn only once if no track pars exist
std::vector< float > *	m_trkX
	global position X of track intersecting meas't surface
std::vector< float > *	m_trkY
	global position Y of track intersecting meas't surface
std::vector< float > *	m_trkZ
	global position Z of track intersection meas't surface
std::vector< float > *	m_trkMomentumX
	global momentum X of track at measurement
std::vector< float > *	m_trkMomentumY
	global momentum Y of track at measurement
std::vector< float > *	m_trkMomentumZ
	global momentum Z of track at measurement
std::vector< float > *	m_trkLoc1
	local position 1st coord.
std::vector< float > *	m_trkLoc2
	local position 2nd coord.
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 writes information about track positions.

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

Definition at line 34 of file TrackPositionNtupleHelper.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

◆ TrackPositionNtupleHelper()

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

Definition at line 18 of file TrackPositionNtupleHelper.cxx.

        :
  AthAlgTool(t,n,p),
  m_trkParametersWarning(false),
  m_trkX(nullptr),
  m_trkY(nullptr),
  m_trkZ(nullptr),
  m_trkMomentumX(nullptr),
  m_trkMomentumY(nullptr),
  m_trkMomentumZ(nullptr),
  m_trkLoc1(nullptr),
  m_trkLoc2(nullptr)
 
 {
    declareInterface<IValidationNtupleHelperTool>(this);
    //declareProperty("IgnoreMissingTrackCovarianceForPulls", mjo_ignoreMissTrkCov = false);
}

◆ ~TrackPositionNtupleHelper()

Trk::TrackPositionNtupleHelper::~TrackPositionNtupleHelper ( )

default

Member Function Documentation

◆ addNtupleItems()

StatusCode Trk::TrackPositionNtupleHelper::addNtupleItems	(	TTree *	tree,
		const int &	detectorType )

virtual

add items to the ntuple and configure the helper tool: should be called once (per detector type) by the steering tool (Trk::ITrackValidationNtupleTool)

addNtupleItems

Implements Trk::IValidationNtupleHelperTool.

Definition at line 82 of file TrackPositionNtupleHelper.cxx.

                 {
 
    // add items
    tree->Branch("TrackX",          &m_trkX);
    tree->Branch("TrackY",          &m_trkY);
    tree->Branch("TrackZ",          &m_trkZ);
    tree->Branch("TrackMomentumX",  &m_trkMomentumX);
    tree->Branch("TrackMomentumY",  &m_trkMomentumY);
    tree->Branch("TrackMomentumZ",  &m_trkMomentumZ);
    tree->Branch("TrackLocal1",     &m_trkLoc1);
    tree->Branch("TrackLocal2",     &m_trkLoc2);
 
    ATH_MSG_VERBOSE ("added items to ntuple.");
    return StatusCode::SUCCESS;
}

◆ 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

◆ fillHoleData()

StatusCode Trk::TrackPositionNtupleHelper::fillHoleData	(	const Trk::TrackStateOnSurface &	,
		const int &	)

virtual

fill special data about holes on track (here: do nothing)

Implements Trk::IValidationNtupleHelperTool.

Definition at line 170 of file TrackPositionNtupleHelper.cxx.

                    {
    // we do nothing with holes
    return StatusCode::SUCCESS;
}

◆ fillMeasurementData()

StatusCode Trk::TrackPositionNtupleHelper::fillMeasurementData	(	const Trk::MeasurementBase *	,
		const Trk::TrackParameters *	trkPar,
		const int &	detectorType,
		const bool &	isOutlier )

virtual

fill hit position data

Implements Trk::IValidationNtupleHelperTool.

Definition at line 103 of file TrackPositionNtupleHelper.cxx.

                           {
 
    if (!trkPar) {
        m_trkX->push_back( s_errorEntry );
        m_trkY->push_back( s_errorEntry );
        m_trkZ->push_back( s_errorEntry );
        m_trkMomentumX->push_back( s_errorEntry );
        m_trkMomentumY->push_back( s_errorEntry );
        m_trkMomentumZ->push_back( s_errorEntry );
        m_trkLoc1->push_back( s_errorEntry );
        m_trkLoc2->push_back( s_errorEntry );
        if (!isOutlier) {
            // outliers usually have no track parameters, so do not warn for them!
            if(!m_trkParametersWarning) {
                // warn once only!
                ATH_MSG_WARNING ("No TrackParameters: Track positions cannot be filled (filling dummy values).");
                ATH_MSG_WARNING ("   This is possible for slimmed tracks; if track positions are needed choose another track collection");
                ATH_MSG_WARNING ("   (further warnings will be suppressed)");
                m_trkParametersWarning = true;
            }
        }
        return StatusCode::SUCCESS;
    } // end if (!trkPar)
 
    //--------------------------
    // track position info
 
    // get local and global parameters of the track state
    Amg::Vector2D lp  = trkPar->localPosition();
 
    const Amg::Vector3D& gmom = trkPar->momentum();
    const Amg::Vector3D& gpos = trkPar->position();
    
    m_trkX->push_back( float(gpos.x()) );
    m_trkY->push_back( float(gpos.y()) );
    m_trkZ->push_back( float(gpos.z()) );
    m_trkMomentumX->push_back( float(gmom.x()) );
    m_trkMomentumY->push_back( float(gmom.y()) );
    m_trkMomentumZ->push_back( float(gmom.z()) );
 
    m_trkLoc1->push_back( float(lp[Trk::locX]) );
    m_trkLoc2->push_back( float(lp[Trk::locY]) );
 
    return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode Trk::TrackPositionNtupleHelper::finalize ( )

finalize

Definition at line 63 of file TrackPositionNtupleHelper.cxx.

                                                  {
 
  delete         m_trkX;
  delete         m_trkY;
  delete         m_trkZ;
  delete m_trkMomentumX;
  delete m_trkMomentumY;
  delete m_trkMomentumZ;
  delete      m_trkLoc1;
  delete      m_trkLoc2;
 
  ATH_MSG_INFO ("finalize() successful in " << name() );
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::TrackPositionNtupleHelper::initialize ( )

initialize

Definition at line 46 of file TrackPositionNtupleHelper.cxx.

                                                    {
 
    m_trkX          = new std::vector<float>();
    m_trkY          = new std::vector<float>();
    m_trkZ          = new std::vector<float>();
    m_trkMomentumX  = new std::vector<float>();
    m_trkMomentumY  = new std::vector<float>();
    m_trkMomentumZ  = new std::vector<float>();
    m_trkLoc1       = new std::vector<float>();
    m_trkLoc2       = new std::vector<float>();
 
    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::IValidationNtupleHelperTool::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 76 of file IValidationNtupleHelperTool.h.

                                                                      {
    return IID_IValidationNtupleHelperTool;
}

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

◆ resetVariables()

StatusCode Trk::TrackPositionNtupleHelper::resetVariables ( const int & detectorType )

virtual

reset ntuple variables

Implements Trk::IValidationNtupleHelperTool.

Definition at line 155 of file TrackPositionNtupleHelper.cxx.

                      {
    m_trkX->clear();
    m_trkY->clear();
    m_trkZ->clear();
    m_trkMomentumX->clear();
    m_trkMomentumY->clear();
    m_trkMomentumZ->clear();
    m_trkLoc1->clear();
    m_trkLoc2->clear();
 
    return StatusCode::SUCCESS;
}

◆ 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 >, and AthCheckedComponent<::AthAlgTool >.

◆ 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_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_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_trkLoc1

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkLoc1

private

local position 1st coord.

of track intersecting meas't surface

Definition at line 81 of file TrackPositionNtupleHelper.h.

◆ m_trkLoc2

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkLoc2

private

local position 2nd coord.

of track intersecting meas't surface

Definition at line 82 of file TrackPositionNtupleHelper.h.

◆ m_trkMomentumX

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkMomentumX

private

global momentum X of track at measurement

Definition at line 78 of file TrackPositionNtupleHelper.h.

◆ m_trkMomentumY

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkMomentumY

private

global momentum Y of track at measurement

Definition at line 79 of file TrackPositionNtupleHelper.h.

◆ m_trkMomentumZ

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkMomentumZ

private

global momentum Z of track at measurement

Definition at line 80 of file TrackPositionNtupleHelper.h.

◆ m_trkParametersWarning

bool Trk::TrackPositionNtupleHelper::m_trkParametersWarning

private

warn only once if no track pars exist

Definition at line 73 of file TrackPositionNtupleHelper.h.

◆ m_trkX

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkX

private

global position X of track intersecting meas't surface

Definition at line 75 of file TrackPositionNtupleHelper.h.

◆ m_trkY

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkY

private

global position Y of track intersecting meas't surface

Definition at line 76 of file TrackPositionNtupleHelper.h.

◆ m_trkZ

std::vector<float>* Trk::TrackPositionNtupleHelper::m_trkZ

private

global position Z of track intersection meas't surface

Definition at line 77 of file TrackPositionNtupleHelper.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

◆ TrackPositionNtupleHelper()

◆ ~TrackPositionNtupleHelper()

Member Function Documentation

◆ addNtupleItems()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ fillHoleData()

◆ fillMeasurementData()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ resetVariables()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_trkLoc1

◆ m_trkLoc2

◆ m_trkMomentumX

◆ m_trkMomentumY

◆ m_trkMomentumZ

◆ m_trkParametersWarning

◆ m_trkX

◆ m_trkY

◆ m_trkZ

◆ m_varHandleArraysDeclared

◆ m_vhka