xAOD::Jet_v1 Class Reference

Class describing a jet. More...

#include <Jet_v1.h>

Inheritance diagram for xAOD::Jet_v1:

Collaboration diagram for xAOD::Jet_v1:

Public Types
typedef JetAttribute::AttributeID	AttributeID
typedef JetAttribute::AssoParticlesID	AssoParticlesID

Public Member Functions
	Jet_v1 ()
	Default constructor.
	Jet_v1 (const Jet_v1 &)
	Constructor with the 4-momentum properties of the jet.
	~Jet_v1 ()
Access signal state
access the various signal states of the jets For now provide the minimum by returning only FourMomentum. Access by the enum to the historical states
JetFourMom_t	jetP4 (JetScale s) const
	Access by the enum to the historical states.
JetFourMom_t	genvecP4 (JetScale s) const
JetFourMom_t	jetP4 (const std::string &statename) const
	Generic access to states.
JetFourMom_t	genvecP4 (const std::string &statename) const
void	setJetP4 (const JetFourMom_t &p4)
void	setJetP4 (JetScale s, const JetFourMom_t &p4)
	Access by the enum to the historical states.
void	setJetP4 (const std::string &sname, const JetFourMom_t &p4)
Access to auxiliary data
Functions to retrieve attributes added to jet objects. They concern any attributes (float, vector<float>, 4-momentum,...) except IParticles (for the later see associatedParticles() function below). Access is done by an enum identifier or by string. They internally translate calls using double or vector<double> (ex: getAttribute<double>() ) in calls using float. This guarantees values are saved as float (less disk space) This avoids potential confusions related to retrieving a number as a float or as a double.
template<class T>
bool	getAttribute (AttributeID type, T &value) const
	Retrieve attribute moment by enum.
template<class T>
bool	getAttribute (const std::string &name, T &value) const
	Retrieve attribute by string.
template<class T>
T	getAttribute (const std::string &name) const
	short form : more convenient and compact. Throws an exception if the moment is missing.
template<class T>
T	getAttribute (AttributeID type) const
template<class T>
void	setAttribute (const std::string &name, const T &v)
template<class T>
void	setAttribute (AttributeID type, const T &value)
	Set number by enum.
Access object or list of associated objects
Special functions to store list of objects are provided. The reason is we want to internally store every object as link (ElementLink). The setter and getter functions thus perform the conversion automatically from the internal format from/to const Object* or vector<const Object*>
template<typename T>
std::vector< const T * >	getAssociatedObjects (const std::string &name) const
	get associated objects as a vector<object> this compact form throws an exception if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer
template<typename T>
std::vector< const T * >	getAssociatedObjects (AssoParticlesID type) const
template<typename T>
bool	getAssociatedObjects (const std::string &name, std::vector< const T * > &vec) const
	get associated objects as a vector<object> returns false if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer AND the function returns false
template<typename T>
bool	getAssociatedObjects (AssoParticlesID type, std::vector< const T * > &vec) const
template<typename T>
void	setAssociatedObjects (const std::string &name, const std::vector< const T * > &vec)
	set associated objects from a vector of arbitrary object.
template<typename T>
void	setAssociatedObjects (AssoParticlesID type, const std::vector< const T * > &vec)
template<typename T>
const T *	getAssociatedObject (const std::string &name) const
	get a single associated object this compact form throws an exception if the object is not existing
template<typename T>
const T *	getAssociatedObject (AssoParticlesID type) const
template<typename T>
bool	getAssociatedObject (const std::string &name, const T *&vec) const
	get a single associated object returns false if the object is not existing
template<typename T>
bool	getAssociatedObject (AssoParticlesID type, const T *&vec) const
template<typename T>
void	setAssociatedObject (const std::string &name, const T *vec)
	set a single associated object T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed
template<typename T>
void	setAssociatedObject (AssoParticlesID type, const T *vec)
Metadata like information
float	getSizeParameter () const
JetAlgorithmType::ID	getAlgorithmType () const
JetInput::Type	getInputType () const
void	setSizeParameter (float p)
void	setAlgorithmType (JetAlgorithmType::ID a)
void	setInputType (JetInput::Type t)
Access to internal fastjet object. Reserved to expert usage.
Access to the internal fastjet object. CAN RETURN NULL, see the description of m_pseudoJet
const fastjet::PseudoJet *	getPseudoJet () const
template<class PSEUDOJET>
void	setPseudoJet (const PSEUDOJET *fj)
	Set the fast jet pointer.
