Jet RoI class for analysis. More...

#include <Jet_ROI.h>

Inheritance diagram for Jet_ROI:

Collaboration diagram for Jet_ROI:

Public Types
typedef std::vector< std::string >	thresholds_type
	Type storing the names of the passed thresholds.
typedef std::vector< float >	thr_value_type
	Type storing the values of the passed thresholds.
enum	Kind { P4EETAPHIM , P4IPTCOTTHPHIM , P4PTETAPHIM , P4PXPYPZE , UNKNOWN }

Public Member Functions
	Jet_ROI (uint32_t roiWord, float eta, float phi, uint32_t thrPattern)
	Constructor used when creating the object from RoIBResult data.
	Jet_ROI ()
	Default constructor (for persistency purposes)
virtual	~Jet_ROI ()
	Destructor.
uint32_t	getROIWord () const
	Return the RoI word produced by the L1Calo hardware.
float	getEta () const
	Legacy function returning the eta coordinate of the RoI.
float	getPhi () const
	Legacy function returning the phi coordinate of the RoI.
uint32_t	getThrPattern () const
	Return the bit-pattern describing the passed thresholds.
float	getET4x4 () const
	Return the ET deposited in a 4x4 cluster.
float	getET6x6 () const
	Return the ET deposited in a 6x6 cluster.
float	getET8x8 () const
	Return the ET deposited in an 8x8 cluster.
const thresholds_type &	getThresholdNames () const
	Return the names of the passed threshodlds.
const thr_value_type &	getThresholdValues () const
	Return the values of the passed thresholds.
void	addThresholdName (thresholds_type::value_type thr)
	Add the name of a threshold that this RoI passed.
void	addThresholdValue (thr_value_type::value_type thr)
	Add the value of a threshold that this RoI passed.
void	setET4x4 (float value)
	Set the ET deposited in a 4x4 cluster.
void	setET6x6 (float value)
	Set the ET deposited in a 6x6 cluster.
void	setET8x8 (float value)
	Set the ET deposited in an 8x8 cluster.
virtual double	pt () const
	Return the p_T of the highest threshold 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
uint32_t	m_thrPattern
	threshold bit pattern
thresholds_type	m_thresholdNames
	Names of the passed thresholds.
thr_value_type	m_thresholdValues
	Values of the passed thresholds.
float	m_ET4x4
	ET sum in a 4x4 cluster.
float	m_ET6x6
	ET sum in a 6x6 cluster.
float	m_ET8x8
	ET sum in an 8x8 cluster.

Detailed Description

Jet RoI class for analysis.

   As the others, this RoI class also inherits from INavigable4Momentum to make
   handling it a bit easier in analyses.

Author: Tadashi Maeno, Alan Watson, Attila Krasznahorkay

Definition at line 28 of file Jet_ROI.h.

Member Typedef Documentation

◆ thr_value_type

typedef std::vector< float > Jet_ROI::thr_value_type

Type storing the values of the passed thresholds.

Definition at line 43 of file Jet_ROI.h.

◆ thresholds_type

typedef std::vector< std::string > Jet_ROI::thresholds_type

Type storing the names of the passed thresholds.

Definition at line 41 of file Jet_ROI.h.

Member Enumeration Documentation

◆ 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

Constructor & Destructor Documentation

◆ Jet_ROI() [1/2]

Jet_ROI::Jet_ROI	(	uint32_t	roiWord,
		float	eta,
		float	phi,
		uint32_t	thrPattern )

Constructor used when creating the object from RoIBResult data.

This is the constructor used by the RoIBResultToAOD algorithm.

It shouldn't be too interesting to the users.

Definition at line 15 of file Jet_ROI.cxx.

   : m_roiWord( roiWord ), m_eta( eta ), m_phi( phi ), m_thrPattern( thrPattern ),
     m_thresholdNames( 0 ), m_thresholdValues( 0 ),
     m_ET4x4(0),
     m_ET6x6(0),
     m_ET8x8(0) {
 
}

◆ Jet_ROI() [2/2]

Jet_ROI::Jet_ROI ( )

Default constructor (for persistency purposes)

