#include <TauConstituent.h>

Inheritance diagram for PanTau::TauConstituent:

Collaboration diagram for PanTau::TauConstituent:

Public Types
enum	Type { t_NoType = 0 , t_Charged = 1 , t_Neutral = 2 , t_Pi0Neut = 3 , t_nTypes = 8 }
	Type enumeration to specify type of this tau constituent. More...

Public Member Functions
	TauConstituent ()
	Default Constructor for POOL.
	TauConstituent (const TLorentzVector &itsMomentum, int itsCharge, const std::vector< int > &itsType, double itsBDTValue, const xAOD::PFO *itsPFO)
virtual	~TauConstituent ()
	Destructor.
	TauConstituent (const TauConstituent &tauConst)
	Copy Constructor.
TauConstituent &	operator= (const TauConstituent &tauConst)
	Assignment operator.
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.

Static Public Member Functions
static double	DefaultBDTValue ()
static double	DefaultCharge ()
static std::string	AllConstituentsName ()
static std::string	getTypeName (PanTau::TauConstituent::Type aType)
static bool	isNeutralType (int tauConstituentType)

xAOD::IParticle functions
These are already virtual due to IParticle
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
FourMom_t	m_p4
	4-momentum object
std::vector< int >	m_TypeFlags
double	m_BDTValue
int	m_Charge
const xAOD::PFO *	m_PFO
std::vector< TauConstituent * >	m_Shots
int	m_nPhotonsInShot
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.
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 as a TLorentzVector.
virtual xAOD::Type::ObjectType	type () const
	The type of the object as a simple enumeration, remains pure virtual in e/gamma.
void	setP4 (float pt, float eta, float phi, float m)
	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
void	setM (float m)
	set the Mass
void	removeTypeFlag (TauConstituent::Type aType)
std::vector< std::string >	getTypeName () const
std::string	getTypeNameString () const
const std::vector< int > &	getTypeFlags () const
bool	isOfType (TauConstituent::Type aType) const
double	getBDTValue () const
int	getCharge () const
const xAOD::PFO *	getPFO () const
void	addShot (TauConstituent *shot)
const std::vector< TauConstituent * > &	getShots () const
unsigned int	getNShots () const
void	setNPhotonsInShot (int nPhotons)
int	getNPhotonsInShot () const

Detailed Description

Input object for PanTau.

Mainly a 4-vector with additional information about its type (charged, neutral, pi0 tagged)

Author: limba.nosp@m.ch@p.nosp@m.hysik.nosp@m..uni.nosp@m.-bonn.nosp@m..de

Definition at line 25 of file TauConstituent.h.

Member Typedef Documentation

◆ FourMom_t

typedef IParticle::FourMom_t PanTau::TauConstituent::FourMom_t

Definition of the 4-momentum type.

Definition at line 110 of file TauConstituent.h.

Member Enumeration Documentation

◆ Type

enum PanTau::TauConstituent::Type

Type enumeration to specify type of this tau constituent.

t_NoType: This is used in default constructors when no type is specified t_Charged: Used to represent objects considered as 'charged' by input substructure reco t_Neutral: Use for objects considered neutral by input substructure algorithm t_Pi0Neut: If a particle passes pi0 ID, use this flag t_OutChrg: Charged objects in 0.2 to 0.4 t_OutNeut: Neutral objects in 0.2 to 0.4 t_NeutLowA: (Core) Neutrals with lower Et cut -> removed t_NeutLowB: (Core) Neutrals with even lower Et cut -> removed t_nTypes: Dont use this, just tell number of types

Enumerator
t_NoType
t_Charged
t_Neutral
t_Pi0Neut
t_nTypes

Definition at line 42 of file TauConstituent.h.

              {
        t_NoType    = 0,
        t_Charged   = 1,
        t_Neutral   = 2,
        t_Pi0Neut   = 3,
        //t_OutChrg   = 4,
        //t_OutNeut   = 5,
        //t_NeutLowA  = 6,
        //t_NeutLowB  = 7,
        t_nTypes    = 8
    };

Constructor & Destructor Documentation

◆ TauConstituent() [1/3]

PanTau::TauConstituent::TauConstituent ( )

Default Constructor for POOL.

Do not use!

