xAOD::Photon_v1 Class Reference

#include <Photon_v1.h>

Inheritance diagram for xAOD::Photon_v1:

Collaboration diagram for xAOD::Photon_v1:

Public Member Functions
xAOD::Photon constructors
	Photon_v1 ()
	Default constructor.
	Photon_v1 (const Photon_v1 &ph)
	Copy ctor.
xAOD::Photon Assignment
Photon_v1 &	operator= (const Photon_v1 &el)
	Assignment Operator. Ends up using the assignment of AuxElement for the store.
xAOD::Photon ObjectType
virtual Type::ObjectType	type () const override final
	The type of the object as a simple enumeration.
xAOD::IParticle functions
These are already virtual due to IParticle
virtual double	m () const override final
	The invariant mass of the particle.
virtual double	e () const override final
	The total energy of the particle.
virtual double	rapidity () const override final
	The true rapidity (y) of the particle.
xAOD::Photon vertex to cluster matching values.
bool	vertexCaloMatchValue (float &value, const EgammaParameters::VertexCaloMatchType information) const
	Accessor to vertex to Calo Match Values If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.
float	vertexCaloMatchValue (const EgammaParameters::VertexCaloMatchType information) const
	Accessor to vertex to Calo Match Values , this just returns the value without internaly checking if it exists.
bool	setVertexCaloMatchValue (const float value, const EgammaParameters::VertexCaloMatchType information)
	Set method for CaloMatch values.
xAOD::EgammaParameters::ConversionType	conversionType () const
	return the photon conversion type (see EgammaEnums)
float	conversionRadius () const
	return the photon conversion radius
xAOD::Egamma author (i.e. which reco algorithm was used)
uint16_t	author (uint16_t bitmask=EgammaParameters::AuthorALL) const
	Get author.
void	addAuthor (uint16_t)
	add author
void	setAuthor (uint16_t)
	set author
xAOD::Egamma ambiguousObject i.e get the electron/photon corresponding to an ambiguous photon/electron
as the same cluster leads to creation of both.
const Egamma_v1 *	ambiguousObject () const
	Get ambiguous.
xAOD::Egamma Shower shape Accesors
If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.
bool	showerShapeValue (float &value, const EgammaParameters::ShowerShapeType information) const
	Accessor for ShowerShape values.
float	showerShapeValue (const EgammaParameters::ShowerShapeType information) const
	Accessor to ShowerShape values , this just returns the value without internaly checking if it exists.
bool	setShowerShapeValue (float value, const EgammaParameters::ShowerShapeType information)
	Set method for Shower Shape values.
xAOD::Egamma object quality of the calorimeter cluster
bool	isGoodOQ (uint32_t mask) const
	Check object quality. Return True is it is Good Object Quality.
uint32_t	OQ () const
	Return the object quality bit word.
void	setOQ (uint32_t newOQ)
	Set the object quality.
xAOD::Egamma Isolation value Accesors
If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.
bool	isolation (float &value, const Iso::IsolationType information) const
	Accessor for Isolation values.
float	isolation (const Iso::IsolationType information) const
	Accessor to Isolation values , this just returns the value without internaly checking if it exists.
bool	setIsolation (float value, const Iso::IsolationType information)
	set method for Isolation values.
bool	isolationValue (float &value, const Iso::IsolationType information) const
	old Accessor for Isolation values.
float	isolationValue (const Iso::IsolationType information) const
	old Accessor to Isolation values , this just returns the value without internaly checking if it exists.
bool	setIsolationValue (float value, const Iso::IsolationType information)
	old set method for Isolation values.
xAOD::Egamma Isolation correction Accesors
If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.
bool	isolationCaloCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param) const
	Accessor for flavour and type depended Isolation Calo correction.
float	isolationCaloCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param) const
	Accessor for flavour and type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.
bool	isolationCaloCorrection (float &value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr) const
	Accessor for type depended Isolation Calo correction.
float	isolationCaloCorrection (Iso::IsolationType type, Iso::IsolationCaloCorrection corr) const
	Accessor for type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.
bool	setIsolationCaloCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param)
	set method for flavour and type depended Isolation Calo Corrections.
bool	setIsolationCaloCorrection (float value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr)
	set method for type depended Isolation Calo Corrections.
bool	isolationTrackCorrection (float &value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr) const
	Accessor for Isolation Track correction.
