ATLAS Offline Software
Loading...
Searching...
No Matches
Neutrino Class Reference

#include <Neutrino.h>

Inheritance diagram for Neutrino:
Collaboration diagram for Neutrino:

Public Types

typedef NeutrinoNavigation navigable_type
 publish the type of the base class (ie: 'traits-itize' it)
typedef P4ImplPxPyPzE momentum_type
 publish the type of the base class (ie: 'traits-itize' it)
typedef ParticleEvent::Base particle_type
 publish the type of the base class (ie: 'traits-itize' it)
typedef ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Baseself_type
 publish the type of the base class (ie: 'traits-itize' it)
enum  Kind {
  P4EETAPHIM , P4IPTCOTTHPHIM , P4PTETAPHIM , P4PXPYPZE ,
  UNKNOWN
}

Public Member Functions

 ~Neutrino ()=default
 Destructor.
const navigable_typenavigableBase () const
 access to underlying base type (INavigable-like)
navigable_typenavigableBase ()
 access to underlying base type (INavigable-like)
const momentum_typemomentumBase () const
 access to underlying base type (I4Momentum-like)
momentum_typemomentumBase ()
 access to underlying base type (I4Momentum-like)
const particle_typeparticleBase () const
 access to underlying base type (IParticle-like)
particle_typeparticleBase ()
 access to underlying base type (IParticle-like)
virtual void set4Mom (const I4Momentum &p4)
 set 4Momentum (will throw exception if cannot be implemented)
virtual void set4Mom (const I4Momentum *const p4)
 set 4Momentum (will throw exception if cannot be implemented)
virtual void set4Mom (const CLHEP::HepLorentzVector &hlv)
 set 4Momentum (will throw exception if cannot be implemented)
virtual void set_dataType (ParticleDataType::DataType x)
virtual void set_charge (ChargeType x)
virtual void set_pdgId (int x)
virtual void set_origin (const VxContainer *theContainer, int index)
virtual void set_origin (const VxContainer *theContainer, const Trk::VxCandidate *vertex)
void set_origin (const ElementLink< VxContainer > &origin)
virtual void fillToken (INavigationToken &thisToken) const
virtual void fillToken (INavigationToken &thisToken, const std::any &weight) const
AthenaBarCode_t getAthenaBarCode () const
void setAthenaBarCode (AthenaBarCode_t)
bool hasSameAthenaBarCode (const IAthenaBarCode &) const
bool hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &) const
AthenaBarCodeVersion_t getVersion () const
void newVersion ()
void setVersion (AthenaBarCodeVersion_t newversion)
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 m () const
 mass
virtual double m2 () const
 mass squared
virtual double p () const
 mass momentum magnitude
virtual double p2 () const
 square of momentum magnitude
virtual double rapidity () const
 rapidity
virtual double eta () const
 pseudo rapidity
virtual double phi () const
 phi in [-pi,pi[
virtual double e () const
 energy
virtual double et () const
 transverse energy defined to be e*sin(theta)
virtual double pt () const
 transverse momentum
virtual double iPt () const
 inverse of transverse momentum
virtual double cosPhi () const
 cosinus phi
virtual double sinPhi () const
 sinus phi
virtual double tanTh () const
 tan theta
virtual double cosTh () const
 cosinus theta
virtual double sinTh () const
 sinus theta
virtual double cotTh () const
 cottan theta
virtual CLHEP::HepLorentzVector hlv () const
 CLHEP HepLorentzVector.
virtual const I4MomentumErrorerrors () const
 Access to errors, if available; returns 0 if no errors.
virtual I4Momentum::Kind kind () const
 add Kind which tells what kind (P4XYZ) the underlying implementation has
virtual std::ostream & dump (std::ostream &out) const
 Print I4Momentum content.
virtual ParticleDataType::DataType dataType () const
 Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}.
virtual const Trk::RecVertexorigin () const
 Return a RecVertex corresponding to particle Origin.
virtual const ElementLink< VxContainer > & originLink () const
 Return an ElementLink corresponding to particle's Origin.
virtual bool hasCharge () const
 method to check if charge information is available
virtual ChargeType charge () const
 returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface
virtual bool hasPdgId () const
 method to check if particle id information is available
virtual int pdgId () const
 Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h.

Static Public Attributes

static const AthenaBarCode_t UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)
static const AthenaBarCode_t UNDEFINEDVERSION = UNDEFINEDBARCODE

Private Types