Definition at line 7 of file TauConstituent.cxx.

                                     :
  IParticle(),
  m_p4(),
  m_TypeFlags(),
  m_BDTValue(PanTau::TauConstituent::DefaultBDTValue()),
  m_Charge(PanTau::TauConstituent::DefaultCharge()),
  m_PFO(nullptr),
  m_Shots(),
  m_nPhotonsInShot(0)
{
}

◆ TauConstituent() [2/3]

PanTau::TauConstituent::TauConstituent	(	const TLorentzVector &	itsMomentum,
		int	itsCharge,
		const std::vector< int > &	itsType,
		double	itsBDTValue,
		const xAOD::PFO *	itsPFO )

Parameters

itsMomentum	The P4EEtaPhiM of this particle
itsType	The type of this particle using this class' enumeration
itsBDTValue	If a BDT was used ot ID this particle, provide the BDT response

Definition at line 20 of file TauConstituent.cxx.

                                              :
  IParticle(),
  m_p4(itsMomentum),
  m_TypeFlags(itsType),
  m_BDTValue(itsBDTValue),
  m_Charge(itsCharge),
  m_PFO(itsPFO),
  m_Shots(),
  m_nPhotonsInShot(0)
{
}

◆ ~TauConstituent()

PanTau::TauConstituent::~TauConstituent ( )

virtual

Destructor.

Definition at line 42 of file TauConstituent.cxx.

{
  //delete the shot constituents
  for(unsigned int iShot=0; iShot<m_Shots.size(); iShot++) {
    PanTau::TauConstituent* curConst = m_Shots[iShot];
    delete curConst;
  }
}

◆ TauConstituent() [3/3]

PanTau::TauConstituent::TauConstituent ( const TauConstituent & tauConst )

default

Copy Constructor.

Member Function Documentation

◆ addShot()

void PanTau::TauConstituent::addShot ( TauConstituent * shot )

Definition at line 232 of file TauConstituent.cxx.

                                                       {
  if(shot != nullptr) m_Shots.push_back(shot);
}

◆ AllConstituentsName()

std::string PanTau::TauConstituent::AllConstituentsName ( )

inlinestatic

Definition at line 56 of file TauConstituent.h.

56{return "All";}

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

◆ DefaultBDTValue()

double PanTau::TauConstituent::DefaultBDTValue ( )

inlinestatic

Definition at line 54 of file TauConstituent.h.

54{return -4711.1337;}

◆ DefaultCharge()

double PanTau::TauConstituent::DefaultCharge ( )

inlinestatic

Definition at line 55 of file TauConstituent.h.

55{return -47111337;}

◆ e()

double PanTau::TauConstituent::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 92 of file TauConstituent.cxx.

                                    {
  return p4().E(); 
}

◆ eta()

double PanTau::TauConstituent::eta ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 77 of file TauConstituent.cxx.

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

◆ getBDTValue()

double PanTau::TauConstituent::getBDTValue ( ) const

Definition at line 203 of file TauConstituent.cxx.

                                               {
  return m_BDTValue;
}

◆ getCharge()

int PanTau::TauConstituent::getCharge ( ) const

Definition at line 222 of file TauConstituent.cxx.

                                          {
  return m_Charge;
}

◆ getNPhotonsInShot()

int PanTau::TauConstituent::getNPhotonsInShot ( ) const

Definition at line 252 of file TauConstituent.cxx.

                                                  {
  return m_nPhotonsInShot;
}

◆ getNShots()

unsigned int PanTau::TauConstituent::getNShots ( ) const

Definition at line 242 of file TauConstituent.cxx.

                                                   {
  return m_Shots.size();
}

◆ getPFO()

const xAOD::PFO * PanTau::TauConstituent::getPFO ( ) const

Definition at line 227 of file TauConstituent.cxx.

                                                  {
  return m_PFO;
}

◆ getShots()

const std::vector< PanTau::TauConstituent * > & PanTau::TauConstituent::getShots ( ) const

Definition at line 237 of file TauConstituent.cxx.

                                                                             {
  return m_Shots;
}

◆ getTypeFlags()

const std::vector< int > & PanTau::TauConstituent::getTypeFlags ( ) const

Definition at line 208 of file TauConstituent.cxx.

                                                               {
  return m_TypeFlags;
}

◆ getTypeName() [1/2]

std::vector< std::string > PanTau::TauConstituent::getTypeName ( ) const