This constructor just initialises every member to a reasonable starting value.

Definition at line 27 of file Jet_ROI.cxx.

   : m_roiWord( 0 ), m_eta( 0. ), m_phi( 0. ), m_thrPattern( 0 ),
     m_thresholdNames( 0 ), m_thresholdValues( 0 ),
     m_ET4x4(0),
     m_ET6x6(0),
     m_ET8x8(0) {
 
}

◆ ~Jet_ROI()

Jet_ROI::~Jet_ROI ( )

virtual

Destructor.

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

Definition at line 40 of file Jet_ROI.cxx.

                  {
 
}

Member Function Documentation

◆ addThresholdName()

void Jet_ROI::addThresholdName ( thresholds_type::value_type thr )

inline

Add the name of a threshold that this RoI passed.

Definition at line 66 of file Jet_ROI.h.

66{ m_thresholdNames.push_back( thr ); }

◆ addThresholdValue()

void Jet_ROI::addThresholdValue ( thr_value_type::value_type thr )

inline

Add the value of a threshold that this RoI passed.

Definition at line 68 of file Jet_ROI.h.

68{ m_thresholdValues.push_back( thr ); }

◆ 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 Jet_ROI::eta ( void ) const

inlinevirtual

Return the eta coordinate of the center of the RoI.

Implements I4Momentum.

Definition at line 80 of file Jet_ROI.h.

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

◆ getET4x4()

float Jet_ROI::getET4x4 ( ) const

inline

Return the ET deposited in a 4x4 cluster.

Definition at line 54 of file Jet_ROI.h.

54{ return m_ET4x4; }

◆ getET6x6()

float Jet_ROI::getET6x6 ( ) const

inline

Return the ET deposited in a 6x6 cluster.

Definition at line 56 of file Jet_ROI.h.

56{ return m_ET6x6; }

◆ getET8x8()

float Jet_ROI::getET8x8 ( ) const

inline

Return the ET deposited in an 8x8 cluster.

Definition at line 58 of file Jet_ROI.h.

58{ return m_ET8x8; }

◆ getEta()

float Jet_ROI::getEta ( ) const

inline

Legacy function returning the eta coordinate of the RoI.

Definition at line 48 of file Jet_ROI.h.

48{ return m_eta; }

◆ getPhi()

float Jet_ROI::getPhi ( ) const

inline

Legacy function returning the phi coordinate of the RoI.

Definition at line 50 of file Jet_ROI.h.

50{ return m_phi; }

◆ getROIWord()

uint32_t Jet_ROI::getROIWord ( ) const

inline

Return the RoI word produced by the L1Calo hardware.

Definition at line 46 of file Jet_ROI.h.

46{ return m_roiWord; }

◆ getThresholdNames()

const thresholds_type & Jet_ROI::getThresholdNames ( ) const

inline

Return the names of the passed threshodlds.

Definition at line 61 of file Jet_ROI.h.

61{ return m_thresholdNames; }

◆ getThresholdValues()

const thr_value_type & Jet_ROI::getThresholdValues ( ) const

inline

Return the values of the passed thresholds.

Definition at line 63 of file Jet_ROI.h.

63{ return m_thresholdValues; }

◆ getThrPattern()

uint32_t Jet_ROI::getThrPattern ( ) const

inline

Return the bit-pattern describing the passed thresholds.

Definition at line 52 of file Jet_ROI.h.

52{ return m_thrPattern; }

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

◆ 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 Jet_ROI::m ( void ) const

inlinevirtual

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

Implements I4Momentum.

Definition at line 84 of file Jet_ROI.h.

