Class representing a proton reconstructed in AFP. More...

#include <AFPProton_v1.h>

Inheritance diagram for xAOD::AFPProton_v1:

Collaboration diagram for xAOD::AFPProton_v1:

Public Types
typedef ElementLink< AFPTrackContainer >	AFPTrackLink_t
	Type of the track links.

Public Member Functions
	AFPProton_v1 ()
	Default constructor.
float	chi2 () const
	Get the value of \(\chi^2\) function.
void	setChi2 (float chi2)
	Set the value of \(\chi^2\) function.
int	side () const
	Get the ATLAS side on which the proton was measured.
void	setSide (int side)
	Set the ATLAS side on which the proton was measured.
int	methodID () const
	Get the ID of method used to reconstruct the proton.
void	setMethodID (int methodID)
	Set the ID of method used to reconstruct the proton.
4-momentum functions
float	px () const
	Get the x-component of the momentum.
float	py () const
	Get the y-component of the momentum.
float	pz () const
	Get the z-component of the momentum.
void	setPxPyPzE (float px, float py, float pz, float e)
	Set the 4-momentum.
void	setPx (float px)
	Set the x-component of the momentum.
void	setPy (float py)
	Set the y-component of the momentum.
void	setPz (float pz)
	Set the z-component of the momentum.
void	setE (float e)
	Set the energy.
Associated track handling functions
const std::vector< AFPTrackLink_t > &	afpTrackLinks () const
	Get vector of links to tracks that were used to reconstruct the proton.
void	setAFPTrackLinks (const std::vector< AFPTrackLink_t > &newTracksVector)
	Set vector of links to tracks used for proton reconstruction.
void	addAFPTrackLink (const AFPTrackLink_t &newTrack)
	Add a link to a tracks used to reconstruct the proton.
size_t	nTracks () const
	Get the number of tracks that were used to reconstruct the proton.
const AFPTrack *	track (size_t index) const
	Get one of the tracks that was used to reconstruct the proton.
Functions for getting and setting user properties
template<class T>
XAOD_AUXDATA_DEPRECATED T &	auxdata (const std::string &name, const std::string &clsname="")
	Fetch an aux data variable, as a non-const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED const T &	auxdata (const std::string &name, const std::string &clsname="") const
	Fetch an aux data variable, as a const reference.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for reading or not.
template<class T>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="") const
	Check if a user property is available for writing or not.

IParticle functions
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
virtual double	pt () const
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const
	The azimuthal angle ( \(\phi\)) of the particle (has range \(-\pi\) to \(+\pi\).).
virtual double	m () const
	The invariant mass of the particle.
virtual double	e () const
	The total energy of the particle.
virtual double	rapidity () const
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const
	The full 4-momentum of the particle.
virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration.

Detailed Description

Class representing a proton reconstructed in AFP.

This class provides information about a reconstucted proton measured in AFP detectors.

Definition at line 36 of file AFPProton_v1.h.

Member Typedef Documentation

◆ AFPTrackLink_t

typedef ElementLink< AFPTrackContainer > xAOD::AFPProton_v1::AFPTrackLink_t

Type of the track links.

Definition at line 43 of file AFPProton_v1.h.

◆ FourMom_t

typedef IParticle::FourMom_t xAOD::AFPProton_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 62 of file AFPProton_v1.h.

Constructor & Destructor Documentation

◆ AFPProton_v1()

xAOD::AFPProton_v1::AFPProton_v1 ( )

Default constructor.

Definition at line 22 of file AFPProton_v1.cxx.

22: IParticle() {}

xAOD::IParticle::IParticle

IParticle()=default

Member Function Documentation

◆ addAFPTrackLink()

void xAOD::AFPProton_v1::addAFPTrackLink ( const AFPTrackLink_t & newTrack )

Add a link to a tracks used to reconstruct the proton.

Definition at line 120 of file AFPProton_v1.cxx.

                                                                      {
 
      tracksAcc( *this ).push_back( newTrack );
      return;
   }

◆ afpTrackLinks()

const std::vector< AFPTrackLink_t > & xAOD::AFPProton_v1::afpTrackLinks ( ) const

Get vector of links to tracks that were used to reconstruct the proton.

◆ auxdata() [1/2]

template<class T>

XAOD_AUXDATA_DEPRECATED T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" )

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                {
 
         return SG::Accessor< T >(name, clsname)(*this);
      }

◆ auxdata() [2/2]

template<class T>

XAOD_AUXDATA_DEPRECATED const T & xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
        
         return SG::ConstAccessor< T >( name, clsname )( *this );
      }

◆ chi2()

float xAOD::AFPProton_v1::chi2 ( ) const

Get the value of \(\chi^2\) function.

◆ e()

virtual double xAOD::AFPProton_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

◆ eta()

double xAOD::AFPProton_v1::eta ( ) const

virtual

The pseudorapidity ( \(\eta\)) of the particle.

Implements xAOD::IParticle.

Definition at line 29 of file AFPProton_v1.cxx.

                                  {
 
      return p4().Eta();
   }

◆ isAvailable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                            {
 
         return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
      }

◆ isAvailableWritable()

template<class T>

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = "" ) const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                    {
 
         return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
      }

◆ m()

double xAOD::AFPProton_v1::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 39 of file AFPProton_v1.cxx.

                                {
 
      return p4().M();
   }

◆ methodID()

int xAOD::AFPProton_v1::methodID ( ) const

Get the ID of method used to reconstruct the proton.

◆ nTracks()

size_t xAOD::AFPProton_v1::nTracks ( ) const

Get the number of tracks that were used to reconstruct the proton.

