Muon RoI class for analysis. More...

#include <Muon_ROI.h>

Inheritance diagram for Muon_ROI:

Collaboration diagram for Muon_ROI:

Public Types
enum	RoISource { Barrel , Endcap , Forward }
	RoI source enumeration. More...
enum	Hemisphere { Positive , Negative }
	RoI hemisphere enumeration. More...
enum	Charge { Neg = 0 , Pos = 1 , Undef = 100 }
	Charge sign. More...
enum	Kind { P4EETAPHIM , P4IPTCOTTHPHIM , P4PTETAPHIM , P4PXPYPZE , UNKNOWN }

Public Member Functions
	Muon_ROI (uint32_t roiWord, double eta, double phi, const std::string &thrName, double thrValue)
	Constructor used when creating the object from RoIBResult data.
	Muon_ROI ()
	Default constructor (for persistency purposes)
virtual	~Muon_ROI ()
	Destructor.
uint32_t	getROIWord () const
	Return the original 32-bit RoI word given by the LVL1 muon trigger.
float	getEta () const
	Legacy function returning the eta coordinate of the RoI.
float	getPhi () const
	Legacy function returning the phi coordinate of the RoI.
const std::string &	getThrName () const
	Return the name of the highest threshold this RoI passed.
float	getThrValue () const
	Return the value of the highest threshold this RoI passed.
int	getThrNumber () const
	Get the logic number of the highest threshold this RoI passed.
int	getRoI () const
	Get the "RoI number" (position inside the sector)
int	getSectorAddress () const
	Get the full sector address.
bool	isFirstCandidate () const
	Returns if the candidate had the highest p_T in the sector.
bool	isMoreCandInRoI () const
	Returns if there were other muons detected in the same RoI.
bool	isMoreCandInSector () const
	Returns if there were other muons detected in the same sector.
RoISource	getSource () const
	Returns the system that detected the muon candidate.
Hemisphere	getHemisphere () const
	Returns the hemisphere that detected the muon candidate.
Charge	getCharge () const
	Returns the charge sign of the muon candidate.
bool	isVetoed () const
	Returns the veto flag for the candidate.
virtual double	pt () const
	Return the value of the highest threshold this RoI passed.
virtual double	eta () const
	Return the eta coordinate of the center of the RoI.
virtual double	phi () const
	Return the phi coordinate of the center of the RoI.
virtual double	m () const
	Return the mass of the object, always 0.0 for RoIs.
virtual double	px () const
	x component of momentum
virtual double	py () const
	y component of momentum
virtual double	pz () const
	z component of momentum
virtual double	e () const
	energy
virtual double	p () const
	magnitude of 3-momentum.
virtual double	p2 () const
	square of momentum magnitude
virtual double	m2 () const
	mass squared
virtual double	et () const
	transverse energy defined to be e*sin(theta)
virtual double	iPt () const
	inverse of transverse momentum
virtual double	rapidity () const
	rapidity
virtual double	cosPhi () const
	cosinus phi
virtual double	sinPhi () const
	sinus phi
virtual double	cotTh () const
	cottan theta
virtual double	cosTh () const
	cosinus theta
virtual double	sinTh () const
	sinus theta
virtual double	tanTh () const
	tan theta
virtual CLHEP::HepLorentzVector	hlv () const
	HepLorentzVector Special implementation from Frank Paige : if negative energy, points in opposite direction but eta and phi still the same.
virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors.
virtual void	set4Mom (const I4Momentum &theI4Mom)
	set all 4-mom from another I4Momentum reference DUMMY IMPLEMENTATION
virtual void	set4Mom (const I4Momentum *const theI4Mom)
	set all 4-mom from another I4Momentum pointer DUMMY IMPLEMENTATION
virtual void	set4Mom (const CLHEP::HepLorentzVector &theHlv)
	set all 4-mom from a CLHEP HepLorentzVector DUMMY IMPLEMENTATION
I4Momentum::Kind	kind () const
	tells what kind of P4XYZT this is
virtual std::ostream &	dump (std::ostream &out) const
	Print `I4Momentum` content.
virtual void	fillToken (INavigationToken &) const
virtual void	fillToken (INavigationToken &, const std::any &) const
virtual AthenaBarCode_t	getAthenaBarCode () const
virtual void	setAthenaBarCode (AthenaBarCode_t)
virtual bool	hasSameAthenaBarCode (const IAthenaBarCode &) const
virtual bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &) const
virtual AthenaBarCodeVersion_t	getVersion () const
virtual void	newVersion ()
virtual void	setVersion (AthenaBarCodeVersion_t)