typedef ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzENeutrinoImpl_t

Private Attributes

NeutrinoNavigation m_nav
 The navigable part.
P4ImplPxPyPzE m_mom
 The 4-momentum part.
ParticleEvent::Base m_part
 The particle-id part.

Detailed Description

Definition at line 31 of file Neutrino.h.

Member Typedef Documentation

◆ momentum_type

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 52 of file ParticleImpl.h.

◆ navigable_type

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 48 of file ParticleImpl.h.

◆ NeutrinoImpl_t

Definition at line 35 of file Neutrino.h.

◆ particle_type

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 56 of file ParticleImpl.h.

◆ self_type

publish the type of the base class (ie: 'traits-itize' it)

Definition at line 62 of file ParticleImpl.h.

Member Enumeration Documentation

◆ Kind

enum I4Momentum::Kind
inherited
Enumerator
P4EETAPHIM 
P4IPTCOTTHPHIM 
P4PTETAPHIM 
P4PXPYPZE 
UNKNOWN 

Definition at line 33 of file I4Momentum.h.

Constructor & Destructor Documentation

◆ ~Neutrino()

Neutrino::~Neutrino ( )
default

Destructor.

Member Function Documentation

◆ charge()

virtual ChargeType ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::charge ( ) const
virtualinherited

returns charge as a typedef ChargeType currently Charge Type is a double for jets this may be changed to an int and ask jets to extend this interface

Implements IParticle.

◆ cosPhi()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::cosPhi ( ) const
virtualinherited

cosinus phi

Implements I4Momentum.

◆ cosTh()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::cosTh ( ) const
virtualinherited

cosinus theta

Implements I4Momentum.

◆ cotTh()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::cotTh ( ) const
virtualinherited

cottan theta

Implements I4Momentum.

◆ dataType()

Return enum indicating real data, fast, or full simulation Return Type has a DataType enum with the following values: {Data = 0, Full = 1, FastShower = 2, Fast = 3, True = 4}.

IParticle interface forwarding

Implements IParticle.

◆ dump()

virtual std::ostream & ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::dump ( std::ostream & out) const
virtualinherited

Print I4Momentum content.

Implements I4Momentum.

◆ e()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::e ( ) const
virtualinherited

energy

Implements I4Momentum.

◆ errors()

virtual const I4MomentumError * ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::errors ( ) const
virtualinherited

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

Implements I4Momentum.

◆ et()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::et ( ) const
virtualinherited

transverse energy defined to be e*sin(theta)

Implements I4Momentum.

◆ eta()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::eta ( void ) const
virtualinherited

pseudo rapidity

Implements I4Momentum.

◆ fillToken() [1/2]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::fillToken ( INavigationToken & thisToken) const
virtualinherited

INavigable interface forwarding

Implements INavigable.

◆ fillToken() [2/2]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::fillToken ( INavigationToken & thisToken,
const std::any & weight ) const
virtualinherited

Implements INavigable.

◆ getAthenaBarCode()

AthenaBarCode_t ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::getAthenaBarCode ( ) const
virtualinherited

IAthenaBarCode interface forwarding

Reimplemented from IAthenaBarCode.

◆ getVersion()

Reimplemented from IAthenaBarCode.

◆ hasCharge()

virtual bool ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::hasCharge ( ) const
virtualinherited

method to check if charge information is available

Implements IParticle.

◆ hasPdgId()

virtual bool ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::hasPdgId ( ) const
virtualinherited

method to check if particle id information is available

Implements IParticle.

◆ hasSameAthenaBarCode()

bool ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::hasSameAthenaBarCode ( const IAthenaBarCode & ) const
virtualinherited

Reimplemented from IAthenaBarCode.

◆ hasSameAthenaBarCodeExceptVersion()

bool ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & ) const
virtualinherited

Reimplemented from IAthenaBarCode.

◆ hlv()

virtual CLHEP::HepLorentzVector ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::hlv ( ) const
virtualinherited

CLHEP HepLorentzVector.

Implements I4Momentum.

◆ iPt()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::iPt ( ) const
virtualinherited

inverse of transverse momentum

Implements I4Momentum.

◆ kind()

virtual I4Momentum::Kind ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::kind ( ) const
virtualinherited

add Kind which tells what kind (P4XYZ) the underlying implementation has

Implements I4Momentum.

◆ m()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::m ( void ) const
virtualinherited

mass

Implements I4Momentum.