void	reset ()
	Function making sure that the object is ready for persistification.
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.

Protected Attributes
FastJetLinkBase *	m_fastJetLink
	Pointer to the fastjet object this jet is build from.

xAOD::IParticle functions
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
Jet_v1 &	operator= (const Jet_v1 &other)
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.
virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration.

Additionnal kinematics for jets.
typedef JetFourMom_t	GenVecFourMom_t
	define enum ot follow naming conventions
JetFourMom_t	jetP4 () const
	The full 4-momentum of the particle : internal jet type.
JetFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : internal jet type (same).
float	px () const
	The x-component of the jet's momentum.
float	py () const
	The y-component of the jet's momentum.
float	pz () const
	The z-component of the jet's momentum.

Jet constituents access
Access to the jet constituents. Constiuents are stored internally as IParticle. getConstituents() returns a special object : JetConstituentVector. The default 4-vectors of the constituents (ex: clusters) possibly differ from the 4-vector used in the jet finding procedure (ex: when find jets with non calibrated "EM scale" clusters). The JetConstituentVector behaves almost exactly as a simple vector<const IParticle*> AND guarantees that the 4-vectors it contains correpond to the 4-vector used at jet finding time. See the JetConstituentVector.h header for more details A direct access method rawConstituent() is provided for experts usage only. jet finding.
void	addConstituent (const ElementLink< IParticleContainer > &link, float weight=1.0)
	Add a constituent directly in the ElementLink format.
void	addConstituent (const IParticle *p, float weight=1.0)
	Add an IParticle as as constituent.
JetConstitScale	getConstituentsSignalState () const
	The state at which constituents were when this jet was found.
void	setConstituentsSignalState (JetConstitScale t)
	Set the state at which constituents were when this jet was found. This function is called by jet builders.
JetConstituentVector	getConstituents () const
	Return a vector of consituents. The object behaves like vector<const IParticle*>. See JetConstituentVector.h header for more details.
size_t	numConstituents () const
	Number of constituents in this jets (this is valid even when reading a file where the constituents have been removed).
const IParticle *	rawConstituent (size_t i) const
	Direct access to constituents. WARNING expert use only.
const std::vector< ElementLink< IParticleContainer > > &	constituentLinks () const
	Direct access to constituents. WARNING expert use only.
void	setNumConstituents (size_t n)

Detailed Description

Class describing a jet.

Jet is a generic class used to represent any "types" of hadronic jet within the Atlas Software. The various "types" of jets include for example jets build from calorimeter cluster or from reconstructed tracks or from truth particle, etc... The Jet class provides 4 main features :

• list of constituents. This list is build by the jet finding algorithm and is the physical definition of the jet object. Methods are provided to set and access constituents as IParticle objects.
• 4-momentum. Accessed through the inherited IParticle interface. A Jet 4-mom is not necessarily the sum of its constituents 4-mom (for ex. if a calibration has been applied).
• Signal States : Jets can hold several other 4-momentum representing various calibration states (primarily used for calo jets). See also P4SignalState
• Attributes : depending on its "type" several other attributes can be added to a jet.
  • numbers, vector of numbers : access through the get/setAttribute functions
  • other IParticles : dedicated functions are provided get/setAssociatedParticles (because of internal I/O details)

Author

Pierre-Antoine Delsart delsa.nosp@m.rt@i.nosp@m.n2p3..nosp@m.fr

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision

795692

Date

2017-02-06 00:08:21 +0100 (Mon, 06 Feb 2017)

Definition at line 57 of file Jet_v1.h.

Member Typedef Documentation

AssoParticlesID

typedef JetAttribute::AssoParticlesID xAOD::Jet_v1::AssoParticlesID

Definition at line 62 of file Jet_v1.h.

AttributeID

typedef JetAttribute::AttributeID xAOD::Jet_v1::AttributeID

Definition at line 61 of file Jet_v1.h.

FourMom_t

typedef IParticle::FourMom_t xAOD::Jet_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 92 of file Jet_v1.h.