84{ 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 Jet_ROI::phi ( void ) const

inlinevirtual

Return the phi coordinate of the center of the RoI.

Implements I4Momentum.

Definition at line 82 of file Jet_ROI.h.

82{ return m_phi; }

◆ pt()

double Jet_ROI::pt ( void ) const

virtual

Return the p_T of the highest threshold passed.

The p_T of the Jet RoI is calculated as the highest threshold value that this RoI passed.

It's not too useful like this, but that's on purpose. Any analysis has to use the detailed properties of the RoI, not just a single value describing its transverse momentum.

Returns: The value of the highest threshold this RoI passed, in MeV/c

Implements I4Momentum.

Definition at line 52 of file Jet_ROI.cxx.

                         {
  auto itr = std::max_element(m_thresholdValues.begin(), m_thresholdValues.end());
  return (itr != m_thresholdValues.end() ? *itr : -1);
}

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

◆ setET4x4()

void Jet_ROI::setET4x4 ( float value )

inline

Set the ET deposited in a 4x4 cluster.

Definition at line 71 of file Jet_ROI.h.

71{ m_ET4x4 = value; }

athena.value

value

Definition athena.py:124

◆ setET6x6()

void Jet_ROI::setET6x6 ( float value )

inline

Set the ET deposited in a 6x6 cluster.

Definition at line 73 of file Jet_ROI.h.

73{ m_ET6x6 = value; }

◆ setET8x8()

void Jet_ROI::setET8x8 ( float value )

inline

Set the ET deposited in an 8x8 cluster.

Definition at line 75 of file Jet_ROI.h.

75{ m_ET8x8 = value; }

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

float Jet_ROI::m_ET4x4

private

ET sum in a 4x4 cluster.

Definition at line 97 of file Jet_ROI.h.

◆ m_ET6x6

float Jet_ROI::m_ET6x6

private

ET sum in a 6x6 cluster.

Definition at line 98 of file Jet_ROI.h.

◆ m_ET8x8

float Jet_ROI::m_ET8x8

private

ET sum in an 8x8 cluster.

Definition at line 99 of file Jet_ROI.h.

◆ m_eta

float Jet_ROI::m_eta

private

eta coordinate of RoI

Definition at line 89 of file Jet_ROI.h.

◆ m_phi

float Jet_ROI::m_phi

private

phi coordinate of RoI

Definition at line 90 of file Jet_ROI.h.

◆ m_roiWord

uint32_t Jet_ROI::m_roiWord

private

32bit encoded ROI word

Definition at line 87 of file Jet_ROI.h.

◆ m_thresholdNames

thresholds_type Jet_ROI::m_thresholdNames

private

Names of the passed thresholds.

Definition at line 94 of file Jet_ROI.h.

◆ m_thresholdValues

thr_value_type Jet_ROI::m_thresholdValues

private

Values of the passed thresholds.

Definition at line 95 of file Jet_ROI.h.

◆ m_thrPattern

uint32_t Jet_ROI::m_thrPattern

private

threshold bit pattern

Definition at line 92 of file Jet_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 Typedef Documentation

◆ thr_value_type

◆ thresholds_type

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ Jet_ROI() [1/2]

◆ Jet_ROI() [2/2]

◆ ~Jet_ROI()

Member Function Documentation

◆ addThresholdName()

◆ addThresholdValue()

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ dump()

◆ e()

◆ errors()

◆ et()

◆ eta()

◆ fillToken() [1/2]

◆ fillToken() [2/2]

◆ getAthenaBarCode()

◆ getET4x4()

◆ getET6x6()

◆ getET8x8()

◆ getEta()

◆ getPhi()

◆ getROIWord()

◆ getThresholdNames()

◆ getThresholdValues()

◆ getThrPattern()

◆ getVersion()

◆ hasSameAthenaBarCode()

◆ hasSameAthenaBarCodeExceptVersion()

◆ hlv()

◆ iPt()

◆ kind()

◆ m()

◆ m2()

◆ newVersion()

◆ p()

◆ p2()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ set4Mom() [1/3]

◆ set4Mom() [2/3]

◆ set4Mom() [3/3]

◆ setAthenaBarCode()

◆ setET4x4()

◆ setET6x6()

◆ setET8x8()

◆ setVersion()

◆ sinPhi()

◆ sinTh()

◆ tanTh()

Member Data Documentation

◆ m_ET4x4

◆ m_ET6x6

◆ m_ET8x8

◆ m_eta

◆ m_phi

◆ m_roiWord

◆ m_thresholdNames

◆ m_thresholdValues

◆ m_thrPattern

◆ UNDEFINEDBARCODE

◆ UNDEFINEDVERSION