Static Public Attributes
static const AthenaBarCode_t	UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)
static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Private Attributes
uint32_t	m_roiWord
	32bit encoded ROI word
float	m_eta
	eta coordinate of RoI
float	m_phi
	phi coordinate of RoI
std::string	m_thrName
	Name of the highest threshold this RoI passed.
float	m_thrValue
	Value of the highest threshold this RoI passed.

Detailed Description

Muon RoI class for analysis.

   The RoI now inherits from INavigable4Momentum to make it easier to use
   in an analysis (especially EventView).

Author: Tadashi Maeno; Attila Krasznahorkay

Version

Revision: 1.6

Date

Date: 2008-05-08 15:00:11

See also: INavigable4Momentum

Definition at line 33 of file Muon_ROI.h.

Member Enumeration Documentation

◆ Charge

enum Muon_ROI::Charge

Charge sign.

Enumerator
Neg	Candidate is a mu- from a TGC sector.
Pos	Candidate is a mu+ from a TGC sector.
Undef	This is an RPC candidate.

Definition at line 58 of file Muon_ROI.h.

               {
      Neg = 0, 
      Pos = 1, 
      Undef = 100 
   };

◆ Hemisphere

enum Muon_ROI::Hemisphere

RoI hemisphere enumeration.

Enumerator
Positive	The candidate came from the +z side (side A)
Negative	The candidate came from the -z side (side C)

Definition at line 53 of file Muon_ROI.h.

                   {
      Positive, 
      Negative  
   };

◆ Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

33{ P4EETAPHIM, P4IPTCOTTHPHIM, P4PTETAPHIM, P4PXPYPZE, UNKNOWN };

I4Momentum::P4PTETAPHIM

@ P4PTETAPHIM

Definition I4Momentum.h:33

I4Momentum::P4EETAPHIM

@ P4EETAPHIM

Definition I4Momentum.h:33

I4Momentum::P4IPTCOTTHPHIM

@ P4IPTCOTTHPHIM

Definition I4Momentum.h:33

I4Momentum::UNKNOWN

@ UNKNOWN

Definition I4Momentum.h:33

I4Momentum::P4PXPYPZE

@ P4PXPYPZE

Definition I4Momentum.h:33

◆ RoISource

enum Muon_ROI::RoISource

RoI source enumeration.

Enumerator
Barrel	The muon candidate was detected in the barrel region.
Endcap	The muon candidate was detected in the endcap region.
Forward	The muon candidate was detected in the forward region.

Definition at line 47 of file Muon_ROI.h.

                  {
      Barrel, 
      Endcap, 
      Forward 
   };

Constructor & Destructor Documentation

◆ Muon_ROI() [1/2]

Muon_ROI::Muon_ROI	(	uint32_t	roiWord,
		double	eta,
		double	phi,
		const std::string &	thrName,
		double	thrValue )

Constructor used when creating the object from RoIBResult data.

The constructor just initialises all the member variables to the values given to it.

Definition at line 13 of file Muon_ROI.cxx.

   : m_roiWord( roiWord ), m_eta( eta ), m_phi( phi ), m_thrName( thrName ),
     m_thrValue( thrValue ) {
 
}

◆ Muon_ROI() [2/2]

Muon_ROI::Muon_ROI ( )

Default constructor (for persistency purposes)

The constructor initialises all member variables to dummy initial values.

Definition at line 23 of file Muon_ROI.cxx.

   : m_roiWord( 0 ), m_eta( 0. ), m_phi( 0. ), m_thrName( "" ), m_thrValue( 0. ) {
 
}

◆ ~Muon_ROI()

Muon_ROI::~Muon_ROI ( )

virtual

Destructor.

The destructor is virtual, since the base classes have virtual functions...

Definition at line 32 of file Muon_ROI.cxx.

                    {
 
}

Member Function Documentation

◆ cosPhi()

double P4PtEtaPhiMBase::cosPhi ( ) const

virtualinherited

cosinus phi

Implements I4Momentum.

Definition at line 55 of file P4PtEtaPhiMBase.cxx.

{
 return std::cos(this->phi());
}

◆ cosTh()

double P4PtEtaPhiMBase::cosTh ( ) const

virtualinherited