GenVecFourMom_t

typedef JetFourMom_t xAOD::Jet_v1::GenVecFourMom_t

define enum ot follow naming conventions

Definition at line 110 of file Jet_v1.h.

Constructor & Destructor Documentation

Jet_v1() [1/2]

xAOD::Jet_v1::Jet_v1

(

)

Default constructor.

Definition at line 14 of file Jet_v1.cxx.

    : IParticle() 
    , m_fastJetLink(nullptr) 
  {
  }

Jet_v1() [2/2]

xAOD::Jet_v1::Jet_v1

(

const Jet_v1 &

o

)

Constructor with the 4-momentum properties of the jet.

Copy constructor

Definition at line 23 of file Jet_v1.cxx.

                                 : IParticle( o )
                                   , m_fastJetLink(nullptr)
  {
    makePrivateStore( o );
    if( o.m_fastJetLink  ) m_fastJetLink = o.m_fastJetLink->clone();    
  }   

~Jet_v1()

xAOD::Jet_v1::~Jet_v1

(

)

Definition at line 39 of file Jet_v1.cxx.

                 {
    if(m_fastJetLink) delete m_fastJetLink;
  }

Member Function Documentation

addConstituent() [1/2]

void xAOD::Jet_v1::addConstituent	(	const ElementLink< IParticleContainer > &	link,
		float	weight = 1.0 )

Add a constituent directly in the ElementLink format.

Definition at line 113 of file Jet_v1.cxx.

                                         {
 
    constituentAcc( *this ).push_back( link );
    constituentWeightAcc( *this ).push_back( w );
    return;
  }

addConstituent() [2/2]

void xAOD::Jet_v1::addConstituent	(	const IParticle *	p,
		float	weight = 1.0 )

Add an IParticle as as constituent.

Warning ! A link to the original container of this particle p will be used internally. Thus one can not persistify correctly constituents from a container in VIEW mode.

Definition at line 121 of file Jet_v1.cxx.

                                                           {
    int idx = c->index();
    const IParticleContainer* pcon =
      dynamic_cast<const IParticleContainer*>(c->container());
    ElementLink<IParticleContainer> el(*pcon, idx);
#if 0
    ElementLink< IParticleContainer > el;
    el.toIndexedElement( *( dynamic_cast< const IParticleContainer* >( c->container() ) ), c->index() );
#endif
    constituentAcc(*this).push_back(el);
    constituentWeightAcc( *this ).push_back( w );
    return;
  }

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

constituentLinks()

const std::vector< ElementLink< IParticleContainer > > & xAOD::Jet_v1::constituentLinks

(

)

const

Direct access to constituents. WARNING expert use only.

Definition at line 173 of file Jet_v1.cxx.

                                                                                       {
    return constituentAcc(*this);
  }

e()

double xAOD::Jet_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 63 of file Jet_v1.cxx.

                          {
     return jetP4().E();
   }

eta()

double xAOD::Jet_v1::eta ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 49 of file Jet_v1.cxx.

                            {
     
     return momentumAcc.eta( *this );
   }

genvecP4() [1/3]

JetFourMom_t xAOD::Jet_v1::genvecP4

(

)

const

The full 4-momentum of the particle : internal jet type (same).

Definition at line 81 of file Jet_v1.cxx.

                                       {
     return jetP4();
   }

genvecP4() [2/3]

JetFourMom_t xAOD::Jet_v1::genvecP4

(

const std::string &

statename

)

const

Definition at line 232 of file Jet_v1.cxx.

                                                                {
    return jetP4(statename);
  }

genvecP4() [3/3]

JetFourMom_t xAOD::Jet_v1::genvecP4

(

JetScale

s

)

const

Definition at line 204 of file Jet_v1.cxx.

                                                {
    return jetP4(s);
  }

getAlgorithmType()

JetAlgorithmType::ID xAOD::Jet_v1::getAlgorithmType

(

)

const

Definition at line 260 of file Jet_v1.cxx.

                                                   {
    return (JetAlgorithmType::ID) algAcc(*this);
  }

getAssociatedObject() [1/4]

template<typename T>

const T * xAOD::Jet_v1::getAssociatedObject

(

AssoParticlesID

type

)

const

getAssociatedObject() [2/4]

template<typename T>

bool xAOD::Jet_v1::getAssociatedObject	(	AssoParticlesID	type,
		const T *&	vec ) const

getAssociatedObject() [3/4]

template<typename T>

const T * xAOD::Jet_v1::getAssociatedObject

(

const std::string &

name

)

const

get a single associated object this compact form throws an exception if the object is not existing

getAssociatedObject() [4/4]

template<typename T>

bool xAOD::Jet_v1::getAssociatedObject	(	const std::string &	name,
		const T *&	vec ) const

get a single associated object returns false if the object is not existing

getAssociatedObjects() [1/4]

template<typename T>

std::vector< const T * > xAOD::Jet_v1::getAssociatedObjects

(

AssoParticlesID

type

)

const

getAssociatedObjects() [2/4]

template<typename T>

bool xAOD::Jet_v1::getAssociatedObjects	(	AssoParticlesID	type,
		std::vector< const T * > &	vec ) const

getAssociatedObjects() [3/4]

template<typename T>

std::vector< const T * > xAOD::Jet_v1::getAssociatedObjects

(

const std::string &

name

)

const

get associated objects as a vector<object> this compact form throws an exception if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer

getAssociatedObjects() [4/4]

template<typename T>

bool xAOD::Jet_v1::getAssociatedObjects	(	const std::string &	name,
		std::vector< const T * > &	vec ) const

get associated objects as a vector<object> returns false if the object is not existing If internal links are invalid (ex: because of thinning) they replaced by a null pointer AND the function returns false

getAttribute() [1/4]

template<class T>

T xAOD::Jet_v1::getAttribute

(

AttributeID

type

)

const

getAttribute() [2/4]

template<class T>

bool xAOD::Jet_v1::getAttribute	(	AttributeID	type,
		T &	value ) const

Retrieve attribute moment by enum.

getAttribute() [3/4]

template<class T>

T xAOD::Jet_v1::getAttribute

(

const std::string &

name

)

const

short form : more convenient and compact. Throws an exception if the moment is missing.

getAttribute() [4/4]

template<class T>

bool xAOD::Jet_v1::getAttribute	(	const std::string &	name,
		T &	value ) const

Retrieve attribute by string.

getConstituents()

JetConstituentVector xAOD::Jet_v1::getConstituents

(

)

const

Return a vector of consituents. The object behaves like vector<const IParticle*>. See JetConstituentVector.h header for more details.

Definition at line 149 of file Jet_v1.cxx.

                                                     {
    
    JetConstituentVector vec( & constituentAcc(*this) , getConstituentsSignalState() );
    return vec;
  }

getConstituentsSignalState()

JetConstitScale xAOD::Jet_v1::getConstituentsSignalState

(

)

const

The state at which constituents were when this jet was found.

Definition at line 138 of file Jet_v1.cxx.

                                                           {
    if( constitScaleAcc.isAvailable(*this) ) return (JetConstitScale)constitScaleAcc(*this);
    return UnknownConstitScale; 
  }

getInputType()

JetInput::Type xAOD::Jet_v1::getInputType

(

)

const

Definition at line 264 of file Jet_v1.cxx.

                                         {
    return (JetInput::Type) inputAcc(*this);
  }

getPseudoJet()

const fastjet::PseudoJet * xAOD::Jet_v1::getPseudoJet

(

)

const

Definition at line 247 of file Jet_v1.cxx.

                                                      {
    if(m_fastJetLink) return m_fastJetLink->pseudoJet;
    return nullptr;
  }

getSizeParameter()

float xAOD::Jet_v1::getSizeParameter

(

)

const

Definition at line 256 of file Jet_v1.cxx.

                                       {
    return spAcc(*this);
  }

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

jetP4() [1/3]

JetFourMom_t xAOD::Jet_v1::jetP4

(

)

const

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

Definition at line 76 of file Jet_v1.cxx.

                                    {
     return momentumAcc.getAttribute( *this);
   }

jetP4() [2/3]

JetFourMom_t xAOD::Jet_v1::jetP4

(

const std::string &

statename

)

const

Generic access to states.

Definition at line 227 of file Jet_v1.cxx.

                                                             {
    if(statename=="JetAssignedScaleMomentum") return jetP4();
    return getAttribute<JetFourMom_t>(statename);
  }

jetP4() [3/3]

JetFourMom_t xAOD::Jet_v1::jetP4

(

JetScale

s

)

const

Access by the enum to the historical states.

Definition at line 192 of file Jet_v1.cxx.

                                             {
   switch( s ){ 
    case JetEMScaleMomentum: return jetEMScaleAcc.getAttribute( *this );
    case JetConstitScaleMomentum : return jetConstitScaleAcc.getAttribute( *this );
    case JetAssignedScaleMomentum: return jetP4();
    default :
      std::cerr << " Error p4(P4SignalState) unknown state "<< s << std::endl;
      break;
    }
    return JetFourMom_t();
  }

m()

double xAOD::Jet_v1::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 59 of file Jet_v1.cxx.

                          {
     return momentumAcc.m( *this );
   }

numConstituents()

size_t xAOD::Jet_v1::numConstituents

(

)

const

Number of constituents in this jets (this is valid even when reading a file where the constituents have been removed).

Definition at line 155 of file Jet_v1.cxx.

                                       {
    int numConstit = 0;
    if(constituentAcc.isAvailable( *this )){
      numConstit = constituentAcc( *this ).size();
    }
    else if(numConstitAcc.isAvailable( *this )){
      numConstit = numConstitAcc( *this );
    }
    else{
      throw std::runtime_error("numConstituents(): neither the aux data item `constituentLinks' nor `numConstit' of the jet is available.");
    }
    return numConstit;
  }

operator=()

Jet_v1 & xAOD::Jet_v1::operator=

(

const Jet_v1 &

other

)

Definition at line 30 of file Jet_v1.cxx.

                                         {
    if(this == &o) return *this;
 
    if( ( ! hasStore() ) && ( ! container() ) ) makePrivateStore();
    this->IParticle::operator=( o );
    if( (o.m_fastJetLink) && (m_fastJetLink==nullptr) ) m_fastJetLink = o.m_fastJetLink->clone();    
    return *this;
  }

p4()

Jet_v1::FourMom_t xAOD::Jet_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 71 of file Jet_v1.cxx.

                                    {
     JetFourMom_t p = jetP4();
     return FourMom_t(p.Px(), p.Py(), p.Pz(), p.E() );
   }

phi()

double xAOD::Jet_v1::phi ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 54 of file Jet_v1.cxx.

                            {
 
     return momentumAcc.phi( *this );
   }

pt()

double xAOD::Jet_v1::pt ( ) const

virtual

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

Implements xAOD::IParticle.

Definition at line 44 of file Jet_v1.cxx.

                           {
 
     return momentumAcc.pt( *this );
   }

px()

float xAOD::Jet_v1::px

(

)

const

The x-component of the jet's momentum.

Assuming that when one of px py pz is called the other will be too. So provoke the build of FourMom_t.

Definition at line 90 of file Jet_v1.cxx.

                          {
 
     return p4().Px();
   }

py()

float xAOD::Jet_v1::py

(

)

const

The y-component of the jet's momentum.

Definition at line 94 of file Jet_v1.cxx.

                          {
 
     return p4().Py();     
   }

pz()

float xAOD::Jet_v1::pz

(

)

const

The z-component of the jet's momentum.

Definition at line 99 of file Jet_v1.cxx.

                          {
 
     return p4().Pz();
   }

rapidity()

double xAOD::Jet_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 67 of file Jet_v1.cxx.

                                 {
     return jetP4().Rapidity();
   }

rawConstituent()

const IParticle * xAOD::Jet_v1::rawConstituent

(

size_t

i

)

const

Direct access to constituents. WARNING expert use only.

Definition at line 169 of file Jet_v1.cxx.

                                                        {
    return * ( constituentAcc(*this)[i]);
  }

reset()

void xAOD::Jet_v1::reset

(

)

Function making sure that the object is ready for persistification.

workaround some I/O limitations

Definition at line 242 of file Jet_v1.cxx.

                     {
    if(m_fastJetLink) delete m_fastJetLink; 
    m_fastJetLink = nullptr;
  }

setAlgorithmType()

void xAOD::Jet_v1::setAlgorithmType

(

JetAlgorithmType::ID

a

)

Definition at line 269 of file Jet_v1.cxx.

{ algAcc(*this) = a;}

setAssociatedObject() [1/2]

template<typename T>

void xAOD::Jet_v1::setAssociatedObject	(	AssoParticlesID	type,
		const T *	vec )

setAssociatedObject() [2/2]

template<typename T>

void xAOD::Jet_v1::setAssociatedObject	(	const std::string &	name,
		const T *	vec )

set a single associated object T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed

setAssociatedObjects() [1/2]

template<typename T>

void xAOD::Jet_v1::setAssociatedObjects	(	AssoParticlesID	type,
		const std::vector< const T * > &	vec )

setAssociatedObjects() [2/2]

template<typename T>

void xAOD::Jet_v1::setAssociatedObjects	(	const std::string &	name,
		const std::vector< const T * > &	vec )

set associated objects from a vector of arbitrary object.

T must inherit AuxElement (if T inherits IParticle, objects are stored as IParticle but can still be retrieved as their exact type) returns false if the association failed

setAttribute() [1/2]

template<class T>

void xAOD::Jet_v1::setAttribute	(	AttributeID	type,
		const T &	value )

Set number by enum.

setAttribute() [2/2]

template<class T>

void xAOD::Jet_v1::setAttribute	(	const std::string &	name,
		const T &	v )

setConstituentsSignalState()

void xAOD::Jet_v1::setConstituentsSignalState

(

JetConstitScale

t

)

Set the state at which constituents were when this jet was found. This function is called by jet builders.

Definition at line 143 of file Jet_v1.cxx.

                                                           {
    constitScaleAcc(*this) = t;
  }

setInputType()

void xAOD::Jet_v1::setInputType

(

JetInput::Type

t

)

Definition at line 270 of file Jet_v1.cxx.

{inputAcc(*this)=t;}

setJetP4() [1/3]

void xAOD::Jet_v1::setJetP4

(

const JetFourMom_t &

p4

)

Definition at line 182 of file Jet_v1.cxx.

                                                {
    
    momentumAcc.setAttribute( *this, p4 );
    return;
  }

setJetP4() [2/3]

void xAOD::Jet_v1::setJetP4	(	const std::string &	sname,
		const JetFourMom_t &	p4 )

Definition at line 236 of file Jet_v1.cxx.

                                                                           {
    if(statename=="JetAssignedScaleMomentum") return setJetP4(JetAssignedScaleMomentum,p4);
    return setAttribute<JetFourMom_t>(statename, p4);
  }

setJetP4() [3/3]

void xAOD::Jet_v1::setJetP4	(	JetScale	s,
		const JetFourMom_t &	p4 )

Access by the enum to the historical states.

Definition at line 209 of file Jet_v1.cxx.

                                                           {
    switch( s ){ 
    case JetEMScaleMomentum: 
      jetEMScaleAcc.setAttribute( *this, p4 );
      break;
    case JetConstitScaleMomentum: 
      jetConstitScaleAcc.setAttribute(*this, p4 ) ;
      break;
    case JetAssignedScaleMomentum:
      setJetP4(p4);
      break;
    default :
      std::cerr << " Error p4(P4SignalState) unknown state "<< s << std::endl;
      break;
    }
  }

setNumConstituents()

void xAOD::Jet_v1::setNumConstituents ( size_t n )

protected

setPseudoJet()

template<class PSEUDOJET>

void xAOD::Jet_v1::setPseudoJet

(

const PSEUDOJET *

fj

)

Set the fast jet pointer.

Expert usage only. This function is templated in order to avoid a dependency of xAODJet on fastjet.

setSizeParameter()

void xAOD::Jet_v1::setSizeParameter

(

float

p

)

Definition at line 268 of file Jet_v1.cxx.

{ spAcc(*this) = p;}

type()

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

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 85 of file Jet_v1.cxx.

                                    {    
      return Type::Jet;
   }

Member Data Documentation

m_fastJetLink

FastJetLinkBase* xAOD::Jet_v1::m_fastJetLink

protected

Pointer to the fastjet object this jet is build from.

WARNING : this pointer is meant to be used in reco flow only. It is transient only, provided only to ease calculation of some jet quantities, and will be invalid for jets read from files.

Definition at line 346 of file Jet_v1.h.

---

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

• Jet_v1.h
• Jet_v1.cxx