Definition at line 180 of file TauConstituent.cxx.

                                                             {
  std::vector<std::string> res;
  for(unsigned int iType=0; iType<TauConstituent::t_nTypes; iType++) {
    if(m_TypeFlags[iType] == 1) {
      PanTau::TauConstituent::Type curType = (PanTau::TauConstituent::Type)iType;
      res.push_back( TauConstituent::getTypeName(curType) );
    }
  }
  return res;
}

◆ getTypeName() [2/2]

std::string PanTau::TauConstituent::getTypeName ( PanTau::TauConstituent::Type aType )

static

Definition at line 158 of file TauConstituent.cxx.

                                                                           {
  switch(aType) {
  case PanTau::TauConstituent::t_Charged: return "Charged";
  case PanTau::TauConstituent::t_Neutral: return "Neutral";
  case PanTau::TauConstituent::t_Pi0Neut: return "Pi0Neut";
  case PanTau::TauConstituent::t_NoType: return "All";
  default: return "UnkownType";
  }
}

◆ getTypeNameString()

std::string PanTau::TauConstituent::getTypeNameString ( ) const

Definition at line 192 of file TauConstituent.cxx.

                                                        {
  std::string res;
  for(unsigned int iType=0; iType<m_TypeFlags.size(); iType++) {
    if(m_TypeFlags[iType] == 1) {
      res += PanTau::TauConstituent::getTypeName((PanTau::TauConstituent::Type)(iType)) + ",";
    }
  }
  return res;
}

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

◆ isNeutralType()

bool PanTau::TauConstituent::isNeutralType ( int tauConstituentType )

static

Definition at line 169 of file TauConstituent.cxx.

                                                               {
  PanTau::TauConstituent::Type type = (PanTau::TauConstituent::Type)tauConstituentType;
  switch(type) {
  case PanTau::TauConstituent::t_Neutral: return true;
  case PanTau::TauConstituent::t_Pi0Neut: return true;
  default: return false;
  }
  return false;
}

◆ isOfType()

bool PanTau::TauConstituent::isOfType ( TauConstituent::Type aType ) const

Definition at line 213 of file TauConstituent.cxx.

                                                                          {
  if(theType >= static_cast<int>(TauConstituent::t_nTypes)) {
    return false;
  }
  if(m_TypeFlags.at( static_cast<int>(theType)) == 1) return true;
  return false;
}

◆ m()

double PanTau::TauConstituent::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 87 of file TauConstituent.cxx.

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

◆ operator=()

PanTau::TauConstituent & PanTau::TauConstituent::operator= ( const TauConstituent & tauConst )

Assignment operator.

Definition at line 52 of file TauConstituent.cxx.

{
  if (this!=&tauConst){
 
    if (!this->container() && !this->hasStore() ) {      
      makePrivateStore();
    }
    this->IParticle::operator=( tauConst );
    this->m_p4 = tauConst.m_p4;
    m_TypeFlags = tauConst.m_TypeFlags;
    m_BDTValue  = tauConst.m_BDTValue;
    m_Charge    = tauConst.m_Charge;
    m_PFO       = tauConst.m_PFO;
    m_Shots     = tauConst.m_Shots;
    m_nPhotonsInShot = tauConst.m_nPhotonsInShot;
  }
  return *this;
}

◆ p4()

PanTau::TauConstituent::FourMom_t PanTau::TauConstituent::p4 ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 100 of file TauConstituent.cxx.

                                                             {
  return m_p4;
}

◆ phi()

double PanTau::TauConstituent::phi ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 82 of file TauConstituent.cxx.

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

◆ pt()

double PanTau::TauConstituent::pt ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 72 of file TauConstituent.cxx.

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

◆ rapidity()

double PanTau::TauConstituent::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 96 of file TauConstituent.cxx.

                                            {
  return p4().Rapidity(); 
}

◆ removeTypeFlag()

void PanTau::TauConstituent::removeTypeFlag ( TauConstituent::Type aType )

Definition at line 151 of file TauConstituent.cxx.

                                                                  {
  unsigned int typeIndex = (unsigned int)aType;
  m_TypeFlags.at(typeIndex) = 0;
}

◆ setEta()

void PanTau::TauConstituent::setEta ( float eta )

set the eta

Definition at line 124 of file TauConstituent.cxx.

                                          {
  static const Accessor< float > acc( "eta" );
  acc( *this ) = eta;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta, phi(), m());
}

