Helper tool as module for the Trk::BasicValidationNtupleTool, writing information about track state with brem-like material effects. More...

#include <BremPositionNtupleHelper.h>

Inheritance diagram for Trk::BremPositionNtupleHelper:

Collaboration diagram for Trk::BremPositionNtupleHelper:

Public Member Functions
	BremPositionNtupleHelper (const std::string &, const std::string &, const IInterface *)
	~BremPositionNtupleHelper ()
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
std::vector< float > *	m_bremX
	global position X of track at estimated brem surface UNIT:mm
std::vector< float > *	m_bremY
	global position Y of track at estimated brem surface UNIT:mm
std::vector< float > *	m_bremZ
	global position Z of track at estimated brem surface UNIT:mm
std::vector< float > *	m_trkQoverP
	curvature q/p of track at brem UNIT:1/MeV
std::vector< float > *	m_thicknessInX0
	thickness of material layer at brem UNIT:fraction of X₀
std::vector< float > *	m_dna
	DNA-value q*sigma²(q/p) as additional noise term UNIT:1.
std::vector< int > *	m_dnaDirection
	DNA-direction along momentum (1) opposite (-1) or both (0) UNIT:alongP:1.
std::vector< int > *	m_trackStateIndices
	index of track state in full nHits vector
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

Helper tool as module for the Trk::BasicValidationNtupleTool, writing information about track state with brem-like material effects.

For track states with an Trk::EstimatedBremOnTrack object present it writes the brem global position, material thickness and noise adjustment. It implements only the interface passing track states. A full-track analysis can not be made with this tool, its inclusion in the TrkValTools package is therefore preliminary.

Author: Wolfgang.Liebig -at- cern.ch

Definition at line 40 of file BremPositionNtupleHelper.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

◆ BremPositionNtupleHelper()

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

Definition at line 34 of file BremPositionNtupleHelper.cxx.

        :
  AthAlgTool(t,n,p),
  //m_trkParametersWarning(false),
  m_bremX(nullptr),
  m_bremY(nullptr),
  m_bremZ(nullptr),
  m_trkQoverP(nullptr),
  m_thicknessInX0(nullptr),
  m_dna(nullptr),
  m_dnaDirection(nullptr),
  m_trackStateIndices(nullptr)
 
 {
    declareInterface<IValidationNtupleHelperTool>(this);
    //declareProperty("IgnoreMissingTrackCovarianceForPulls", mjo_ignoreMissTrkCov = false);
}

◆ ~BremPositionNtupleHelper()

Trk::BremPositionNtupleHelper::~BremPositionNtupleHelper ( )

default

Member Function Documentation

◆ addNtupleItems()