◆ m2()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::m2 ( ) const
virtualinherited

mass squared

Implements I4Momentum.

◆ momentumBase() [1/2]

access to underlying base type (I4Momentum-like)

◆ momentumBase() [2/2]

const momentum_type & ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::momentumBase ( ) const
inherited

access to underlying base type (I4Momentum-like)

◆ navigableBase() [1/2]

access to underlying base type (INavigable-like)

◆ navigableBase() [2/2]

const navigable_type & ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::navigableBase ( ) const
inherited

access to underlying base type (INavigable-like)

◆ newVersion()

void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::newVersion ( )
virtualinherited

Reimplemented from IAthenaBarCode.

◆ origin()

virtual const Trk::RecVertex * ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::origin ( ) const
virtualinherited

Return a RecVertex corresponding to particle Origin.

Implements IParticle.

◆ originLink()

virtual const ElementLink< VxContainer > & ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::originLink ( ) const
virtualinherited

Return an ElementLink corresponding to particle's Origin.

Implements IParticle.

◆ p()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::p ( ) const
virtualinherited

mass momentum magnitude

Implements I4Momentum.

◆ p2()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::p2 ( ) const
virtualinherited

square of momentum magnitude

Implements I4Momentum.

◆ particleBase() [1/2]

access to underlying base type (IParticle-like)

◆ particleBase() [2/2]

const particle_type & ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::particleBase ( ) const
inherited

access to underlying base type (IParticle-like)

◆ pdgId()

virtual int ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::pdgId ( ) const
virtualinherited

Return enum indicating particle id the enum file is available in Event/EventKernel/PdtPdg.h.

Implements IParticle.

◆ phi()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::phi ( void ) const
virtualinherited

phi in [-pi,pi[

Implements I4Momentum.

◆ pt()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::pt ( void ) const
virtualinherited

transverse momentum

Implements I4Momentum.

◆ px()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::px ( ) const
virtualinherited

x component of momentum

I4Momentum interface forwarding

Implements I4Momentum.

◆ py()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::py ( ) const
virtualinherited

y component of momentum

Implements I4Momentum.

◆ pz()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::pz ( ) const
virtualinherited

z component of momentum

Implements I4Momentum.

◆ rapidity()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::rapidity ( ) const
virtualinherited

rapidity

Implements I4Momentum.

◆ set4Mom() [1/3]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set4Mom ( const CLHEP::HepLorentzVector & theHlv)
virtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

◆ set4Mom() [2/3]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set4Mom ( const I4Momentum & theI4Mom)
virtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

◆ set4Mom() [3/3]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set4Mom ( const I4Momentum *const theI4Mom)
virtualinherited

set 4Momentum (will throw exception if cannot be implemented)

Implements I4Momentum.

◆ set_charge()

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_charge ( ChargeType x)
virtualinherited

◆ set_dataType()

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_dataType ( ParticleDataType::DataType x)
virtualinherited

◆ set_origin() [1/3]

void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_origin ( const ElementLink< VxContainer > & origin)
inherited

◆ set_origin() [2/3]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_origin ( const VxContainer * theContainer,
const Trk::VxCandidate * vertex )
virtualinherited

◆ set_origin() [3/3]

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_origin ( const VxContainer * theContainer,
int index )
virtualinherited

◆ set_pdgId()

virtual void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::set_pdgId ( int x)
virtualinherited

◆ setAthenaBarCode()

void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::setAthenaBarCode ( AthenaBarCode_t )
virtualinherited

Reimplemented from IAthenaBarCode.

◆ setVersion()

void ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::setVersion ( AthenaBarCodeVersion_t newversion)
virtualinherited

Reimplemented from IAthenaBarCode.

◆ sinPhi()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::sinPhi ( ) const
virtualinherited

sinus phi

Implements I4Momentum.

◆ sinTh()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::sinTh ( ) const
virtualinherited

sinus theta

Implements I4Momentum.

◆ tanTh()

virtual double ParticleImpl< NeutrinoNavigation, P4ImplPxPyPzE, ParticleEvent::Base >::tanTh ( ) const
virtualinherited

tan theta

Implements I4Momentum.

Member Data Documentation

◆ m_mom

The 4-momentum part.

Definition at line 310 of file ParticleImpl.h.

◆ m_nav

The navigable part.

Definition at line 307 of file ParticleImpl.h.

◆ m_part

The particle-id part.

Definition at line 313 of file ParticleImpl.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 file: