TGC-specific tool to calculate hit residual and pull from a RIO_OnTrack/TrackParameter pair. More...

#include <TGC_ResidualPullCalculator.h>

Inheritance diagram for Muon::TGC_ResidualPullCalculator:

Collaboration diagram for Muon::TGC_ResidualPullCalculator:

Public Member Functions
	TGC_ResidualPullCalculator (const std::string &, const std::string &, const IInterface *)

virtual	~TGC_ResidualPullCalculator ()=default

virtual StatusCode	initialize () override

virtual std::optional< Trk::ResidualPull >	residualPull (const Trk::MeasurementBase measurement, const Trk::TrackParameters trkPar, const Trk::ResidualPull::ResidualType, const Trk::TrackState::MeasurementType) const override
	This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state. More...

virtual std::array< double, 5 >	residuals (const Trk::MeasurementBase measurement, const Trk::TrackParameters trkPar, const Trk::ResidualPull::ResidualType, const Trk::TrackState::MeasurementType) const override
	This function is a light-weight version of the function above, designed for track fitters where speed is critical. More...

virtual std::optional< Trk::ResidualPull >	residualPull (const Trk::MeasurementBase , const Trk::TrackParameters , const Trk::ResidualPull::ResidualType, const Trk::TrackState::MeasurementType, const std::vector< const Trk::AlignmentEffectsOnTrack * > &) const
	This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state, and the Alignment effects. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Interface ID, declared here, and defined below. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
double	calcPull (const double residual, const double locMesCov, const double locTrkCov, const Trk::ResidualPull::ResidualType &) const
	internal structuring: common code for calculating hit pulls More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

TGC-specific tool to calculate hit residual and pull from a RIO_OnTrack/TrackParameter pair.

Uses Muon-specific info to code the strip type (measuring phi/eta) in the 2nd coordinate of the residual and to un-do the rotation from strip to chamber system. That is, the residual and pull is calculated in the direction perpendicular to the strip allowing e.g. a validation of the strip errors.

Author: Wolfgang Liebig http://consult.cern.ch/xwho/people/54608

Definition at line 31 of file TGC_ResidualPullCalculator.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

◆ TGC_ResidualPullCalculator()

Muon::TGC_ResidualPullCalculator::TGC_ResidualPullCalculator	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 14 of file TGC_ResidualPullCalculator.cxx.

                                                                                                                       :
     AthAlgTool(t,n,p) {
   declareInterface<IResidualPullCalculator>(this);
 }

◆ ~TGC_ResidualPullCalculator()

virtual Muon::TGC_ResidualPullCalculator::~TGC_ResidualPullCalculator ( )

virtualdefault

Member Function Documentation

◆ calcPull()

double Muon::TGC_ResidualPullCalculator::calcPull	(	const double	residual,
		const double	locMesCov,
		const double	locTrkCov,
		const Trk::ResidualPull::ResidualType &	resType
	)		const

private

internal structuring: common code for calculating hit pulls

calc pull in 1 dimension

Definition at line 223 of file TGC_ResidualPullCalculator.cxx.

                                                        {
     if( locMesCov < 0 ) {
       ATH_MSG_DEBUG("Bad error " << locMesCov << "  " << locTrkCov << " using measured error ");
       return 0;
     }
     double ErrorSum;
     if (resType == Trk::ResidualPull::Unbiased) {
       if( locMesCov + locTrkCov > 0 ) ErrorSum = std::sqrt(locMesCov + locTrkCov);
       else{
     ATH_MSG_DEBUG("Bad error measurement " << locMesCov << "  from track " << locTrkCov << ", using measured error ");
         ErrorSum = std::sqrt(locMesCov);
       }
     } else if (resType == Trk::ResidualPull::Biased) {
         if ((locMesCov - locTrkCov) < 0.) {
             return 0;
         }
         ErrorSum = std::sqrt(locMesCov - locTrkCov);
     } else ErrorSum = std::sqrt(locMesCov);
     if (ErrorSum != 0) return residual/ErrorSum;
     return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & 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; }

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { 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 Muon::TGC_ResidualPullCalculator::initialize ( )

overridevirtual

Definition at line 21 of file TGC_ResidualPullCalculator.cxx.

 {
   ATH_CHECK(m_idHelperSvc.retrieve());
   ATH_MSG_DEBUG ("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::IResidualPullCalculator::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 84 of file IResidualPullCalculator.h.

                                                                   {
     return IID_IResidualPullCalculator;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

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

◆ residualPull() [1/2]

virtual std::optional<Trk::ResidualPull> Trk::IResidualPullCalculator::residualPull	(	const Trk::MeasurementBase *	,
		const Trk::TrackParameters *	,
		const Trk::ResidualPull::ResidualType	,
		const Trk::TrackState::MeasurementType	,
		const std::vector< const Trk::AlignmentEffectsOnTrack * > &
	)		const

inlinevirtualinherited

This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state, and the Alignment effects.

The track state can be an unbiased one (which can be retrieved by the Trk::IUpdator), a biased one (which contains the measurement), or a truth state. The enum residualTyp must be set according to this, otherwise the pulls will be wrong. Residuals differ in all three cases; please be aware of this.

This function determines the sub-detector type itself by using the ID helper

Reimplemented in Trk::ResidualPullCalculator.

Definition at line 64 of file IResidualPullCalculator.h.

                                                                    {
       return std::nullopt;
     }

◆ residualPull() [2/2]

std::optional< Trk::ResidualPull > Muon::TGC_ResidualPullCalculator::residualPull	(	const Trk::MeasurementBase *	measurement,
		const Trk::TrackParameters *	trkPar,
		const Trk::ResidualPull::ResidualType	resType,
		const Trk::TrackState::MeasurementType
	)		const

overridevirtual

This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state.

The track state can be an unbiased one (which can be retrieved by the Trk::IUpdator), a biased one (which contains the measurement), or a truth state. The enum ResidualType must be set according to this, otherwise the pulls will be wrong. Residuals differ in all three cases; please be aware of this!!!

Implements Trk::IResidualPullCalculator.

Definition at line 98 of file TGC_ResidualPullCalculator.cxx.

                                               {
  
   const Trk::RIO_OnTrack* rot = dynamic_cast<const Trk::RIO_OnTrack*>(measurement);
   if (!rot) {
     const Muon::CompetingMuonClustersOnTrack* muonCompClusters =
       dynamic_cast<const Muon::CompetingMuonClustersOnTrack*>(measurement);
     if (muonCompClusters) rot = muonCompClusters->containedROTs().empty() ? nullptr :
       muonCompClusters->containedROTs().front();
   }
   if (!trkPar || !rot) {
     if( !trkPar ) ATH_MSG_WARNING ("No TrackParameters, cannot calculate residual/pull ");
     if( !rot )    ATH_MSG_WARNING ("No ROT, cannot calculate residual/pull ");
     return std::nullopt;
   }
   Identifier ID = rot->identify();
  
   if( m_idHelperSvc->isTgc(ID) ) {
  
     // try to cast the track parameters to measured ones
     const AmgSymMatrix(5)* trkCov = trkPar->covariance();
     bool pullIsValid = (trkCov);
  
     double sinAlpha = 0.0;
  
     bool isStrip = m_idHelperSvc->tgcIdHelper().isStrip(ID);
  
     // calculate residual
     std::vector<double> residual(1);
     std::vector<double> pull(1);
     if (isStrip) {
       // consistency check that Muon EDM is as expected
       if (measurement->localParameters().parameterKey() !=3) {
         ATH_MSG_WARNING ( "TGC ClusterOnTrack does not carry the expected "
                           << "LocalParameters structure!");
         return std::nullopt;
       }
       // get orientation angle of strip to rotate back from local frame to strip
       const Amg::MatrixX &covmat=measurement->localCovariance();
       double v0=0.5*(covmat(0,0)+covmat(1,1)-sqrt((covmat(0,0)+covmat(1,1))*(covmat(0,0)+covmat(1,1))-
                             4*(covmat(0,0)*covmat(1,1)-covmat(0,1)*covmat(0,1))));
       double v1=0.5*(covmat(0,0)+covmat(1,1)+sqrt((covmat(0,0)+covmat(1,1))*(covmat(0,0)+covmat(1,1))-
                             4*(covmat(0,0)*covmat(1,1)-covmat(0,1)*covmat(0,1))));
       sinAlpha=std::sin(0.5*std::asin(2*covmat(0,1)/(v0-v1)));
  
       const MuonGM::TgcReadoutElement *ele =
         dynamic_cast<const MuonGM::TgcReadoutElement*>(rot->detectorElement());
       if (!ele) {
         ATH_MSG_WARNING ("Could not obtain TGC detEl from TGC ROT, this is a bug!" );
         return std::nullopt;
       }
  
       double cosAlpha = std::sqrt(1 - sinAlpha*sinAlpha);
  
       // Calculate Residual for hit: res = (vec(x_hit) - vec(x_track)) * vec(n_perpendicular)
       residual[Trk::loc1] =
     (measurement->localParameters()[Trk::locX] - trkPar->parameters()[Trk::locX]) * cosAlpha
     + (measurement->localParameters()[Trk::locY] - trkPar->parameters()[Trk::locY]) * sinAlpha;
  
       // Fill transformation matrix to transform covariance matrices
       Amg::MatrixX RotMat(2,2);
       RotMat(0,0) = cosAlpha;
       RotMat(0,1) = sinAlpha;
       RotMat(1,0) = -sinAlpha;
       RotMat(1,1) = cosAlpha;
       // get the covariance matrix of the ROT and rotate it by stereo angle
       Amg::MatrixX transformedROTCov = measurement->localCovariance().similarity(RotMat);
  
       if (pullIsValid) {
         // Get local error matrix for track to calc pull
         // Just use first local coordinates
         // and rotate by the stereo angle
         Amg::MatrixX subm = trkCov->block<2,2>(0,0);
         Amg::MatrixX transformedTrkCov = subm.similarity(RotMat);
         // calc pull now
         pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                    transformedROTCov(0,0),
                                    transformedTrkCov(0,0),
                                    resType);
       } else {
         pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                    transformedROTCov(0,0),
                                    0.,
                                    resType);
       }
  
     } else {
       if (measurement->localParameters().parameterKey() != 1) {
         ATH_MSG_WARNING ("TGC ClusterOnTrack does not carry the expected "
                          << "LocalParameters structure!" );
         return std::nullopt;
       } else {
         // convention to be interpreted by TrkValTools: 2nd coordinate codes orientation of TGC
         residual[Trk::loc1] = measurement->localParameters()[Trk::loc1]
           - trkPar->parameters()[Trk::loc1];
         // calculate pull
         if (pullIsValid)
           pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                      measurement->localCovariance()(Trk::loc1,Trk::loc1),
                                      (*trkCov)(Trk::loc1,Trk::loc1),
                                      resType);
         else
           pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                      measurement->localCovariance()(Trk::loc1,Trk::loc1),
                                      0,
                                      resType);
       }
     }
     // create the Trk::ResidualPull.
     ATH_MSG_VERBOSE ( "Calculating Pull for channel " << m_idHelperSvc->toString(ID) << " residual " << residual[Trk::loc1] << " pull " << pull[Trk::loc1] );
  
     return std::make_optional<Trk::ResidualPull>(std::move(residual), std::move(pull), pullIsValid, resType, 1, sinAlpha);
  
   } else {
     ATH_MSG_DEBUG ( "Input problem measurement is not TGC." );
     return std::nullopt;
   }
 }

◆ residuals()

std::array< double, 5 > Muon::TGC_ResidualPullCalculator::residuals	(	const Trk::MeasurementBase *	measurement,
		const Trk::TrackParameters *	trkPar,
		const Trk::ResidualPull::ResidualType	,
		const Trk::TrackState::MeasurementType
	)		const

overridevirtual

This function is a light-weight version of the function above, designed for track fitters where speed is critical.

Implements Trk::IResidualPullCalculator.

Definition at line 30 of file TGC_ResidualPullCalculator.cxx.

                                               {
   std::array<double,5> residuals{};
   const Trk::RIO_OnTrack* rot = dynamic_cast<const Trk::RIO_OnTrack*>(measurement);
   if (!rot) {
     const Muon::CompetingMuonClustersOnTrack* muonCompClusters =
       dynamic_cast<const Muon::CompetingMuonClustersOnTrack*>(measurement);
     if (muonCompClusters) rot = muonCompClusters->containedROTs().empty() ? nullptr :
       muonCompClusters->containedROTs().front();
   }
   if (!trkPar || !rot) {
     if( !trkPar ) ATH_MSG_WARNING ("No TrackParameters, cannot calculate residual/pull ");
     if( !rot )    ATH_MSG_WARNING ("No ROT, cannot calculate residual/pull ");
     return residuals;
   }
   Identifier ID = rot->identify();
  
   if( m_idHelperSvc->isTgc(ID) ) {
  
     double sinAlpha = 0.0;
  
     bool isStrip = m_idHelperSvc->tgcIdHelper().isStrip(ID);
  
     // calculate residual
     if (isStrip) {
       // consistency check that Muon EDM is as expected
       if (measurement->localParameters().parameterKey() !=3) {
         ATH_MSG_WARNING ( "TGC ClusterOnTrack does not carry the expected "
                           << "LocalParameters structure!");
         return residuals;
       }
       // get orientation angle of strip to rotate back from local frame to strip
       const Amg::MatrixX &covmat=measurement->localCovariance();
       double v0=0.5*(covmat(0,0)+covmat(1,1)-sqrt((covmat(0,0)+covmat(1,1))*(covmat(0,0)+covmat(1,1))-
                             4*(covmat(0,0)*covmat(1,1)-covmat(0,1)*covmat(0,1))));
       double v1=0.5*(covmat(0,0)+covmat(1,1)+sqrt((covmat(0,0)+covmat(1,1))*(covmat(0,0)+covmat(1,1))-
                             4*(covmat(0,0)*covmat(1,1)-covmat(0,1)*covmat(0,1))));
       sinAlpha=std::sin(0.5*std::asin(2*covmat(0,1)/(v0-v1)));
  
       double cosAlpha = std::sqrt(1 - sinAlpha*sinAlpha);
  
       // Calculate Residual for hit: res = (vec(x_hit) - vec(x_track)) * vec(n_perpendicular)
       residuals[Trk::loc1] =
     (measurement->localParameters()[Trk::locX] - trkPar->parameters()[Trk::locX]) * cosAlpha
     + (measurement->localParameters()[Trk::locY] - trkPar->parameters()[Trk::locY]) * sinAlpha;
  
     } else {
       if (measurement->localParameters().parameterKey() != 1) {
         ATH_MSG_WARNING ("TGC ClusterOnTrack does not carry the expected "
                          << "LocalParameters structure!" );
         return residuals;
       } else {
         // convention to be interpreted by TrkValTools: 2nd coordinate codes orientation of TGC
         residuals[Trk::loc1] = measurement->localParameters()[Trk::loc1]
           - trkPar->parameters()[Trk::loc1];
       }
     }
   } else {
     ATH_MSG_DEBUG ( "Input problem measurement is not TGC." );
     return residuals;
   }
   return residuals;
 }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ 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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::TGC_ResidualPullCalculator::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 68 of file TGC_ResidualPullCalculator.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

◆ TGC_ResidualPullCalculator()

◆ ~TGC_ResidualPullCalculator()

Member Function Documentation

◆ calcPull()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ residualPull() [1/2]

◆ residualPull() [2/2]

◆ residuals()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_idHelperSvc

◆ m_varHandleArraysDeclared

◆ m_vhka