Rec::MuidTrackIsolation Class Reference

#include <MuidTrackIsolation.h>

Inheritance diagram for Rec::MuidTrackIsolation:

Collaboration diagram for Rec::MuidTrackIsolation:

Public Member Functions
	MuidTrackIsolation (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~MuidTrackIsolation (void)=default
StatusCode	initialize () override
std::pair< int, double >	trackIsolation (const EventContext &ctx, double eta, double phi) const override
	IMuidTrackIsolation interface: get the number of tracks and summed momentum in a cone at the production vertex or around the muon calo intersect.
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 ()
	AlgTool and IAlgTool interface methods.

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
std::pair< int, double >	trackVertex (const TrackCollection *indetTracks, double eta, double phi) const
std::pair< int, double >	trackExtrapolated (const TrackCollection *indetTracks, double eta, double phi) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
double	m_barrelCotTheta {}
std::unique_ptr< const Trk::Surface >	m_caloBackwardDisc
std::unique_ptr< const Trk::Surface >	m_caloCylinder
std::unique_ptr< const Trk::Surface >	m_caloForwardDisc
double	m_etaSafetyFactor
SG::ReadHandleKey< TrackCollection >	m_inDetTracksLocation {this, "InDetTracksLocation", "Tracks", "ID tracks"}
ToolHandle< Trk::IIntersector >	m_intersector {this, "RungeKuttaIntersector", "Trk::RungeKuttaIntersector/RungeKuttaIntersector"}
Gaudi::Property< double >	m_minPt {this, "MinPt", 1.0 * Gaudi::Units::GeV}
Gaudi::Property< double >	m_trackCone {this, "TrackCone", 0.2}
double	m_trackCone2 {0.}
Gaudi::Property< bool >	m_trackExtrapolation {this, "TrackExtrapolation", false}
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

Definition at line 30 of file MuidTrackIsolation.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

MuidTrackIsolation()

MuidTrackIsolation::MuidTrackIsolation	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 28 of file MuidTrackIsolation.cxx.

                                                                                                                 :
        AthAlgTool(type, name, parent), m_etaSafetyFactor(0.1) {
        declareInterface<IMuidTrackIsolation>(this);
    }

~MuidTrackIsolation()

virtual Rec::MuidTrackIsolation::~MuidTrackIsolation ( void )

virtualdefault

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.

{ 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

initialize()

StatusCode MuidTrackIsolation::initialize ( )

override

Definition at line 35 of file MuidTrackIsolation.cxx.

                                              {
        ATH_MSG_INFO("MuidTrackIsolation::initialize()");
 
        // get the Tools
        ATH_CHECK(m_intersector.retrieve());
        m_trackCone2 = m_trackCone * m_trackCone;
        // create the calo barrel surfaces (cylinder) and 2 endcap discs)
        double radius = 2.0 * Gaudi::Units::meter;
        double halfLength = 4.0 * Gaudi::Units::meter;
        Amg::Transform3D transform;
        transform.setIdentity();
        m_caloCylinder = std::make_unique<Trk::CylinderSurface>(transform, radius, halfLength);
 
        // the corresponding max barrel cotTheta
        m_barrelCotTheta = halfLength / radius;
 
        // and the forward/backward endcap disks
        Amg::Transform3D discRotation;
        discRotation.setIdentity();
        Amg::Vector3D forwardDiscPosition(0., 0., halfLength);
        auto transform1 = std::make_unique<Amg::Transform3D>(discRotation * forwardDiscPosition);
        m_caloForwardDisc = std::make_unique<Trk::DiscSurface>(*transform1, 0., radius);
        Amg::Vector3D backwardDiscPosition(0., 0., -halfLength);
        auto transform2 = std::make_unique<Amg::Transform3D>(discRotation * backwardDiscPosition);
        m_caloBackwardDisc = std::make_unique<Trk::DiscSurface>(*transform2, 0., radius);
 
        ATH_CHECK(m_inDetTracksLocation.initialize());
 
        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 & Rec::IMuidTrackIsolation::interfaceID ( )

inlinestaticinherited

AlgTool and IAlgTool interface methods.

Interface ID for IMuidTrackIsolation

Definition at line 34 of file IMuidTrackIsolation.h.

                                                { 
            static const InterfaceID IID_IMuidTrackIsolation("IMuidTrackIsolation", 1, 0);
            return IID_IMuidTrackIsolation;
        }

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

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.

trackExtrapolated()

std::pair< int, double > MuidTrackIsolation::trackExtrapolated ( const TrackCollection * indetTracks, double eta, double phi ) const

private

Use identiy of cot (x) = tan( pi/2 - x)

Definition at line 135 of file MuidTrackIsolation.cxx.

                                                                                                                               {
        // set initial state
        double sumP = 0.;
        int numberTracks = 0;
 
        // extrapolate close in eta tracks to calorimeter surface
        for (const Trk::Track* id : *inDetTracks) {
            const Trk::Perigee& perigee = *id->perigeeParameters();
            if (id->info().trackProperties(Trk::TrackInfo::StraightTrack) || perigee.pT() < m_minPt) continue;
 
            double inDetEta = perigee.eta();
            if (std::abs(eta - inDetEta) > m_trackCone + m_etaSafetyFactor) continue;
 
            // track has sufficient momentum and is close in eta:
            // find intersection at calo surface
            double qOverP = perigee.parameters()[Trk::qOverP];
            double cotTheta = std::tan(M_PI_2 - perigee.parameters()[Trk::theta]);
            Amg::Vector3D direction(std::cos(perigee.parameters()[Trk::phi]), std::sin(perigee.parameters()[Trk::phi]), cotTheta);
            direction /= direction.mag();
 
            const Trk::TrackSurfaceIntersection idIntersection(perigee.position(), direction, 0.);
            const Trk::Surface* surface = m_caloCylinder.get();
            if (cotTheta > m_barrelCotTheta) {
                surface = m_caloForwardDisc.get();
            } else if (cotTheta < -m_barrelCotTheta) {
                surface = m_caloBackwardDisc.get();
            }
            std::optional<Trk::TrackSurfaceIntersection> caloIntersection(
                m_intersector->intersectSurface(*surface, idIntersection, qOverP));
 
            // no intersection - should never happen !
            if (!caloIntersection) {
                ATH_MSG_DEBUG(" track didn't find intersection !!! "
                              << std::setiosflags(std::ios::fixed) << " Id track: momentum " << std::setw(8) << std::setprecision(1)
                              << perigee.momentum().mag() / Gaudi::Units::GeV << "  with initial eta " << std::setw(8)
                              << std::setprecision(3) << perigee.eta() << "  and phi " << std::setw(8) << std::setprecision(3)
                              << perigee.parameters()[Trk::phi]);
 
                continue;
            }
 
            double diffEta = eta - caloIntersection->position().eta();
            double diffPhi = xAOD::P4Helpers::deltaPhi(phi, caloIntersection->position().phi());
            ATH_MSG_VERBOSE(std::endl
                            << std::setiosflags(std::ios::fixed) << " Id track: momentum " << std::setw(8) << std::setprecision(1)
                            << perigee.momentum().mag() / Gaudi::Units::GeV << "  with initial,extrapolated and calo difference for eta "
                            << std::setw(8) << std::setprecision(3) << perigee.eta() << std::setw(8) << std::setprecision(3)
                            << caloIntersection->position().eta() << std::setw(8) << std::setprecision(3) << diffEta << "  and phi "
                            << std::setw(8) << std::setprecision(3) << perigee.parameters()[Trk::phi] << std::setw(8)
                            << std::setprecision(3) << caloIntersection->position().phi() << std::setw(8) << std::setprecision(3)
                            << diffPhi);
 
            // check if inside cone
            if ((diffPhi * diffPhi + diffEta * diffEta) < m_trackCone2) {
                ++numberTracks;
                const double p = perigee.momentum().mag();
                sumP += p;
 
                ATH_MSG_VERBOSE("  inside cone, track#" << std::setw(3) << numberTracks);
            }
        }
 
        return std::make_pair(numberTracks, sumP);
    }

trackIsolation()

std::pair< int, double > MuidTrackIsolation::trackIsolation ( const EventContext & ctx, double eta, double phi ) const

overridevirtual

IMuidTrackIsolation interface: get the number of tracks and summed momentum in a cone at the production vertex or around the muon calo intersect.

Implements Rec::IMuidTrackIsolation.

Definition at line 65 of file MuidTrackIsolation.cxx.

                                                                                                                 {
        // debug input quantities
        ATH_MSG_DEBUG(" MuidTrackIsolation:: " << std::setiosflags(std::ios::fixed)
                                               << (m_trackExtrapolation ? "applied after extrapolation to calo, " : "applied at perigee, ")
                                               << " for muon at calo with eta,phi " << std::setw(8) << std::setprecision(3) << eta
                                               << std::setw(8) << std::setprecision(3) << phi);
 
        // set initial state
        std::pair<int, double> isolation{0, 0.};
 
        // retrieve track collection
        SG::ReadHandle<TrackCollection> inDetTracks(m_inDetTracksLocation, ctx);
        if (!inDetTracks.isPresent()) {
            ATH_MSG_DEBUG(" no ID Track container at location  " << m_inDetTracksLocation.key());
            return isolation;
        }
 
        if (!inDetTracks.isValid()) {
            ATH_MSG_WARNING(" ID Track container " << m_inDetTracksLocation.key() << " not valid!");
            return isolation;
        }
 
        // evaluate isolation according to configuration
        if (m_trackExtrapolation) {
            isolation = trackExtrapolated(inDetTracks.cptr(), eta, phi);
        } else {
            isolation = trackVertex(inDetTracks.cptr(), eta, phi);
        }
 
        // debug result
        ATH_MSG_DEBUG("Found " << isolation.first << std::setiosflags(std::ios::fixed) << " InDet tracks with total momentum "
                               << std::setw(8) << std::setprecision(1) << isolation.second / Gaudi::Units::GeV << " GeV");
 
        return isolation;
    }

trackVertex()

std::pair< int, double > MuidTrackIsolation::trackVertex ( const TrackCollection * indetTracks, double eta, double phi ) const

private

Definition at line 101 of file MuidTrackIsolation.cxx.

                                                                                                                         {
        // set initial state
        double sumP = 0.;
        int numberTracks = 0;
 
        // choose tracks in cone
        for (const Trk::Track* id : *inDetTracks) {
            const Trk::Perigee& perigee = *id->perigeeParameters();
            if (id->info().trackProperties(Trk::TrackInfo::StraightTrack) || perigee.pT() < m_minPt) continue;
 
            double inDetPhi = perigee.parameters()[Trk::phi];
            double inDetEta = perigee.eta();
 
            double diffEta = std::abs(eta - inDetEta);
            double diffPhi = xAOD::P4Helpers::deltaPhi(phi, inDetPhi);
 
            ATH_MSG_DEBUG(std::endl
                          << std::setiosflags(std::ios::fixed) << " Id track: momentum " << std::setw(8) << std::setprecision(1)
                          << perigee.momentum().mag() / Gaudi::Units::GeV << "  with perigee eta and difference " << std::setw(8)
                          << std::setprecision(3) << perigee.eta() << std::setw(8) << std::setprecision(3) << diffEta
                          << "  and same for phi " << std::setw(8) << std::setprecision(3) << perigee.parameters()[Trk::phi] << std::setw(8)
                          << std::setprecision(3) << diffPhi);
 
            if ((diffPhi * diffPhi + diffEta * diffEta) > m_trackCone2) continue;
            ++numberTracks;
            const double p = perigee.momentum().mag();
            sumP += p;
 
            ATH_MSG_VERBOSE("inside cone, track#" << std::setw(3) << numberTracks);
        }
 
        return std::make_pair(numberTracks, sumP);
    }

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_barrelCotTheta

double Rec::MuidTrackIsolation::m_barrelCotTheta {}

private

Definition at line 49 of file MuidTrackIsolation.h.

{};

m_caloBackwardDisc

std::unique_ptr<const Trk::Surface> Rec::MuidTrackIsolation::m_caloBackwardDisc

private

Definition at line 50 of file MuidTrackIsolation.h.

m_caloCylinder

std::unique_ptr<const Trk::Surface> Rec::MuidTrackIsolation::m_caloCylinder

private

Definition at line 51 of file MuidTrackIsolation.h.

m_caloForwardDisc

std::unique_ptr<const Trk::Surface> Rec::MuidTrackIsolation::m_caloForwardDisc

private

Definition at line 52 of file MuidTrackIsolation.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_etaSafetyFactor

double Rec::MuidTrackIsolation::m_etaSafetyFactor

private

Definition at line 53 of file MuidTrackIsolation.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_inDetTracksLocation

SG::ReadHandleKey<TrackCollection> Rec::MuidTrackIsolation::m_inDetTracksLocation {this, "InDetTracksLocation", "Tracks", "ID tracks"}

private

Definition at line 54 of file MuidTrackIsolation.h.

{this, "InDetTracksLocation", "Tracks", "ID tracks"};

m_intersector

ToolHandle<Trk::IIntersector> Rec::MuidTrackIsolation::m_intersector {this, "RungeKuttaIntersector", "Trk::RungeKuttaIntersector/RungeKuttaIntersector"}

private

Definition at line 56 of file MuidTrackIsolation.h.

{this, "RungeKuttaIntersector", "Trk::RungeKuttaIntersector/RungeKuttaIntersector"};

m_minPt

Gaudi::Property<double> Rec::MuidTrackIsolation::m_minPt {this, "MinPt", 1.0 * Gaudi::Units::GeV}

private

Definition at line 57 of file MuidTrackIsolation.h.

{this, "MinPt", 1.0 * Gaudi::Units::GeV};

m_trackCone

Gaudi::Property<double> Rec::MuidTrackIsolation::m_trackCone {this, "TrackCone", 0.2}

private

Definition at line 58 of file MuidTrackIsolation.h.

{this, "TrackCone", 0.2};

m_trackCone2

double Rec::MuidTrackIsolation::m_trackCone2 {0.}

private

Definition at line 59 of file MuidTrackIsolation.h.

{0.};

m_trackExtrapolation

Gaudi::Property<bool> Rec::MuidTrackIsolation::m_trackExtrapolation {this, "TrackExtrapolation", false}

private

Definition at line 60 of file MuidTrackIsolation.h.

{this, "TrackExtrapolation", false};

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:

• MuidTrackIsolation.h
• MuidTrackIsolation.cxx