This validation tool writes information about Trk::CompetingRIOsOnTrack into an ntuple. More...

#include <DAF_ValidationNtupleHelper.h>

Inheritance diagram for Trk::DAF_ValidationNtupleHelper:

Collaboration diagram for Trk::DAF_ValidationNtupleHelper:

Public Member Functions
	DAF_ValidationNtupleHelper (const std::string &, const std::string &, const IInterface *)
	~DAF_ValidationNtupleHelper ()
StatusCode	initialize ()
	initialize
StatusCode	finalize ()
	finalize
virtual StatusCode	fillMeasurementData (const Trk::MeasurementBase , const Trk::TrackParameters , const int &detectorType, const bool &isOutlier)
	fill Trk::CompetingRIOsOnTrack 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_ignoreMissTrkCov
bool	m_writeHitPositions
	jobOption: shall the positions of the contained ROTs be written?
ToolHandle< Trk::IResidualPullCalculator >	m_residualPullCalculator
	The residual and pull calculator tool.
int *	m_isUnbiased
std::vector< int > *	m_nContainedROTs
std::vector< int > *	m_indexOfMaxAssgnProb
std::vector< float > *	m_maxAssgnProb
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

Static Private Attributes
static const unsigned int	s_maxContainedROTs = 8

Detailed Description

This validation tool writes information about Trk::CompetingRIOsOnTrack into an ntuple.

Definition at line 33 of file DAF_ValidationNtupleHelper.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

◆ DAF_ValidationNtupleHelper()

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

Definition at line 35 of file DAF_ValidationNtupleHelper.cxx.

        :
AthAlgTool(t,n,p),
        m_residualPullCalculator("Trk::ResidualPullCalculator/ResidualPullCalculator"),
        m_isUnbiased(nullptr),
        m_nContainedROTs(nullptr),
        m_indexOfMaxAssgnProb(nullptr),
        m_maxAssgnProb(nullptr)
 
 
 {
    declareInterface<IValidationNtupleHelperTool>(this);
    declareProperty("IgnoreMissingTrackCovarianceForPulls", m_ignoreMissTrkCov = false,   "Do not warn, if track states do not have covariance matries when calculating pulls");
    declareProperty("WriteMeasurementPositionOfROTs",       m_writeHitPositions = true,   "Write measurement positions?");
    declareProperty("ResidualPullCalculatorTool",           m_residualPullCalculator,       "Tool to calculate residuals and pulls");
}

◆ ~DAF_ValidationNtupleHelper()

Trk::DAF_ValidationNtupleHelper::~DAF_ValidationNtupleHelper ( )

default

Member Function Documentation

◆ addNtupleItems()