Definition at line 126 of file AFPProton_v1.cxx.

                                      {
 
      // Check if the links are available:
      if( ! tracksAcc.isAvailable( *this ) ) {
         return 0;
      }
 
      return tracksAcc( *this ).size();
   }

◆ p4()

AFPProton_v1::FourMom_t xAOD::AFPProton_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 51 of file AFPProton_v1.cxx.

                                                {
 
      FourMom_t p4;
      p4.SetPxPyPzE( px(), py(), pz(), e() );
 
      return p4;
   }

◆ phi()

double xAOD::AFPProton_v1::phi ( ) const

virtual

The azimuthal angle ( \(\phi\)) of the particle (has range \(-\pi\) to \(+\pi\).).

Implements xAOD::IParticle.

Definition at line 34 of file AFPProton_v1.cxx.

                                  {
 
      return p4().Phi();
   }

◆ pt()

double xAOD::AFPProton_v1::pt ( ) const

virtual

The transverse momentum ( \(p_T\)) of the particle.

Implements xAOD::IParticle.

Definition at line 24 of file AFPProton_v1.cxx.

                                 {
 
      return p4().Pt();
   }

◆ px()

float xAOD::AFPProton_v1::px ( ) const

Get the x-component of the momentum.

◆ py()

float xAOD::AFPProton_v1::py ( ) const

Get the y-component of the momentum.

◆ pz()

float xAOD::AFPProton_v1::pz ( ) const

Get the z-component of the momentum.

◆ rapidity()

double xAOD::AFPProton_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 46 of file AFPProton_v1.cxx.

                                       {
 
      return p4().Rapidity();
   }

◆ setAFPTrackLinks()

void xAOD::AFPProton_v1::setAFPTrackLinks ( const std::vector< AFPTrackLink_t > & newTracksVector )

Set vector of links to tracks used for proton reconstruction.

◆ setChi2()

void xAOD::AFPProton_v1::setChi2 ( float chi2 )

Set the value of \(\chi^2\) function.

◆ setE()

void xAOD::AFPProton_v1::setE ( float e )

Set the energy.

Definition at line 99 of file AFPProton_v1.cxx.

                                        {
 
      static const Accessor< float > acc( "e" );
      acc( *this ) = value;
      return;
   }

◆ setMethodID()

void xAOD::AFPProton_v1::setMethodID ( int methodID )

Set the ID of method used to reconstruct the proton.

◆ setPx()

void xAOD::AFPProton_v1::setPx ( float px )

Set the x-component of the momentum.

Definition at line 78 of file AFPProton_v1.cxx.

                                         {
 
      static const Accessor< float > acc( "px" );
      acc( *this ) = value;
      return;
   }

◆ setPxPyPzE()

void xAOD::AFPProton_v1::setPxPyPzE	(	float	px,
		float	py,
		float	pz,
		float	e )

Set the 4-momentum.

Definition at line 68 of file AFPProton_v1.cxx.

                                                                        {
 
      setPx( px );
      setPy( py );
      setPz( pz );
      setE( e );
 
      return;
   }

◆ setPy()

void xAOD::AFPProton_v1::setPy ( float py )

Set the y-component of the momentum.

Definition at line 85 of file AFPProton_v1.cxx.

                                         {
 
      static const Accessor< float > acc( "py" );
      acc( *this ) = value;
      return;
   }

◆ setPz()

void xAOD::AFPProton_v1::setPz ( float pz )

Set the z-component of the momentum.

Definition at line 92 of file AFPProton_v1.cxx.

                                         {
 
      static const Accessor< float > acc( "pz" );
      acc( *this ) = value;
      return;
   }

◆ setSide()

void xAOD::AFPProton_v1::setSide ( int side )

Set the ATLAS side on which the proton was measured.

◆ side()

int xAOD::AFPProton_v1::side ( ) const

Get the ATLAS side on which the proton was measured.

◆ track()

const AFPTrack * xAOD::AFPProton_v1::track ( size_t index ) const

Get one of the tracks that was used to reconstruct the proton.

Definition at line 136 of file AFPProton_v1.cxx.

                                                           {
 
      // Check if the links are available:
      if( ! tracksAcc.isAvailable( *this ) ) {
         return nullptr;
      }
 
      // Use the at(...) function so the code would throw an exception if an
      // impossible index is requested:
      auto link = tracksAcc( *this ).at( index );
 
      // Check if the link can be de-referenced:
      if( ! link.isValid() ) {
         return nullptr;
      }
 
      // Return the pointer:
      return *link;
   }

◆ type()

Type::ObjectType xAOD::AFPProton_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 59 of file AFPProton_v1.cxx.

                                           {
 
      return Type::Particle;
   }

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

Public Types

Public Member Functions

IParticle functions

Detailed Description

Member Typedef Documentation

◆ AFPTrackLink_t

◆ FourMom_t

Constructor & Destructor Documentation

◆ AFPProton_v1()

Member Function Documentation

◆ addAFPTrackLink()

◆ afpTrackLinks()

◆ auxdata() [1/2]

◆ auxdata() [2/2]

◆ chi2()

◆ e()

◆ eta()

◆ isAvailable()

◆ isAvailableWritable()

◆ m()

◆ methodID()

◆ nTracks()

◆ p4()

◆ phi()

◆ pt()

◆ px()

◆ py()

◆ pz()

◆ rapidity()

◆ setAFPTrackLinks()

◆ setChi2()

◆ setE()

◆ setMethodID()

◆ setPx()

◆ setPxPyPzE()

◆ setPy()

◆ setPz()

◆ setSide()

◆ side()

◆ track()

◆ type()