cosinus theta

Implements I4Momentum.

Definition at line 70 of file P4PtEtaPhiMBase.cxx.

{
 return std::tanh(this->eta());
}

◆ cotTh()

double P4PtEtaPhiMBase::cotTh ( ) const

virtualinherited

cottan theta

Implements I4Momentum.

Definition at line 65 of file P4PtEtaPhiMBase.cxx.

{
 return std::sinh(this->eta());
}

◆ dump()

std::ostream & P4PtEtaPhiMBase::dump ( std::ostream & out ) const

virtualinherited

Print I4Momentum content.

Implements I4Momentum.

Definition at line 147 of file P4PtEtaPhiMBase.cxx.

{
  std::stringstream outx;
  outx << "[pt,eta,phi,m] ="
         << std::right << std::scientific << std::setprecision(8) 
         << std::setw(16) << this->pt()
         << std::setw(16) << this->eta()
         << std::setw(16) << this->phi()
         << std::setw(16) << this->m();
  out<<outx.str();
  
  return out;
  
}

◆ e()

double P4PtEtaPhiMBase::e ( ) const

virtualinherited

energy

Implements I4Momentum.

Definition at line 13 of file P4PtEtaPhiMBase.cxx.

{
  const double theMass = this->m();
  const double thePt   = this->pt();
  const double thePz   = this->pz();
 
  //DR from Frank Paige
  // if negative pt point in the opposite direction
  // BUT eta and phi still the same !!!
 
    double eSign = (thePt >= 0.) ? +1. : -1.;
    return eSign*std::sqrt(thePt*thePt + thePz*thePz +  theMass*theMass);
}

◆ errors()

const I4MomentumError * P4PtEtaPhiMBase::errors ( ) const

virtualinherited

Access to errors, if available; returns 0 if no errors.

Implements I4Momentum.

Reimplemented in P4PtEtaPhiM.

Definition at line 162 of file P4PtEtaPhiMBase.cxx.

{
  return 0;
}

◆ et()

double P4PtEtaPhiMBase::et ( ) const

virtualinherited

transverse energy defined to be e*sin(theta)

Implements I4Momentum.

Definition at line 101 of file P4PtEtaPhiMBase.cxx.

   {
     return this->e()*this->sinTh();
   }

◆ eta()

virtual double Muon_ROI::eta ( void ) const

inlinevirtual

Return the eta coordinate of the center of the RoI.

Implements I4Momentum.

Definition at line 99 of file Muon_ROI.h.

99{ return m_eta; }

◆ fillToken() [1/2]

virtual void NavigableTerminalNode::fillToken ( INavigationToken & ) const

inlinevirtualinherited

Implements INavigable.

Definition at line 31 of file NavigableTerminalNode.h.

31{ };

◆ fillToken() [2/2]

virtual void NavigableTerminalNode::fillToken	(	INavigationToken &	,
		const std::any &	) const

inlinevirtualinherited

Implements INavigable.

Definition at line 32 of file NavigableTerminalNode.h.

32{ };

◆ getAthenaBarCode()

virtual AthenaBarCode_t IAthenaBarCode::getAthenaBarCode ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 67 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                   {
    return UNDEFINEDBARCODE;
  }

◆ getCharge()

Muon_ROI::Charge Muon_ROI::getCharge ( ) const

Returns the charge sign of the muon candidate.

Endcap and forward sectors can tell you what was the charge of the muon candidate.

Barrel candidates can't do this.

See also: Muon_ROI::RoISource; Muon_ROI::getSource()

Definition at line 160 of file Muon_ROI.cxx.

                                         {
 
   if( getSource() == Barrel ) return Undef;
   if( m_roiWord & 0x8000000 ) {
      return Pos;
   } else {
      return Neg;
   }
}

◆ getEta()

float Muon_ROI::getEta ( ) const

inline

Legacy function returning the eta coordinate of the RoI.

Definition at line 67 of file Muon_ROI.h.

67{ return m_eta; }

◆ getHemisphere()

Muon_ROI::Hemisphere Muon_ROI::getHemisphere ( ) const

Returns the hemisphere that detected the muon candidate.

The function decodes the sector hemisphere encoded in the 8-bit sector address into an easy to understand enumeration.

See also: Muon_ROI::getSectorAddress(); Muon_ROI::Hemisphere

Definition at line 144 of file Muon_ROI.cxx.

                                                 {
 
   if( this->getSectorAddress() & 0x1 ) {
      return Positive;
   } else {
      return Negative;
   }
}

◆ getPhi()

float Muon_ROI::getPhi ( ) const

inline

Legacy function returning the phi coordinate of the RoI.

Definition at line 69 of file Muon_ROI.h.

69{ return m_phi; }

◆ getRoI()

int Muon_ROI::getRoI ( ) const

Get the "RoI number" (position inside the sector)

A muon's spacial location is identified from the sector number and the hemisphere that detected it.

Each sector is additionally divided into multiple areas, called RoIs that tell you which part of the sector the muon candidate was detected in.

Returns: Integer number smaller than 147

Definition at line 56 of file Muon_ROI.cxx.

                           {
 
   if( this->getSource() == Forward ) {
      return ( ( m_roiWord >> 2 ) & 0x3f );
   } else if( this->getSource() == Endcap ) {
      return ( ( m_roiWord >> 2 ) & 0xff );
   } else if( this->getSource() == Barrel ) {
      return ( ( m_roiWord >> 2 ) & 0x1f );
   }
 
   return 0;
}

◆ getROIWord()

uint32_t Muon_ROI::getROIWord ( ) const

inline

Return the original 32-bit RoI word given by the LVL1 muon trigger.

Definition at line 65 of file Muon_ROI.h.

65{ return m_roiWord; }

◆ getSectorAddress()

int Muon_ROI::getSectorAddress ( ) const

Get the full sector address.

The sector address is an 8-bit identifier of the sector.

For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

The least significant bit shown which hemisphere the sector is in (0: positive side, 1: negative side), the upper (1 or 2) bits show what kind of sector it is, the rest of the address is the number of the sector.

Returns: An 8-bit identifier

Definition at line 80 of file Muon_ROI.cxx.

                                     {
 
   return ( ( m_roiWord >> 14 ) & 0xff );
}

◆ getSource()

Muon_ROI::RoISource Muon_ROI::getSource ( ) const

Returns the system that detected the muon candidate.

The function decodes the sector type encoded in the 8-bit sector address into an easy to understand enumeration.

See also: Muon_ROI::getSectorAddress(); Muon_ROI::RoISource

Definition at line 126 of file Muon_ROI.cxx.

                                            {
 
   if( this->getSectorAddress() & 0x80 ) {
      return Endcap;
   } else if( this->getSectorAddress() & 0x40 ) {
      return Forward;
   } else {
      return Barrel;
   }
}

◆ getThrName()

const std::string & Muon_ROI::getThrName ( ) const

inline

Return the name of the highest threshold this RoI passed.

Definition at line 71 of file Muon_ROI.h.

71{ return m_thrName; }

◆ getThrNumber()

int Muon_ROI::getThrNumber ( ) const

Get the logic number of the highest threshold this RoI passed.

Each detected LVL1 muon candidate is assigned a p_T threshold.

The hardware can assign one of 6 p_T thresholds to the candidate, which are numbered from 1 to 6.

Returns: Integer number in the [1, 6] range

Definition at line 43 of file Muon_ROI.cxx.

                                 {
 
   return ( ( m_roiWord >> 11 ) & 0x7 );
}

◆ getThrValue()

float Muon_ROI::getThrValue ( ) const

inline

Return the value of the highest threshold this RoI passed.

Definition at line 73 of file Muon_ROI.h.

73{ return m_thrValue; }

◆ getVersion()