StatusCode Trk::BremPositionNtupleHelper::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 99 of file BremPositionNtupleHelper.cxx.

                 {
 
    // add items
    tree->Branch("BremEffectsX",    &m_bremX);
    tree->Branch("BremEffectsY",    &m_bremY);
    tree->Branch("BremEffectsZ",    &m_bremZ);
    tree->Branch("BremCurrentQoverP", &m_trkQoverP);
    tree->Branch("BremThicknessInX0", &m_thicknessInX0);
    tree->Branch("BremDnaValue",    &m_dna);
    tree->Branch("BremDnaDirection",&m_dnaDirection);
    tree->Branch("BremToTrackStateIndex",&m_trackStateIndices);
 
    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::BremPositionNtupleHelper::fillHoleData	(	const Trk::TrackStateOnSurface &	tsos,
		const int &	bremToTrackIndex )

virtual

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

Implements Trk::IValidationNtupleHelperTool.

Definition at line 144 of file BremPositionNtupleHelper.cxx.

                                      { // FIXME this abuses the interface even more
 
  // check if state has brem to analyse
  const Trk::MaterialEffectsBase* mEffect = tsos.materialEffectsOnTrack();
  const Trk::EstimatedBremOnTrack*  ebrot = dynamic_cast<const Trk::EstimatedBremOnTrack*>(mEffect);
  const Trk::TrackParameters*        tParameter = (tsos).trackParameters();
  if (ebrot == nullptr || tParameter == nullptr) {
    ATH_MSG_DEBUG ("Insufficient data to analyse brem. &TP=" 
                   << tParameter << " and &EB=" << ebrot);
      return StatusCode::SUCCESS;
  }
 
  const Amg::Vector3D& gmom = tParameter->momentum();
  const Amg::Vector3D& gpos = tParameter->position();
  m_bremX->push_back( float(gpos.x()) );
  m_bremY->push_back( float(gpos.y()) );
  m_bremZ->push_back( float(gpos.z()) );
  m_trkQoverP->push_back( (float) tParameter->parameters()[Trk::qOverP]);
  m_thicknessInX0->push_back((float) mEffect->thicknessInX0());
  float dna                  = gmom.mag() * sqrt(ebrot->sigmaQoverPsquared());
  m_dna->push_back(dna);
  m_dnaDirection->push_back(static_cast<int>(ebrot->searchDirection()));
  m_trackStateIndices->push_back(bremToTrackIndex);
 
  return StatusCode::SUCCESS;
}

◆ fillMeasurementData()

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

virtual

fill hit position data

Implements Trk::IValidationNtupleHelperTool.

Definition at line 120 of file BremPositionNtupleHelper.cxx.

                   {
 
    return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode Trk::BremPositionNtupleHelper::finalize ( )

finalize

Definition at line 80 of file BremPositionNtupleHelper.cxx.

                                                 {
 
  delete m_bremX;
  delete m_bremY;
  delete m_bremZ;
  delete m_trkQoverP;
  delete m_thicknessInX0;
  delete m_dna;
  delete m_dnaDirection;
  delete m_trackStateIndices;
    
  ATH_MSG_INFO ("finalize() successful in " << name());
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Trk::BremPositionNtupleHelper::initialize ( )

initialize

Definition at line 62 of file BremPositionNtupleHelper.cxx.

                                                   {
 
    m_bremX          = new std::vector<float>();
    m_bremY          = new std::vector<float>();
    m_bremZ          = new std::vector<float>();
    m_trkQoverP      = new std::vector<float>();
    m_thicknessInX0  = new std::vector<float>();
    m_dna            = new std::vector<float>();
    m_dnaDirection   = new std::vector<int>();
    m_trackStateIndices = new std::vector<int>();
 
    ATH_MSG_INFO ("initialize() successful in " << name());
    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::BremPositionNtupleHelper::resetVariables ( const int & detectorType )

virtual

reset ntuple variables

Implements Trk::IValidationNtupleHelperTool.

Definition at line 129 of file BremPositionNtupleHelper.cxx.

                      {
    m_bremX->clear();
    m_bremY->clear();
    m_bremZ->clear();
    m_trkQoverP->clear();
    m_thicknessInX0->clear();
    m_dna->clear();
    m_dnaDirection->clear();
    m_trackStateIndices->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 >, 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_bremX

std::vector<float>* Trk::BremPositionNtupleHelper::m_bremX

private

global position X of track at estimated brem surface UNIT:mm

Definition at line 82 of file BremPositionNtupleHelper.h.

◆ m_bremY

std::vector<float>* Trk::BremPositionNtupleHelper::m_bremY

private

global position Y of track at estimated brem surface UNIT:mm

Definition at line 83 of file BremPositionNtupleHelper.h.

◆ m_bremZ

std::vector<float>* Trk::BremPositionNtupleHelper::m_bremZ

private

global position Z of track at estimated brem surface UNIT:mm

Definition at line 84 of file BremPositionNtupleHelper.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_dna

std::vector<float>* Trk::BremPositionNtupleHelper::m_dna

private

DNA-value q*sigma²(q/p) as additional noise term UNIT:1.

Definition at line 87 of file BremPositionNtupleHelper.h.

◆ m_dnaDirection

std::vector<int>* Trk::BremPositionNtupleHelper::m_dnaDirection

private

DNA-direction along momentum (1) opposite (-1) or both (0) UNIT:alongP:1.

Definition at line 88 of file BremPositionNtupleHelper.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_thicknessInX0

std::vector<float>* Trk::BremPositionNtupleHelper::m_thicknessInX0

private

thickness of material layer at brem UNIT:fraction of X₀

Definition at line 86 of file BremPositionNtupleHelper.h.

◆ m_trackStateIndices

std::vector<int>* Trk::BremPositionNtupleHelper::m_trackStateIndices

private

index of track state in full nHits vector

Definition at line 89 of file BremPositionNtupleHelper.h.

◆ m_trkQoverP

std::vector<float>* Trk::BremPositionNtupleHelper::m_trkQoverP

private

curvature q/p of track at brem UNIT:1/MeV

Definition at line 85 of file BremPositionNtupleHelper.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

◆ BremPositionNtupleHelper()

◆ ~BremPositionNtupleHelper()

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_bremX

◆ m_bremY

◆ m_bremZ

◆ m_detStore

◆ m_dna

◆ m_dnaDirection

◆ m_evtStore

◆ m_thicknessInX0

◆ m_trackStateIndices

◆ m_trkQoverP

◆ m_varHandleArraysDeclared

◆ m_vhka