StatusCode Trk::DAF_ValidationNtupleHelper::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 89 of file DAF_ValidationNtupleHelper.cxx.

                 {
 
    // retrieve item (is the used track state unbiased?) from ntuple
    TBranch* trackStatesUnbiasedBranch = tree->GetBranch("TrackStatesUnbiased");
    if (!trackStatesUnbiasedBranch) {
        ATH_MSG_ERROR ("Unable to get Branch TrackStatesUnbiased in ntuple" );
        return StatusCode::FAILURE;
    }
    void* variableAdr = static_cast<void*>(trackStatesUnbiasedBranch->GetAddress());
    if (!variableAdr) {
      ATH_MSG_ERROR ( "Unable to get variable address of Branch TrackStatesUnbiased" );
      return StatusCode::FAILURE;
    }
    ATH_MSG_VERBOSE ("Address of variable: " << variableAdr);
    m_isUnbiased = static_cast<int*>(variableAdr);
 
    // add items
    m_nContainedROTs        = new std::vector<int>();
    m_indexOfMaxAssgnProb   = new std::vector<int>();
    m_maxAssgnProb          = new std::vector<float>();
    tree->Branch("CompROTnContainedROTs",       &m_nContainedROTs);         // number of contained ROTs in the CompetingRIOsOnTrack (1-dim array: CompROTnContainedROTs[nHits])
    tree->Branch("CompROTindexOfMaxAssgnProb",  &m_indexOfMaxAssgnProb);    // index of the ROT with the maximum assignment probability
    tree->Branch("CompROTmaxAssgnProb",         &m_maxAssgnProb);           // maximum assignment probability
 
    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::DAF_ValidationNtupleHelper::fillHoleData	(	const Trk::TrackStateOnSurface &	,
		const int &	)

virtual

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

Implements Trk::IValidationNtupleHelperTool.

Definition at line 167 of file DAF_ValidationNtupleHelper.cxx.

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

◆ fillMeasurementData()

StatusCode Trk::DAF_ValidationNtupleHelper::fillMeasurementData	(	const Trk::MeasurementBase *	measurement,
		const Trk::TrackParameters *	trkParameters,
		const int &	detectorType,
		const bool &	isOutlier )

virtual

fill Trk::CompetingRIOsOnTrack data

fill CompetingRIOsOnTrack data

Implements Trk::IValidationNtupleHelperTool.

Definition at line 123 of file DAF_ValidationNtupleHelper.cxx.

                           {
 
    if (isOutlier) {
        // we do nothing for outliers, because competing ROTs are no outliers by definition
        return StatusCode::SUCCESS;
    }
    if (!trkParameters) {
      ATH_MSG_ERROR ( "no TrackParameters given" );
      return StatusCode::FAILURE;
    }
 
    const Trk::CompetingRIOsOnTrack* comprot = dynamic_cast<const Trk::CompetingRIOsOnTrack*>(measurement);
    if (comprot) {
        ATH_MSG_VERBOSE ( "measurement is CompetingRIOsOnTrack, fill ntuple variables" );
        //--------------------------
        // status info about compROT
        m_nContainedROTs->push_back(comprot->numberOfContainedROTs());
        unsigned int indexOfMaxAssgnProb =  comprot->indexOfMaxAssignProb();
        m_indexOfMaxAssgnProb->push_back(indexOfMaxAssgnProb);
        m_maxAssgnProb->push_back(comprot->assignmentProbability(indexOfMaxAssgnProb));
 
    } else {
      m_nContainedROTs->push_back(0);
      m_indexOfMaxAssgnProb->push_back(0);
      m_maxAssgnProb->push_back(0.);
      ATH_MSG_VERBOSE ( "measurement is not a CompetingRIOsOnTrack, ignore it");
    }
    return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode Trk::DAF_ValidationNtupleHelper::finalize ( )

finalize

Definition at line 80 of file DAF_ValidationNtupleHelper.cxx.

                                                   {
    ATH_MSG_INFO ( "finalize() successful in " << name() );
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::DAF_ValidationNtupleHelper::initialize ( )

initialize

Definition at line 63 of file DAF_ValidationNtupleHelper.cxx.

                                                     {
 
    StatusCode sc;
 
    // get the ResidualPullCalculator
    sc = m_residualPullCalculator.retrieve();
    if (sc.isFailure()) {
        ATH_MSG_FATAL ("Could not retrieve "<< m_residualPullCalculator <<" (to calculate residuals and pulls) " );
        return sc;
    }
 
    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::DAF_ValidationNtupleHelper::resetVariables ( const int & detectorType )

virtual

reset ntuple variables

Implements Trk::IValidationNtupleHelperTool.

Definition at line 159 of file DAF_ValidationNtupleHelper.cxx.

                      {
    m_nContainedROTs->clear();
    m_indexOfMaxAssgnProb->clear();
    m_maxAssgnProb->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_ignoreMissTrkCov

bool Trk::DAF_ValidationNtupleHelper::m_ignoreMissTrkCov

private

Definition at line 72 of file DAF_ValidationNtupleHelper.h.

◆ m_indexOfMaxAssgnProb

std::vector<int>* Trk::DAF_ValidationNtupleHelper::m_indexOfMaxAssgnProb

private

Definition at line 80 of file DAF_ValidationNtupleHelper.h.

◆ m_isUnbiased

int* Trk::DAF_ValidationNtupleHelper::m_isUnbiased

private

Definition at line 77 of file DAF_ValidationNtupleHelper.h.

◆ m_maxAssgnProb

std::vector<float>* Trk::DAF_ValidationNtupleHelper::m_maxAssgnProb

private

Definition at line 81 of file DAF_ValidationNtupleHelper.h.

◆ m_nContainedROTs

std::vector<int>* Trk::DAF_ValidationNtupleHelper::m_nContainedROTs

private

Definition at line 79 of file DAF_ValidationNtupleHelper.h.

◆ m_residualPullCalculator

ToolHandle<Trk::IResidualPullCalculator> Trk::DAF_ValidationNtupleHelper::m_residualPullCalculator

private

The residual and pull calculator tool.

Definition at line 74 of file DAF_ValidationNtupleHelper.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.

◆ m_writeHitPositions

bool Trk::DAF_ValidationNtupleHelper::m_writeHitPositions

private

jobOption: shall the positions of the contained ROTs be written?

Definition at line 73 of file DAF_ValidationNtupleHelper.h.

◆ s_maxContainedROTs

const unsigned int Trk::DAF_ValidationNtupleHelper::s_maxContainedROTs = 8

staticprivate

Definition at line 71 of file DAF_ValidationNtupleHelper.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

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ DAF_ValidationNtupleHelper()

◆ ~DAF_ValidationNtupleHelper()

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_ignoreMissTrkCov

◆ m_indexOfMaxAssgnProb

◆ m_isUnbiased

◆ m_maxAssgnProb

◆ m_nContainedROTs

◆ m_residualPullCalculator

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeHitPositions

◆ s_maxContainedROTs