Trk::TrackSlimmingTool Class Reference

A tool to produce 'slimmed' Tracks from a reference track. More...

#include <TrackSlimmingTool.h>

Inheritance diagram for Trk::TrackSlimmingTool:

Collaboration diagram for Trk::TrackSlimmingTool:

Public Member Functions
	TrackSlimmingTool (const std::string &, const std::string &, const IInterface *)
virtual	~TrackSlimmingTool ()
	default destructor
virtual StatusCode	initialize () override
	standard Athena-Algorithm method
virtual StatusCode	finalize () override
	standard Athena-Algorithm method
void	slimTrack (Trk::Track &track) const override final
	Slim a non const Track.
void	slimConstTrack (const Trk::Track &track) const override final
	Slim a const Track.
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 ()

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	setHints (const Trk::Track &track) const
	This method just set persistification Hints.
void	checkForValidMeas (const Trk::TrackStateOnSurface *tsos, bool &isIDmeas, bool &isMSmeas) const
void	findLastValidTSoS (const Trk::TrackStates *oldTrackStates, const Trk::TrackStateOnSurface *&lastValidIDTSOS, const TrackStateOnSurface *&lastValidMSTSOS) const
bool	keepParameters (const Trk::TrackStateOnSurface *TSoS, const TrackStateOnSurface *&firstValidIDTSOS, const TrackStateOnSurface *&lastValidIDTSOS, const TrackStateOnSurface *&firstValidMSTSOS, const TrackStateOnSurface *&lastValidMSTSOS) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_keepCaloDeposit
	any CaloDeposit with its adjacent MEOT's will be kept on the slimmed track (combined muon property)
bool	m_keepOutliers
	If true, Outliers will be kept on the slimmed track.
bool	m_keepParameters
	If true, the first and last parameters of ID & MS subsystems will be kept on the slimmed track.
const AtlasDetectorID *	m_detID
	atlas id helper
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

A tool to produce 'slimmed' Tracks from a reference track.

By default, this slimmed track will include all the measurements, and the Perigee parameters (currently these are assumed to exist)

Author

Edward Moyse <Edward.Moysecern.ch>

Christos Anastopoulos Athena MT modifications

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

TrackSlimmingTool()

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

Definition at line 23 of file TrackSlimmingTool.cxx.

  : AthAlgTool(t, n, p)
  , m_keepCaloDeposit(true)
  , m_keepOutliers(false)
  , m_keepParameters(false)
  , m_detID{}
{
  declareInterface<ITrackSlimmingTool>(this);
 
  //  template for property decalration
  declareProperty(
    "KeepCaloDeposit",
    m_keepCaloDeposit,
    "If this is set to true, any CaloDeposit with its adjacent MEOT's will be "
    "kept on the slimmed track (combined muon property)");
  declareProperty("KeepOutliers",
                  m_keepOutliers,
                  "If this is set to true, Outlier measurements will be kept "
                  "on the slimmed track");
  declareProperty("KeepParameters",
                  m_keepParameters,
                  "If this is set to true, the first and last parameters will "
                  "be kept on the slimmed track");
}

~TrackSlimmingTool()

Trk::TrackSlimmingTool::~TrackSlimmingTool ( )

virtualdefault

default destructor

Member Function Documentation

checkForValidMeas()

void Trk::TrackSlimmingTool::checkForValidMeas ( const Trk::TrackStateOnSurface * tsos, bool & isIDmeas, bool & isMSmeas ) const

private

Definition at line 188 of file TrackSlimmingTool.cxx.