virtual AthenaBarCodeVersion_t IAthenaBarCode::getVersion ( ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 85 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                    {
    return UNDEFINEDVERSION;
  }

◆ hasSameAthenaBarCode()

virtual bool IAthenaBarCode::hasSameAthenaBarCode ( const IAthenaBarCode & ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 77 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                                   {
    return false;
  }

◆ hasSameAthenaBarCodeExceptVersion()

virtual bool IAthenaBarCode::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & ) const

inlinevirtualinherited

Reimplemented in Analysis::ParticleShallowClone, AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 81 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                                                {
    return false;
  }

◆ hlv()

CLHEP::HepLorentzVector P4PtEtaPhiMBase::hlv ( ) const

virtualinherited

HepLorentzVector Special implementation from Frank Paige : if negative energy, points in opposite direction but eta and phi still the same.

Implements I4Momentum.

Definition at line 128 of file P4PtEtaPhiMBase.cxx.

{
  //minimize the number of calculation and dereference
  const double theM = this->m();
  // note that pt can have negative sign : then it points in opposite direction but eta and phi are still on the same side
  const double thePt = this->pt();  
  
 
  const double thePx = thePt*this->cosPhi();
  const double thePy = thePt*this->sinPhi();
 
  const double thePz = thePt*this->cotTh();
  
  const double theE=std::sqrt(thePt*thePt+thePz*thePz+theM*theM);
  
 
  return CLHEP::HepLorentzVector( thePx, thePy, thePz, theE );
}

◆ iPt()

double P4PtEtaPhiMBase::iPt ( ) const

virtualinherited

inverse of transverse momentum

Implements I4Momentum.

Definition at line 106 of file P4PtEtaPhiMBase.cxx.

107 { return 1./this->pt();

108 }

◆ isFirstCandidate()

bool Muon_ROI::isFirstCandidate ( ) const

Returns if the candidate had the highest p_T in the sector.

Each muon trigger sector can only send information about a maximum of two LVL1 muon candidate to the central trigger.

If this flag is true, this candidate had the highest p_T threshold assigned to it in its sector. If it's false, it was the second candidate in its sector.

Definition at line 92 of file Muon_ROI.cxx.

                                      {
 
   return ( ( m_roiWord >> 22 ) & 0x1 );
}

◆ isMoreCandInRoI()

bool Muon_ROI::isMoreCandInRoI ( ) const

Returns if there were other muons detected in the same RoI.

One RoI (one part of the trigger sector) can only send information about one LVL1 muon candidate to the central trigger.

This flag is true if the particular RoI that detected this muon candidate also detected another candidate with lower p_T.

Definition at line 103 of file Muon_ROI.cxx.

                                     {
 
   return ( ( m_roiWord >> 1 ) & 0x1 );
}

◆ isMoreCandInSector()

bool Muon_ROI::isMoreCandInSector ( ) const

Returns if there were other muons detected in the same sector.

This flag is set to true if the sector that this muon candidate came from, detected more than 2 LVL1 muon candidates.

See also: Muon_ROI::isFirstCandidate()

Definition at line 114 of file Muon_ROI.cxx.

                                        {
 
   return ( m_roiWord & 0x1 );
}

◆ isVetoed()

bool Muon_ROI::isVetoed ( ) const

Returns the veto flag for the candidate.

When the overlap handling is activated in the MuCTPI, candidates can be ignored in the multiplicity sum sent to the CTP.

This flag tells you whether this particular candidate was ignored in the multiplicity sum.

Definition at line 175 of file Muon_ROI.cxx.

                              {
 
   return ( m_roiWord & 0x10000000 );
}

◆ kind()

I4Momentum::Kind P4PtEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 64 of file P4PtEtaPhiMBase.h.

64{ return I4Momentum::P4PTETAPHIM; };

◆ m()

virtual double Muon_ROI::m ( void ) const

inlinevirtual

Return the mass of the object, always 0.0 for RoIs.

Implements I4Momentum.

Definition at line 103 of file Muon_ROI.h.

103{ return 0.0; }

◆ m2()

double P4PtEtaPhiMBase::m2 ( ) const

virtualinherited

mass squared

Implements I4Momentum.

Definition at line 50 of file P4PtEtaPhiMBase.cxx.

{ const double theM=this->m();
 return theM*theM;
}

◆ newVersion()

virtual void IAthenaBarCode::newVersion ( )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 89 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                            {
    //    throw std::runtime_error("IAthenaBarCode::newVersion():: can't newVersion() in the dummy implementation");
  }

◆ p()

double P4PtEtaPhiMBase::p ( ) const

virtualinherited

magnitude of 3-momentum.

Special implementation from Frank Paige : if negative energy p is negative but eta and phi still the same.

Implements I4Momentum.

Definition at line 27 of file P4PtEtaPhiMBase.cxx.

{ 
  const double thePt = this->pt();
  const double thePz = this->pz();
 
  //DR from Frank Paige
  // if negative pt point in the opposite direction
  // BUT eta and phi still the same !!!
 
  double eSign = (thePt >= 0.) ? +1. : -1.;
  return eSign*std::sqrt(thePt*thePt + thePz*thePz);
}

◆ p2()

double P4PtEtaPhiMBase::p2 ( ) const

virtualinherited

square of momentum magnitude

Implements I4Momentum.

Definition at line 40 of file P4PtEtaPhiMBase.cxx.

{ 
  /* This method has been implemented so as to give the same as would be obtained from pow((this->p()),2) with this->p() implemented according to Frank Paige's algorithm above. */
 
  const double thePt = this->pt();
  const double thePz = this->pz();
 
  return thePt*thePt + thePz*thePz;
}

◆ phi()

virtual double Muon_ROI::phi ( void ) const

inlinevirtual

Return the phi coordinate of the center of the RoI.

Implements I4Momentum.

Definition at line 101 of file Muon_ROI.h.

101{ return m_phi; }

◆ pt()

virtual double Muon_ROI::pt ( void ) const

inlinevirtual

Return the value of the highest threshold this RoI passed.

Implements I4Momentum.

Definition at line 97 of file Muon_ROI.h.

97{ return m_thrValue; }

◆ px()

double P4PtEtaPhiMBase::px ( ) const

virtualinherited

x component of momentum

Implements I4Momentum.

Definition at line 117 of file P4PtEtaPhiMBase.cxx.

118 { return this->pt()*this->cosPhi();

119 }

◆ py()

double P4PtEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 121 of file P4PtEtaPhiMBase.cxx.

122 { return this->pt()*this->sinPhi();

123 }

◆ pz()

double P4PtEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 125 of file P4PtEtaPhiMBase.cxx.

126{ return this->pt()*this->cotTh(); }

◆ rapidity()

double P4PtEtaPhiMBase::rapidity ( ) const

virtualinherited

rapidity

Implements I4Momentum.

Definition at line 110 of file P4PtEtaPhiMBase.cxx.

  {
    const double theE=this->e();
    const double thePz=this->pz();
    return 0.5*std::log((theE+thePz)/(theE-thePz));
   }

◆ set4Mom() [1/3]

void P4PtEtaPhiMBase::set4Mom ( const CLHEP::HepLorentzVector & theHlv )

virtualinherited

set all 4-mom from a CLHEP HepLorentzVector DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in P4PtEtaPhiM.

Definition at line 180 of file P4PtEtaPhiMBase.cxx.

{
  std::cout << "FATAL ERROR dummy P4PtEtaPhiMBase::set4Mom called " << std::endl ;
  std::abort();
}

◆ set4Mom() [2/3]

void P4PtEtaPhiMBase::set4Mom ( const I4Momentum & theI4Mom )

virtualinherited

set all 4-mom from another I4Momentum reference DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in P4PtEtaPhiM.

Definition at line 167 of file P4PtEtaPhiMBase.cxx.

{ 
  std::cout << "FATAL ERROR dummy P4PtEtaPhiMBase::set4Mom called " << std::endl ;
  std::abort();
}

◆ set4Mom() [3/3]

void P4PtEtaPhiMBase::set4Mom ( const I4Momentum *const theI4Mom )

virtualinherited

set all 4-mom from another I4Momentum pointer DUMMY IMPLEMENTATION

Implements I4Momentum.

Reimplemented in P4PtEtaPhiM.

Definition at line 173 of file P4PtEtaPhiMBase.cxx.

{ 
  std::cout << "FATAL ERROR dummy P4PtEtaPhiMBase::set4Mom called " << std::endl; ;
  std::abort();
 
}

◆ setAthenaBarCode()

virtual void IAthenaBarCode::setAthenaBarCode ( AthenaBarCode_t )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 71 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                   {
    //    throw std::runtime_error("IAthenaBarCode::setAthenaBarCode():: can't set AthenaBarCode in the dummy implementation");
  }

◆ setVersion()

virtual void IAthenaBarCode::setVersion ( AthenaBarCodeVersion_t )

inlinevirtualinherited

Reimplemented in AthenaBarCodeBase, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< ::Analysis::MuonNavigation, ::P4ImplIPtCotThPhiM >, ParticleImpl< ::Analysis::TauJetNavigation, ::P4ImplEEtaPhiM >, ParticleImpl< CompositeParticleNavigation, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< egammaNavigation, P4ImplEEtaPhiM >, ParticleImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplEEtaPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplIPtCotThPhiM, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleImpl< NavigableTerminalNode, P4PtEtaPhiM >, ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE >, ParticleImpl< TruthParticleNavigation, TruthParticleMomentum, TruthParticleBase >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< INavigable_t, I4Momentum_t, IParticle_t >, ParticleSigStateImpl< Navigable< DataVector< INavigable4Momentum >, double, std::vector< std::pair< ElementLink< DataVector< INavigable4Momentum > >, double > > >, P4ImplPxPyPzE, ParticleEvent::Base >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE >, ParticleSigStateImpl< Navigable< INavigable4MomentumCollection, double >, P4ImplPxPyPzE, ParticleEvent::Base >, and Rec::TrackParticle.

Definition at line 93 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

                                                    {
    //    throw std::runtime_error("IAthenaBarCode::setVersion():: can't setVersion() in the dummy implementation");
  }

◆ sinPhi()

double P4PtEtaPhiMBase::sinPhi ( ) const

virtualinherited

sinus phi

Implements I4Momentum.

Definition at line 60 of file P4PtEtaPhiMBase.cxx.

{ 
 return std::sin(this->phi());
}

◆ sinTh()

double P4PtEtaPhiMBase::sinTh ( ) const

virtualinherited

sinus theta

Implements I4Momentum.

Definition at line 75 of file P4PtEtaPhiMBase.cxx.

{
  // avoid numeric overflow if very large eta
 
  double aEta=std::abs(this->eta());
  if ( aEta>710) {
    aEta=710;
  }
 
  return 1./std::cosh(aEta);
}

◆ tanTh()

double P4PtEtaPhiMBase::tanTh ( ) const

virtualinherited

tan theta

Implements I4Momentum.

Definition at line 87 of file P4PtEtaPhiMBase.cxx.

{
  // avoid numeric overflow if very large eta
 
  double theEta=this->eta();
  if ( std::abs(theEta)>710) {
    theEta=theEta>0 ? 710 : -710;
    return 1./std::sinh(theEta);
  }
 
  return 1./std::sinh(this->eta());
}

Member Data Documentation

◆ m_eta

float Muon_ROI::m_eta

private

eta coordinate of RoI

Definition at line 108 of file Muon_ROI.h.

◆ m_phi

float Muon_ROI::m_phi

private

phi coordinate of RoI

Definition at line 109 of file Muon_ROI.h.

◆ m_roiWord

uint32_t Muon_ROI::m_roiWord

private

32bit encoded ROI word

Definition at line 106 of file Muon_ROI.h.

◆ m_thrName

std::string Muon_ROI::m_thrName

private

Name of the highest threshold this RoI passed.

Definition at line 111 of file Muon_ROI.h.

◆ m_thrValue

float Muon_ROI::m_thrValue

private

Value of the highest threshold this RoI passed.

Definition at line 112 of file Muon_ROI.h.

◆ UNDEFINEDBARCODE

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)

staticinherited

Definition at line 52 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

◆ UNDEFINEDVERSION

const AthenaBarCode_t IAthenaBarCode::UNDEFINEDVERSION = UNDEFINEDBARCODE

staticinherited

Definition at line 53 of file AthenaKernel/AthenaKernel/IAthenaBarCode.h.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Charge

◆ Hemisphere

◆ Kind

◆ RoISource

Constructor & Destructor Documentation

◆ Muon_ROI() [1/2]

◆ Muon_ROI() [2/2]

◆ ~Muon_ROI()

Member Function Documentation

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ e()

◆ errors()

◆ et()

◆ eta()

◆ fillToken() [1/2]

◆ fillToken() [2/2]

◆ getAthenaBarCode()

◆ getCharge()

◆ getEta()

◆ getHemisphere()

◆ getPhi()

◆ getRoI()

◆ getROIWord()

◆ getSectorAddress()

◆ getSource()

◆ getThrName()

◆ getThrNumber()

◆ getThrValue()

◆ getVersion()

◆ hasSameAthenaBarCode()

◆ hasSameAthenaBarCodeExceptVersion()

◆ hlv()

◆ iPt()

◆ isFirstCandidate()

◆ isMoreCandInRoI()

◆ isMoreCandInSector()

◆ isVetoed()

◆ kind()

◆ m()

◆ m2()

◆ newVersion()

◆ p()

◆ p2()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ set4Mom() [1/3]

◆ set4Mom() [2/3]

◆ set4Mom() [3/3]

◆ setAthenaBarCode()

◆ setVersion()

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Member Data Documentation

◆ m_eta

◆ m_phi

◆ m_roiWord

◆ m_thrName

◆ m_thrValue

◆ UNDEFINEDBARCODE

◆ UNDEFINEDVERSION