float	isolationTrackCorrection (const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr) const
	Accessor to Isolation Track corrections , this just returns the correction without internaly checking if it exists.
bool	setIsolationTrackCorrection (float value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr)
	Set method for Isolation Track Corrections.
bool	isolationCorrectionBitset (std::bitset< 32 > &value, const Iso::IsolationFlavour flavour) const
	Accessor for Isolation corection Bitset.
std::bitset< 32 >	isolationCorrectionBitset (const Iso::IsolationFlavour flavour) const
	Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists.
bool	setIsolationCorrectionBitset (uint32_t value, const Iso::IsolationFlavour flavour)
	Set method for Isolation corection Bitset.
xAOD::Egamma selector / isEM methods using the menu name
bool	passSelection (bool &value, const std::string &menu) const
	Check if the egamma object pass a selection menu (using the name) If the menu decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
bool	passSelection (const std::string &menu) const
	Check if the egamma object pass a selection menu (using the name) If the particular menu decision is not stored in this xAOD::Egamma, an exception will occur.
void	setPassSelection (bool value, const std::string &menu)
	Set the selection decision for a menu (using the name).
bool	selectionisEM (unsigned int &value, const std::string &isEM) const
	Return the isEM word for a selection menu If the menu isEM is stored in this xAOD::Egamma, then the function fills 'value' with the isEM (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
unsigned int	selectionisEM (const std::string &isEM) const
	Return the isEM word for a selection menu (using the name) If the particular isEM word is not stored in this xAOD::Egamma, an exception will occur.
void	setSelectionisEM (unsigned int value, const std::string &isEM)
	Set the isEM word for a selection menu (using the name).
bool	likelihoodValue (float &value, const std::string &LHValue=std::string("LHValue")) const
	Return the LH value as float If the LH decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.
float	likelihoodValue (const std::string &LHValue=std::string("LHValue")) const
	Return the LH value as float If the LH Value is not stored in this xAOD::Egamma, an exception will occur.
void	setLikelihoodValue (float value, const std::string &LHValue=std::string("LHValue"))
	Set the LHValue as float.
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.

xAOD::vertex Pointers to vertices
typedef std::vector< ElementLink< VertexContainer > >	VxELVec_t
	Helper type definition.
const xAOD::Vertex *	vertex (size_t index=0) const
	Pointer to the xAOD::Vertex/es that match the photon candidate.
const ElementLink< VertexContainer > &	vertexLink (size_t index=0) const
	ElementLink to the xAOD::vertex/es that match the electron candidate.
const VxELVec_t &	vertexLinks () const
	Get all vertex links.
void	setVertexLinks (const VxELVec_t &links)
	set Pointer to the xAOD::vertex/vertices that match the photon candidate
size_t	nVertices () const
	Return the number xAOD::Vertex/vertices that match the photon candidate.

xAOD::IParticle functions
These are already virtual due to IParticle
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
virtual double	pt () const override final
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const override final
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const override final
	The azimuthal angle ( \(\phi\)) of the particle.
virtual FourMom_t	p4 () const override final
	The full 4-momentum of the particle as a TLoretzVector.

xAOD::Egamma 4-Mom functions
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for egamma.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : internal egamma type.
void	setPtEtaPhi (float pt, float eta, float phi)
	set the 4-vec
void	setPt (float pt)
	set the Pt
void	setEta (float eta)
	set the eta
void	setPhi (float phi)
	set the phi

xAOD::Egamma 4x4 Covariance Matrix
typedef Eigen::Matrix< float, 4, 4 >	EgammaCovMatrix_t
	4x4 Covariance Matrix in EtEtaPhiM (needs decision)
EgammaCovMatrix_t	covMatrix () const
	Returns the 4x4 symmetric covariance matrix .
void	setCovMatrix (const EgammaCovMatrix_t &cov)
	set the 4x4 symmetric covariance matrix .

xAOD::Egamma Pointer to CaloClusters
typedef std::vector< ElementLink< CaloClusterContainer > >	CLELVec_t
	Helper type definition.
size_t	nCaloClusters () const
	Return the number of xAOD::CaloClusters that define the electron candidate.
const xAOD::CaloCluster *	caloCluster (size_t index=0) const
	Pointer to the xAOD::CaloCluster/s that define the electron candidate.
const ElementLink< CaloClusterContainer > &	caloClusterLink (size_t index=0) const
	ElementLink to the xAOD::CaloCluster/s that match the electron candidate.
const CLELVec_t &	caloClusterLinks () const
	Get all cluster links.
void	setCaloClusterLinks (const CLELVec_t &links)
	set Pointer to the xAOD::CaloCluster

Detailed Description

Definition at line 37 of file Photon_v1.h.

Member Typedef Documentation

CLELVec_t

typedef std::vector< ElementLink< CaloClusterContainer > > xAOD::Egamma_v1::CLELVec_t

inherited

Helper type definition.

Definition at line 168 of file Egamma_v1.h.

EgammaCovMatrix_t

typedef Eigen::Matrix<float,4,4> xAOD::Egamma_v1::EgammaCovMatrix_t

inherited

4x4 Covariance Matrix in EtEtaPhiM (needs decision)

Definition at line 142 of file Egamma_v1.h.

FourMom_t

typedef IParticle::FourMom_t xAOD::Egamma_v1::FourMom_t

inherited

Definition of the 4-momentum type.

Definition at line 104 of file Egamma_v1.h.

GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double> > xAOD::Egamma_v1::GenVecFourMom_t

inherited

Base 4 Momentum type for egamma.

Definition at line 119 of file Egamma_v1.h.

VxELVec_t

typedef std::vector< ElementLink< VertexContainer > > xAOD::Photon_v1::VxELVec_t

Helper type definition.

Definition at line 94 of file Photon_v1.h.

Constructor & Destructor Documentation

Photon_v1() [1/2]

xAOD::Photon_v1::Photon_v1

(

)

Default constructor.

Definition at line 19 of file Photon_v1.cxx.

      : Egamma_v1() {
 
   }

Photon_v1() [2/2]

xAOD::Photon_v1::Photon_v1

(

const Photon_v1 &

ph

)

Copy ctor.

This involves copying the entire Auxilary store (Deep copy). It is a slow operation which should be used sparingly.

Definition at line 24 of file Photon_v1.cxx.

                                          : Egamma_v1(ph){
    makePrivateStore(ph);  
  }

Member Function Documentation

addAuthor()

void xAOD::Egamma_v1::addAuthor ( uint16_t newAuthor )

inherited

add author

Definition at line 161 of file Egamma_v1.cxx.

                                            {
  static const Accessor< uint16_t > acc( "author" );
  uint16_t author = acc(*this);
  acc(*this) = author | newAuthor;
}

ambiguousObject()

const Egamma_v1 * xAOD::Egamma_v1::ambiguousObject ( ) const

inherited

Get ambiguous.

ambiguous

Definition at line 182 of file Egamma_v1.cxx.

                                                  {
 
   if( ! ambiguityLinkAcc.isAvailable( *this ) ) {
      return nullptr;
   }
   const ElementLink< xAOD::EgammaContainer >& link = ambiguityLinkAcc( *this );
   if( ! link.isValid() ) {
      return nullptr;
   }
   return *link;
}

author()

uint16_t xAOD::Egamma_v1::author ( uint16_t bitmask = EgammaParameters::AuthorALL ) const

inherited

Get author.

egamma author

Definition at line 155 of file Egamma_v1.cxx.

                                              {
  static const Accessor< uint16_t > acc( "author" );
  uint16_t author = acc(*this);
  return author & mask;
}

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

caloCluster()

const xAOD::CaloCluster * xAOD::Egamma_v1::caloCluster ( size_t index = 0 ) const

inherited

Pointer to the xAOD::CaloCluster/s that define the electron candidate.

Definition at line 377 of file Egamma_v1.cxx.

                                                                  {
 
  if( index >= nCaloClusters() ) {
    return nullptr;
  }
  const CLELVec_t& cls = caloClusterLinks();
  if( ! cls[ index ].isValid() ) {
    return nullptr;
  }
  return *( cls[ index ] );
}

caloClusterLink()

const ElementLink< CaloClusterContainer > & xAOD::Egamma_v1::caloClusterLink ( size_t index = 0 ) const

inherited

ElementLink to the xAOD::CaloCluster/s that match the electron candidate.

Definition at line 390 of file Egamma_v1.cxx.

                                               {
 
  if( index >= nCaloClusters() ) {
    static const ElementLink< CaloClusterContainer > dummy;
    return dummy;
  }
  return caloClusterLinks()[ index ];
}

caloClusterLinks()

const CLELVec_t & xAOD::Egamma_v1::caloClusterLinks ( ) const

inherited

Get all cluster links.

conversionRadius()

float xAOD::Photon_v1::conversionRadius ( ) const

inline

return the photon conversion radius

Definition at line 129 of file Photon_v1.h.

                                   {
      return xAOD::EgammaHelpers::conversionRadius(this);
    }

conversionType()

xAOD::EgammaParameters::ConversionType xAOD::Photon_v1::conversionType ( ) const

inline

return the photon conversion type (see EgammaEnums)

Definition at line 124 of file Photon_v1.h.

                                                             {
      return xAOD::EgammaHelpers::conversionType(this);
    }

covMatrix()

Egamma_v1::EgammaCovMatrix_t xAOD::Egamma_v1::covMatrix ( ) const

inherited

Returns the 4x4 symmetric covariance matrix .

Definition at line 124 of file Egamma_v1.cxx.

                                                     {
 
  static const Accessor< std::vector<float> > acc( "EgammaCovarianceMatrix" );
  EgammaCovMatrix_t cov;
  cov.setZero();
 
  if(!acc.isAvailable(*this) ) {
    return cov;
  }
  const std::vector<float>& v = acc(*this);
  size_t size= v.size();
  if(size==16){
    //up to 21.0.11
    cov = Eigen::Map<const EgammaCovMatrix_t> (v.data());
  }
  else {
    //from >21.0.11
    EgammaCovMatrix_t cov;
    MatrixHelpers::expand(v.begin(),v.end(),cov );
  }
  return cov;
}

e()

double xAOD::Photon_v1::e ( ) const

finaloverridevirtual

The total energy of the particle.

Reimplemented from xAOD::Egamma_v1.

Definition at line 46 of file Photon_v1.cxx.

                             {
      // for a massless particle E = pT * cosh(eta)
      return pt() * std::cosh(eta());
   }

eta()

double xAOD::Egamma_v1::eta ( ) const

finaloverridevirtualinherited

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

Implements xAOD::IParticle.

Definition at line 71 of file Egamma_v1.cxx.

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

genvecP4()

Egamma_v1::GenVecFourMom_t xAOD::Egamma_v1::genvecP4 ( ) const

inherited

The full 4-momentum of the particle : internal egamma type.

Depends on return value optimization.

Definition at line 82 of file Egamma_v1.cxx.

                                                   {
  return GenVecFourMom_t(pt(), eta(), phi(), m());
}

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

isGoodOQ()

bool xAOD::Egamma_v1::isGoodOQ ( uint32_t mask ) const

inherited

Check object quality. Return True is it is Good Object Quality.

Object Quality.

Definition at line 225 of file Egamma_v1.cxx.

                                            {
  static const Accessor< uint32_t > acc( "OQ" );
  uint32_t OQ = acc(*this);
  return (OQ & mask)==0;
}

isolation() [1/2]

float xAOD::Egamma_v1::isolation ( const Iso::IsolationType information ) const

inherited

Accessor to Isolation values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 255 of file Egamma_v1.cxx.

                                                                     {
  const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
  if( !acc ) throw std::runtime_error( "Unknown/Unavailable Isolation type requested" );
  return  ( *acc )(*this);
}

isolation() [2/2]

bool xAOD::Egamma_v1::isolation ( float & value, const Iso::IsolationType information ) const

inherited

Accessor for Isolation values.

Isolation value.

Definition at line 242 of file Egamma_v1.cxx.

                                                                                  {
  const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
  if( !acc ) {
    return false;
  }
  if(!acc->isAvailable(*this) ) {
    return  false;
  }
  // Retrieve the value:
  value = ( *acc )(*this);
  return true;
}

isolationCaloCorrection() [1/4]

float xAOD::Egamma_v1::isolationCaloCorrection ( const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param ) const

inherited

Accessor for flavour and type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 281 of file Egamma_v1.cxx.

                                                                                           {
 
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
  if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
  return  acc(*this);
}

isolationCaloCorrection() [2/4]

bool xAOD::Egamma_v1::isolationCaloCorrection ( float & value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param ) const

inherited

Accessor for flavour and type depended Isolation Calo correction.

Isolation corrections.

Definition at line 270 of file Egamma_v1.cxx.

                                                                                          {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
  if(!acc.isAvailable(*this) ) {
    return  false;
  }
  // Retrieve the value:
  value = acc(*this);
  return true;
}

isolationCaloCorrection() [3/4]

bool xAOD::Egamma_v1::isolationCaloCorrection ( float & value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr ) const

inherited

Accessor for type depended Isolation Calo correction.

Definition at line 297 of file Egamma_v1.cxx.

                                                                                                                   {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
  if(!acc.isAvailable(*this) ) {
    return  false;
  }
  // Retrieve the value:
  value = acc(*this);
  return true;
}

isolationCaloCorrection() [4/4]

float xAOD::Egamma_v1::isolationCaloCorrection ( Iso::IsolationType type, Iso::IsolationCaloCorrection corr ) const

inherited

Accessor for type depended Isolation Calo corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 307 of file Egamma_v1.cxx.

                                                                                                    {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
  if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
  return  acc(*this);
}

isolationCorrectionBitset() [1/2]

std::bitset< 32 > xAOD::Egamma_v1::isolationCorrectionBitset ( const Iso::IsolationFlavour flavour ) const

inherited

Accessor to Isolation corection Bitset , this just returns the bitset without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 352 of file Egamma_v1.cxx.

                                                                                          {
  const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
  if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation BitSet requested" );}
  return  {acc(*this)};
}

isolationCorrectionBitset() [2/2]

bool xAOD::Egamma_v1::isolationCorrectionBitset ( std::bitset< 32 > & value, const Iso::IsolationFlavour flavour ) const

inherited

Accessor for Isolation corection Bitset.

Definition at line 342 of file Egamma_v1.cxx.

                                                                                                        {
  const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
  if(!acc.isAvailable(*this) ) {
    return false;
  }
  // Retrieve the value:
  value =  std::bitset<32>(acc(*this));
  return true;
}

isolationTrackCorrection() [1/2]

float xAOD::Egamma_v1::isolationTrackCorrection ( const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr ) const

inherited

Accessor to Isolation Track corrections , this just returns the correction without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 329 of file Egamma_v1.cxx.

                                                                                                                        {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
  if( !acc.isAvailable(*this) ) {throw std::runtime_error( "Unknown/Unavailable Isolation correction requested" );}
  return  acc(*this);
}

isolationTrackCorrection() [2/2]

bool xAOD::Egamma_v1::isolationTrackCorrection ( float & value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr ) const

inherited

Accessor for Isolation Track correction.

Definition at line 319 of file Egamma_v1.cxx.

                                                                                                                                     {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
  if(!acc.isAvailable(*this) ) {
    return  false;
  }
  // Retrieve the value:
  value = acc(*this);
  return true;
}

isolationValue() [1/2]

float xAOD::Egamma_v1::isolationValue ( const Iso::IsolationType information ) const

inlineinherited

old Accessor to Isolation values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

Definition at line 257 of file Egamma_v1.h.

                                                                  {
 
      return isolation(information);
    }

isolationValue() [2/2]

bool xAOD::Egamma_v1::isolationValue ( float & value, const Iso::IsolationType information ) const

inlineinherited

old Accessor for Isolation values.

Definition at line 251 of file Egamma_v1.h.

                                                                                 {
 
      return isolation(value,information);
    }

likelihoodValue() [1/2]

float xAOD::Egamma_v1::likelihoodValue ( const std::string & LHValue = std::string("LHValue") ) const

inherited

Return the LH value as float If the LH Value is not stored in this xAOD::Egamma, an exception will occur.

likelihoodValue() [2/2]

bool xAOD::Egamma_v1::likelihoodValue ( float & value, const std::string & LHValue = std::string("LHValue") ) const

inherited

Return the LH value as float If the LH decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

m()

double xAOD::Photon_v1::m ( ) const

finaloverridevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 42 of file Photon_v1.cxx.

                             {
      return ParticleConstants::photonMassInMeV;
   }

nCaloClusters()

size_t xAOD::Egamma_v1::nCaloClusters ( ) const

inherited

Return the number of xAOD::CaloClusters that define the electron candidate.

Implementation of the CaloCluster accessor functions.

Definition at line 366 of file Egamma_v1.cxx.

                                      {
 
  static const SG::AuxElement::Accessor< Egamma_v1::CLELVec_t >
    clusterAcc( "caloClusterLinks" );
 
  if( clusterAcc.isAvailable(*this) ) {
    return clusterAcc(*this).size();
  }
  return 0;
}

nVertices()

size_t xAOD::Photon_v1::nVertices

(

)

const

Return the number xAOD::Vertex/vertices that match the photon candidate.

operator=()

Photon_v1 & xAOD::Photon_v1::operator=

(

const Photon_v1 &

el

)

Assignment Operator. Ends up using the assignment of AuxElement for the store.

Definition at line 28 of file Photon_v1.cxx.

                                                   {
 
    if (this != &ph){ // protect against invalid self-assignment      
      this->Egamma_v1::operator=( ph );
    }
    // by convention, always return *this
    return *this;
  }  

OQ()

uint32_t xAOD::Egamma_v1::OQ ( ) const

inherited

Return the object quality bit word.

Definition at line 231 of file Egamma_v1.cxx.

                            {
  static const Accessor< uint32_t > acc( "OQ" );
  return acc(*this) ;
}

p4()

Egamma_v1::FourMom_t xAOD::Egamma_v1::p4 ( ) const

finaloverridevirtualinherited

The full 4-momentum of the particle as a TLoretzVector.

Implements xAOD::IParticle.

Definition at line 94 of file Egamma_v1.cxx.

                                       {
  FourMom_t p4;
  p4.SetPtEtaPhiM( pt(), eta(), phi(),m());
  return p4;
}

passSelection() [1/2]

bool xAOD::Egamma_v1::passSelection ( bool & value, const std::string & menu ) const

inherited

Check if the egamma object pass a selection menu (using the name) If the menu decision is stored in this xAOD::Egamma, then the function fills 'value' with the decision (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

passSelection() [2/2]

bool xAOD::Egamma_v1::passSelection ( const std::string & menu ) const

inherited

Check if the egamma object pass a selection menu (using the name) If the particular menu decision is not stored in this xAOD::Egamma, an exception will occur.

phi()

double xAOD::Egamma_v1::phi ( ) const

finaloverridevirtualinherited

The azimuthal angle ( \(\phi\)) of the particle.

Implements xAOD::IParticle.

Definition at line 76 of file Egamma_v1.cxx.

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

pt()

double xAOD::Egamma_v1::pt ( ) const

finaloverridevirtualinherited

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

Implements xAOD::IParticle.

Definition at line 66 of file Egamma_v1.cxx.

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

rapidity()

double xAOD::Photon_v1::rapidity ( ) const

finaloverridevirtual

The true rapidity (y) of the particle.

Reimplemented from xAOD::Egamma_v1.

Definition at line 51 of file Photon_v1.cxx.

                                    {
      // massless rapidity is the same as pseudorapidity
      return eta();
   }

selectionisEM() [1/2]

unsigned int xAOD::Egamma_v1::selectionisEM ( const std::string & isEM ) const

inherited

Return the isEM word for a selection menu (using the name) If the particular isEM word is not stored in this xAOD::Egamma, an exception will occur.

Definition at line 431 of file Egamma_v1.cxx.

                                                                {
  const SG::AuxElement::Accessor< unsigned int > acc( isEM );
  return acc(*this);
}

selectionisEM() [2/2]

bool xAOD::Egamma_v1::selectionisEM ( unsigned int & value, const std::string & isEM ) const

inherited

Return the isEM word for a selection menu If the menu isEM is stored in this xAOD::Egamma, then the function fills 'value' with the isEM (reference) and returns 'true', otherwise it returns 'false', and does not touch 'value'.

Definition at line 422 of file Egamma_v1.cxx.

                                                                              {
  const SG::AuxElement::Accessor< unsigned int > acc( isEM );
  if(!acc.isAvailable(*this) ) {
    return  false;
  }
  value= acc(*this);
  return true;
}

setAuthor()

void xAOD::Egamma_v1::setAuthor ( uint16_t newAuthor )

inherited

set author

Definition at line 167 of file Egamma_v1.cxx.

                                            {
  static const Accessor< uint16_t > acc( "author" );
  acc(*this) = newAuthor;
}

setCaloClusterLinks()

void xAOD::Egamma_v1::setCaloClusterLinks ( const CLELVec_t & links )

inherited

set Pointer to the xAOD::CaloCluster

setCovMatrix()

void xAOD::Egamma_v1::setCovMatrix ( const EgammaCovMatrix_t & cov )

inherited

set the 4x4 symmetric covariance matrix .

Definition at line 147 of file Egamma_v1.cxx.

                                                                 {
  //The internal storage is an std::vector
  static const Accessor< std::vector < float > > acc( "EgammaCovarianceMatrix" );
  //from >21.0.11
  MatrixHelpers::compress(cov,acc(*this));
}

setEta()

void xAOD::Egamma_v1::setEta ( float eta )

inherited

set the eta

Definition at line 114 of file Egamma_v1.cxx.

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

setIsolation()

bool xAOD::Egamma_v1::setIsolation ( float value, const Iso::IsolationType information )

inherited

set method for Isolation values.

Definition at line 261 of file Egamma_v1.cxx.

                                                                            {
  const SG::AuxElement::Accessor< float >* acc = getIsolationAccessor( information );
  if( !acc ) return false;
  // Set the value:
  ( *acc )(*this) = value;
  return true;
}

setIsolationCaloCorrection() [1/2]

bool xAOD::Egamma_v1::setIsolationCaloCorrection ( float value, const Iso::IsolationFlavour flavour, const Iso::IsolationCaloCorrection corr, const Iso::IsolationCorrectionParameter param )

inherited

set method for flavour and type depended Isolation Calo Corrections.

Definition at line 289 of file Egamma_v1.cxx.

                                                                                       {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr,param);
  // Set the value:
  acc(*this) = value;
  return true;
}

setIsolationCaloCorrection() [2/2]

bool xAOD::Egamma_v1::setIsolationCaloCorrection ( float value, Iso::IsolationType type, Iso::IsolationCaloCorrection corr )

inherited

set method for type depended Isolation Calo Corrections.

Definition at line 313 of file Egamma_v1.cxx.

                                                                                                             {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(type,corr);
  acc(*this) = value;
  return true;
}

setIsolationCorrectionBitset()

bool xAOD::Egamma_v1::setIsolationCorrectionBitset ( uint32_t value, const Iso::IsolationFlavour flavour )

inherited

Set method for Isolation corection Bitset.

Definition at line 358 of file Egamma_v1.cxx.

                                                                                               {
  const SG::AuxElement::Accessor< uint32_t > acc = getIsolationCorrectionBitsetAccessor( flavour );
  // Set the value:
  acc(*this) = value;
  return true;
}

setIsolationTrackCorrection()

bool xAOD::Egamma_v1::setIsolationTrackCorrection ( float value, const Iso::IsolationFlavour flavour, const Iso::IsolationTrackCorrection corr )

inherited

Set method for Isolation Track Corrections.

Definition at line 335 of file Egamma_v1.cxx.

                                                                                                                                 {
  const SG::AuxElement::Accessor< float > acc = getIsolationCorrectionAccessor(flavour,corr);
  // Set the value:
  acc(*this) = value;
  return true;
}

setIsolationValue()

bool xAOD::Egamma_v1::setIsolationValue ( float value, const Iso::IsolationType information )

inlineinherited

old set method for Isolation values.

Definition at line 262 of file Egamma_v1.h.

                                                                           {
      return setIsolation(value,information);
    }

setLikelihoodValue()

void xAOD::Egamma_v1::setLikelihoodValue ( float value, const std::string & LHValue = std::string("LHValue") )

inherited

Set the LHValue as float.

setOQ()

void xAOD::Egamma_v1::setOQ ( uint32_t newOQ )

inherited

Set the object quality.

Definition at line 236 of file Egamma_v1.cxx.

                                    {
  static const Accessor< uint32_t > acc( "OQ" );
  acc(*this) = newOQ;
}

setPassSelection()

void xAOD::Egamma_v1::setPassSelection ( bool value, const std::string & menu )

inherited

Set the selection decision for a menu (using the name).

setPhi()

void xAOD::Egamma_v1::setPhi ( float phi )

inherited

set the phi

Definition at line 119 of file Egamma_v1.cxx.

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

setPt()

void xAOD::Egamma_v1::setPt ( float pt )

inherited

set the Pt

Definition at line 109 of file Egamma_v1.cxx.

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

setPtEtaPhi()

void xAOD::Egamma_v1::setPtEtaPhi ( float pt, float eta, float phi )

inherited

set the 4-vec

Definition at line 100 of file Egamma_v1.cxx.

                                                         {
  static const Accessor< float > acc1( "pt" );
  acc1(*this) = pt;
  static const Accessor< float > acc2( "eta" );
  acc2(*this) = eta;
  static const Accessor< float > acc3( "phi" );
  acc3(*this) = phi;
}

setSelectionisEM()

void xAOD::Egamma_v1::setSelectionisEM ( unsigned int value, const std::string & isEM )

inherited

Set the isEM word for a selection menu (using the name).

Definition at line 436 of file Egamma_v1.cxx.

                                                                         {
  const SG::AuxElement::Accessor< unsigned int > acc( isEM );
  acc(*this)=value;
}

setShowerShapeValue()

bool xAOD::Egamma_v1::setShowerShapeValue ( float value, const EgammaParameters::ShowerShapeType information )

inherited

Set method for Shower Shape values.

Definition at line 215 of file Egamma_v1.cxx.

                                                                                                 {
  const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
  if( !acc ) return false;
  // Set the value:
  ( *acc )(*this) = value;
  return true;
 
}

setVertexCaloMatchValue()

bool xAOD::Photon_v1::setVertexCaloMatchValue	(	const float	value,
		const EgammaParameters::VertexCaloMatchType	information )

Set method for CaloMatch values.

setVertexLinks()

void xAOD::Photon_v1::setVertexLinks

(

const VxELVec_t &

links

)

set Pointer to the xAOD::vertex/vertices that match the photon candidate

showerShapeValue() [1/2]

float xAOD::Egamma_v1::showerShapeValue ( const EgammaParameters::ShowerShapeType information ) const

inherited

Accessor to ShowerShape values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the variable is not available

Definition at line 209 of file Egamma_v1.cxx.

                                                                                          {
  const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
  if(!acc ) throw std::runtime_error( "Unknown/Unavailable Shower Shape type requested" );
  return ( *acc )(*this);
}

showerShapeValue() [2/2]

bool xAOD::Egamma_v1::showerShapeValue ( float & value, const EgammaParameters::ShowerShapeType information ) const

inherited

Accessor for ShowerShape values.

shower shapes

Definition at line 196 of file Egamma_v1.cxx.

                                                                                                       {
  const xAOD::Egamma_v1::Accessor< float >* acc = showerShapeAccessorV1( information );
  if( !acc ) {
    return false;
  }
  if(!acc->isAvailable(*this) ) {
    return  false;
  }
  // Retrieve the value:
  value = ( *acc )(*this);
  return true;
}

type()

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

finaloverridevirtual

The type of the object as a simple enumeration.

Implements xAOD::Egamma_v1.

Definition at line 37 of file Photon_v1.cxx.

                                        {
 
      return Type::Photon;
   }

vertex()

const xAOD::Vertex * xAOD::Photon_v1::vertex

(

size_t

index = 0

)

const

Pointer to the xAOD::Vertex/es that match the photon candidate.

Definition at line 61 of file Photon_v1.cxx.

                                                           {
 
      if( index >= nVertices() ) {
         return nullptr;
      }
      const VxELVec_t& links = vertexLinks();
      if( ! links[ index ].isValid() ) {
         return nullptr;
      }
      return *( links[ index ] );
   }

vertexCaloMatchValue() [1/2]

float xAOD::Photon_v1::vertexCaloMatchValue

(

const EgammaParameters::VertexCaloMatchType

information

)

const

Accessor to vertex to Calo Match Values , this just returns the value without internaly checking if it exists.

Will lead to an exception if the information is not available

vertexCaloMatchValue() [2/2]

bool xAOD::Photon_v1::vertexCaloMatchValue	(	float &	value,
		const EgammaParameters::VertexCaloMatchType	information ) const

Accessor to vertex to Calo Match Values If 'information' is stored in this xAOD::Egamma and is of the correct type, then the function fills 'value' and returns 'true', otherwise it returns 'false', and does not touch 'value'.

vertexLink()

const ElementLink< VertexContainer > & xAOD::Photon_v1::vertexLink

(

size_t

index = 0

)

const

ElementLink to the xAOD::vertex/es that match the electron candidate.

Definition at line 74 of file Photon_v1.cxx.

                                             {
 
      if( index >= nVertices() ) {
         static const ElementLink< VertexContainer > dummy;
         return dummy;
      }
      return vertexLinks()[ index ];
   }

vertexLinks()

const VxELVec_t & xAOD::Photon_v1::vertexLinks

(

)

const

Get all vertex links.

---

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

• Photon_v1.h
• Photon_v1.cxx