{
  if (tsos->measurementOnTrack() != nullptr) {
    bool isPseudo = (tsos->measurementOnTrack()->type(
      Trk::MeasurementBaseType::PseudoMeasurementOnTrack));
    // Handle cROTs
    const Trk::CompetingRIOsOnTrack* cROT = nullptr;
    if (tsos->measurementOnTrack()->type(
          Trk::MeasurementBaseType::CompetingRIOsOnTrack)) {
      cROT = static_cast<const Trk::CompetingRIOsOnTrack*>(
        tsos->measurementOnTrack());
    }
    Identifier id;
    if (cROT) {
      id = cROT->rioOnTrack(cROT->indexOfMaxAssignProb()).identify();
    } else {
      id = tsos->measurementOnTrack()
             ->associatedSurface()
             .associatedDetectorElementIdentifier();
    }
    isIDmeas = !isPseudo && m_detID->is_indet(id);
    isMSmeas = tsos->measurementOnTrack() != nullptr && !isPseudo &&
               m_detID->is_muon(id);
  }
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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::TrackSlimmingTool::finalize ( )

overridevirtual

standard Athena-Algorithm method

Definition at line 70 of file TrackSlimmingTool.cxx.

{
  return StatusCode::SUCCESS;
}

findLastValidTSoS()

void Trk::TrackSlimmingTool::findLastValidTSoS ( const Trk::TrackStates * oldTrackStates, const Trk::TrackStateOnSurface *& lastValidIDTSOS, const TrackStateOnSurface *& lastValidMSTSOS ) const

private

Definition at line 217 of file TrackSlimmingTool.cxx.

{
 
  for (Trk::TrackStates::const_reverse_iterator rItTSoS =
         oldTrackStates->rbegin();
       rItTSoS != oldTrackStates->rend();
       ++rItTSoS) {
    if ((*rItTSoS)->type(TrackStateOnSurface::Measurement) &&
        (*rItTSoS)->trackParameters() != nullptr &&
        (*rItTSoS)->measurementOnTrack() != nullptr &&
        !(*rItTSoS)->measurementOnTrack()->type(
          Trk::MeasurementBaseType::PseudoMeasurementOnTrack)) {
 
      if (m_detID->is_indet((*rItTSoS)
                              ->trackParameters()
                              ->associatedSurface()
                              .associatedDetectorElementIdentifier())) {
        lastValidIDTSOS = (*rItTSoS);
        break;
      }
      if (m_detID->is_muon((*rItTSoS)
                             ->trackParameters()
                             ->associatedSurface()
                             .associatedDetectorElementIdentifier())) {
        lastValidMSTSOS = (*rItTSoS);
        break;
      }
    }
  }
}

initialize()

StatusCode Trk::TrackSlimmingTool::initialize ( )

overridevirtual

standard Athena-Algorithm method

Definition at line 52 of file TrackSlimmingTool.cxx.

{
 
  StatusCode sc = AlgTool::initialize();
  if (sc.isFailure())
    return sc;
 
  sc = detStore()->retrieve(m_detID, "AtlasID");
  if (sc.isFailure()) {
    ATH_MSG_FATAL("Could not get AtlasDetectorID ");
    return sc;
  }
  ATH_MSG_DEBUG("Found AtlasDetectorID");
 
  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::ITrackSlimmingTool::interfaceID ( )

inlinestaticinherited

Definition at line 59 of file ITrackSlimmingTool.h.

{
  return IID_ITrackSlimmingTool;
}

keepParameters()

bool Trk::TrackSlimmingTool::keepParameters ( const Trk::TrackStateOnSurface * TSoS, const TrackStateOnSurface *& firstValidIDTSOS, const TrackStateOnSurface *& lastValidIDTSOS, const TrackStateOnSurface *& firstValidMSTSOS, const TrackStateOnSurface *& lastValidMSTSOS ) const

private

Definition at line 252 of file TrackSlimmingTool.cxx.

{
 
  if (TSoS->trackParameters() != nullptr &&
      TSoS->type(TrackStateOnSurface::Perigee)) {
    return true;
  }
  // Now do checks for first/last ID/MS measurement (isIDmeas and isMSmeas)
  if (m_keepParameters) {
    bool isIDmeas = false;
    bool isMSmeas = false;
    checkForValidMeas(TSoS, isIDmeas, isMSmeas);
    // entering ID?
    if (isIDmeas && !firstValidIDTSOS &&
        TSoS->type(TrackStateOnSurface::Measurement)) {
      firstValidIDTSOS = TSoS;
      if (TSoS->trackParameters() != nullptr)
        return true;
    }
    // entering MS?
    if (isMSmeas && !firstValidMSTSOS) {
      firstValidMSTSOS = TSoS;
      if (TSoS->trackParameters() != nullptr)
        return true;
    }
    // Is this the last TSOS on the track?
    if (lastValidIDTSOS == TSoS || lastValidMSTSOS == TSoS) {
      if (TSoS->trackParameters() != nullptr)
        return true;
    }
  }
  return false;
}

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

setHints()

void Trk::TrackSlimmingTool::setHints ( const Trk::Track & track ) const

private

This method just set persistification Hints.

Definition at line 89 of file TrackSlimmingTool.cxx.

{
  const Trk::TrackStates* oldTrackStates =
    track.trackStateOnSurfaces();
  if (oldTrackStates == nullptr) {
    ATH_MSG_WARNING("Track has no TSOS vector! Skipping track, returning");
    return;
  }
 
  const TrackStateOnSurface* firstValidIDTSOS(nullptr);
  const TrackStateOnSurface* lastValidIDTSOS(nullptr);
  const TrackStateOnSurface* firstValidMSTSOS(nullptr);
  const TrackStateOnSurface* lastValidMSTSOS(nullptr);
  if (m_keepParameters) {
    // search last valid TSOS first (as won't be found in later loop)
    findLastValidTSoS(oldTrackStates, lastValidIDTSOS, lastValidMSTSOS);
  }
 
  // If m_keepParameters is true, then we want to keep the first and last
  // parameters of ID & MS.
  const Trk::MeasurementBase* rot = nullptr;
  const Trk::TrackParameters* parameters = nullptr;
  bool keepParameter = false;
  // looping over all TSOS
  Trk::TrackStates::const_iterator itTSoS =
    oldTrackStates->begin();
  for (; itTSoS != oldTrackStates->end(); ++itTSoS) {
 
    // The hints we want to create for this tsos
    std::bitset<Trk::TrackStateOnSurface::NumberOfPersistencyHints> hints{};
    //
    hints.set(Trk::TrackStateOnSurface::PartialPersistification);
    parameters = nullptr;
    rot = nullptr;
    // if requested: keep calorimeter TSOS with adjacent scatterers (on combined
    // muons)
    if (m_keepCaloDeposit &&
        (**itTSoS).type(TrackStateOnSurface::CaloDeposit)) {
      // preceding TSOS (if Scatterer)
      if (itTSoS != oldTrackStates->begin()) {
        --itTSoS;
        if ((**itTSoS).type(TrackStateOnSurface::Scatterer)) {
          hints.reset(Trk::TrackStateOnSurface::PartialPersistification);
        }
        ++itTSoS;
      }
      // copy removes CaloEnergy (just keep base EnergyLoss)
      const MaterialEffectsOnTrack* meot =
        dynamic_cast<const MaterialEffectsOnTrack*>(
          (**itTSoS).materialEffectsOnTrack());
      if (meot && meot->energyLoss()) {
        hints.set(Trk::TrackStateOnSurface::PersistifySlimCaloDeposit);
        hints.set(Trk::TrackStateOnSurface::PersistifyTrackParameters);
      }
      // following TSOS (if Scatterer)
      ++itTSoS;
      if (itTSoS != oldTrackStates->end() &&
          (**itTSoS).type(TrackStateOnSurface::Scatterer)) {
        hints.reset(Trk::TrackStateOnSurface::PartialPersistification);
      }
      --itTSoS;
    }
 
    // We only keep TSOS if they either contain a perigee, OR are a measurement
    if ((*itTSoS)->measurementOnTrack() == nullptr &&
        !(*itTSoS)->type(TrackStateOnSurface::Perigee)) {
      // pass the hints to the tsos before we continue to the next
      (*itTSoS)->setHints(hints.to_ulong());
      continue;
    }
 
    keepParameter = keepParameters((*itTSoS),
                                   firstValidIDTSOS,
                                   lastValidIDTSOS,
                                   firstValidMSTSOS,
                                   lastValidMSTSOS);
 
    if (keepParameter) {
      parameters = (*itTSoS)->trackParameters();
    }
    if ((*itTSoS)->measurementOnTrack() != nullptr &&
        ((*itTSoS)->type(TrackStateOnSurface::Measurement) ||
         (m_keepOutliers && (*itTSoS)->type(TrackStateOnSurface::Outlier)))) {
      rot = (*itTSoS)->measurementOnTrack();
    }
    if (rot != nullptr || parameters != nullptr) {
      if (rot) {
        hints.set(Trk::TrackStateOnSurface::PersistifyMeasurement);
      }
      if (parameters) {
        hints.set(Trk::TrackStateOnSurface::PersistifyTrackParameters);
      }
    }
    // pass the hints to the tsos
    (*itTSoS)->setHints(hints.to_ulong());
  }
}

slimConstTrack()

void Trk::TrackSlimmingTool::slimConstTrack ( const Trk::Track & track ) const

finaloverridevirtual

Slim a const Track.

Parameters

track

A const reference to the track to be slimmed.

The method sets persistification hints in the Track's TrackStateOnSurfaces So a slimmed version is written to disk

Same as the non-const version but does not set the SlimmedTrack property.

Implements Trk::ITrackSlimmingTool.

Definition at line 83 of file TrackSlimmingTool.cxx.

{
  setHints(track);
}

slimTrack()

void Trk::TrackSlimmingTool::slimTrack ( Trk::Track & track ) const

finaloverridevirtual

Slim a non const Track.

Parameters

track

A reference to the track to be slimmed.

The method sets persistification hints in the Track's TrackStateOnSurfaces So a slimmed version is written to disk

The properties are modified setTrackProperties(TrackInfo::SlimmedTrack);

Implements Trk::ITrackSlimmingTool.

Definition at line 76 of file TrackSlimmingTool.cxx.

{
  setHints(track);
  track.info().setTrackProperties(TrackInfo::SlimmedTrack);
}

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_detID

const AtlasDetectorID* Trk::TrackSlimmingTool::m_detID

private

atlas id helper

Definition at line 89 of file TrackSlimmingTool.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_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_keepCaloDeposit

bool Trk::TrackSlimmingTool::m_keepCaloDeposit

private

any CaloDeposit with its adjacent MEOT's will be kept on the slimmed track (combined muon property)

Definition at line 79 of file TrackSlimmingTool.h.

m_keepOutliers

bool Trk::TrackSlimmingTool::m_keepOutliers

private

If true, Outliers will be kept on the slimmed track.

Definition at line 82 of file TrackSlimmingTool.h.

m_keepParameters

bool Trk::TrackSlimmingTool::m_keepParameters

private

If true, the first and last parameters of ID & MS subsystems will be kept on the slimmed track.

Definition at line 86 of file TrackSlimmingTool.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:

• TrackSlimmingTool.h
• TrackSlimmingTool.cxx