◆ setM()

void PanTau::TauConstituent::setM ( float m )

set the Mass

Definition at line 138 of file TauConstituent.cxx.

                                      {
  static const Accessor< float > acc( "m" );
  acc( *this ) = m;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta(), phi(), m);
}

◆ setNPhotonsInShot()

void PanTau::TauConstituent::setNPhotonsInShot ( int nPhotons )

Definition at line 247 of file TauConstituent.cxx.

                                                         {
  m_nPhotonsInShot = nPhotons;
}

◆ setP4()

void PanTau::TauConstituent::setP4	(	float	pt,
		float	eta,
		float	phi,
		float	m )

set the 4-vec

Definition at line 104 of file TauConstituent.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;
  static const Accessor< float > acc4( "m" );
  acc4( *this ) = m;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt, eta, phi, m);
}

◆ setPhi()

void PanTau::TauConstituent::setPhi ( float phi )

set the phi

Definition at line 131 of file TauConstituent.cxx.

                                          {
  static const Accessor< float > acc( "phi" );
  acc( *this ) = phi;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt(), eta(), phi, m());
}

◆ setPt()

void PanTau::TauConstituent::setPt ( float pt )

set the Pt

Definition at line 117 of file TauConstituent.cxx.

                                        {
  static const Accessor< float > acc( "pt" );
  acc( *this ) = pt;
  //Need to recalculate m_p4
  m_p4.SetPtEtaPhiM( pt, eta(), phi(), m());
}

◆ type()

xAOD::Type::ObjectType PanTau::TauConstituent::type ( ) const

virtual

The type of the object as a simple enumeration, remains pure virtual in e/gamma.

Implements xAOD::IParticle.

Definition at line 146 of file TauConstituent.cxx.

                                                    {
  return xAOD::Type::ParticleFlow;
}

Member Data Documentation

◆ m_BDTValue

double PanTau::TauConstituent::m_BDTValue

protected

Definition at line 163 of file TauConstituent.h.

◆ m_Charge

int PanTau::TauConstituent::m_Charge

protected

Definition at line 164 of file TauConstituent.h.

◆ m_nPhotonsInShot

int PanTau::TauConstituent::m_nPhotonsInShot

protected

Definition at line 170 of file TauConstituent.h.

◆ m_p4

FourMom_t PanTau::TauConstituent::m_p4

private

4-momentum object

Definition at line 157 of file TauConstituent.h.

◆ m_PFO

const xAOD::PFO* PanTau::TauConstituent::m_PFO

protected

Definition at line 166 of file TauConstituent.h.

◆ m_Shots

std::vector<TauConstituent*> PanTau::TauConstituent::m_Shots

protected

Definition at line 169 of file TauConstituent.h.

◆ m_TypeFlags

std::vector<int> PanTau::TauConstituent::m_TypeFlags

protected

Definition at line 162 of file TauConstituent.h.

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

Public Types

Public Member Functions

Static Public Member Functions

xAOD::IParticle functions

Detailed Description

Member Typedef Documentation

◆ FourMom_t

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ TauConstituent() [1/3]

◆ TauConstituent() [2/3]

◆ ~TauConstituent()

◆ TauConstituent() [3/3]

Member Function Documentation

◆ addShot()

◆ AllConstituentsName()

◆ auxdata() [1/2]

◆ auxdata() [2/2]

◆ DefaultBDTValue()

◆ DefaultCharge()

◆ e()

◆ eta()

◆ getBDTValue()

◆ getCharge()

◆ getNPhotonsInShot()

◆ getNShots()

◆ getPFO()

◆ getShots()

◆ getTypeFlags()

◆ getTypeName() [1/2]

◆ getTypeName() [2/2]

◆ getTypeNameString()

◆ isAvailable()

◆ isAvailableWritable()

◆ isNeutralType()

◆ isOfType()

◆ m()

◆ operator=()

◆ p4()

◆ phi()

◆ pt()

◆ rapidity()

◆ removeTypeFlag()

◆ setEta()

◆ setM()

◆ setNPhotonsInShot()

◆ setP4()

◆ setPhi()

◆ setPt()

◆ type()

Member Data Documentation

◆ m_BDTValue

◆ m_Charge

◆ m_nPhotonsInShot

◆ m_p4

◆ m_PFO

◆ m_Shots

◆ m_TypeFlags