A detector object made of other lower level object(s). More...

#include <FlowElement_v1.h>

Inheritance diagram for xAOD::FlowElement_v1:

Collaboration diagram for xAOD::FlowElement_v1:

Public Types
enum	SignalType { Neutral = 0x1000 , Charged = 0x2000 , Combined = 0x4000 , CaloCluster = Neutral \| 0x0100 , Track = Charged \| 0x0200 , Muon = Charged \| 0x0400 , PFlow = 0x0010 , NeutralPFlow = Neutral \| PFlow , ChargedPFlow = Charged \| PFlow , TCC = 0x0020 , NeutralTCC = Neutral \| TCC , ChargedTCC = Charged \| TCC , UFO = 0x0001 , NeutralUFO = Neutral \| UFO , ChargedUFO = Charged \| UFO , Unknown = 0x0000 }
	Enum to encode the nature of the object this FlowElement represents. More...
enum	MatchedPVType { Undefined = 0x00 , HardScatter = 0x10 , Pileup = 0x20 , PileupSideBand = 0x21 }
	Enum to encode high-level information on the vertex associated to this FlowElement. More...
typedef unsigned long	signal_t
typedef short	vertex_t
typedef TLorentzVector	FourMom_t
	Definition of the 4-momentum type.

Public Member Functions
	IParticle ()=default
	IParticle (const IParticle &)=default
	IParticle (IParticle &&)=delete

virtual double	pt () const override
virtual double	eta () const override
	The pseudorapidity ( \(\eta\)) of the particle.
virtual double	phi () const override
	The azimuthal angle ( \(\phi\)) of the particle.
virtual double	m () const override
	The invariant mass of the particle.
virtual double	e () const override
	The total energy of the particle.
virtual double	rapidity () const override
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const override
	The full 4-momentum of the particle.
virtual Type::ObjectType	type () const override
	The type of the object as a simple enumeration.
void	setP4 (float pt, float eta, float phi, float m)
void	setP4 (const FourMom_t &p4)

signal_t	signalType () const
void	setSignalType (signal_t t)

bool	isMatchedToPV (MatchedPVType vxtype=HardScatter) const
vertex_t	vertexType () const
void	setVertexType (vertex_t t)

bool	isCharged () const
float	charge () const
void	setCharge (float c)

std::vector< const xAOD::IParticle * >	chargedObjects () const
std::vector< std::pair< const xAOD::IParticle *, float > >	chargedObjectsAndWeights () const
std::size_t	nChargedObjects () const
const xAOD::IParticle *	chargedObject (std::size_t i) const
std::pair< const xAOD::IParticle *, float >	chargedObjectAndWeight (std::size_t i) const

const std::vector< ElementLink< IParticleContainer > > &	chargedObjectLinks () const
	Access to the EL.
const std::vector< float > &	chargedObjectWeights () const
void	setChargedObjectLinks (const std::vector< ElementLink< IParticleContainer > > &elV)
void	setChargedObjectLinks (const std::vector< ElementLink< IParticleContainer > > &elV, const std::vector< float > &wV)

std::vector< const xAOD::IParticle * >	otherObjects () const
std::vector< std::pair< const xAOD::IParticle *, float > >	otherObjectsAndWeights () const
std::size_t	nOtherObjects () const
const xAOD::IParticle *	otherObject (std::size_t i) const
std::pair< const xAOD::IParticle *, float >	otherObjectAndWeight (std::size_t i) const

const std::vector< ElementLink< IParticleContainer > > &	otherObjectLinks () const
const std::vector< float > &	otherObjectWeights () const
void	setOtherObjectLinks (const std::vector< ElementLink< IParticleContainer > > &elV)
void	setOtherObjectLinks (const std::vector< ElementLink< IParticleContainer > > &elV, const std::vector< float > &wV)
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.

Detailed Description

A detector object made of other lower level object(s).

This class is intended to describe reconstruction objects coumpound of lower level detector objects. Typically it provides links to tracks and calo clusters such as is needed for particle flow objects.

The class is kept minimal and very generic so it can cover many use cases, including a generic type to describe jet constituents.

Definition at line 25 of file FlowElement_v1.h.

Member Typedef Documentation

◆ FourMom_t

typedef TLorentzVector xAOD::IParticle::FourMom_t

Definition of the 4-momentum type.

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

◆ signal_t

typedef unsigned long xAOD::FlowElement_v1::signal_t

Definition at line 30 of file FlowElement_v1.h.

◆ vertex_t

typedef short xAOD::FlowElement_v1::vertex_t

Definition at line 31 of file FlowElement_v1.h.

Member Enumeration Documentation

◆ MatchedPVType

enum xAOD::FlowElement_v1::MatchedPVType

Enum to encode high-level information on the vertex associated to this FlowElement.

Enumerator
Undefined
HardScatter
Pileup
PileupSideBand

Definition at line 62 of file FlowElement_v1.h.

                       {
            Undefined = 0x00, HardScatter = 0x10, Pileup = 0x20, PileupSideBand = 0x21
    };

◆ SignalType

enum xAOD::FlowElement_v1::SignalType

Enum to encode the nature of the object this FlowElement represents.

Enumerator
Neutral
Charged
Combined
CaloCluster
Track
Muon
PFlow
NeutralPFlow
ChargedPFlow
TCC
NeutralTCC
ChargedTCC
UFO
NeutralUFO
ChargedUFO
Unknown

Definition at line 35 of file FlowElement_v1.h.

                    { 
             // global characteristics
             Neutral      = 0x1000,
             Charged      = 0x2000,
             Combined     = 0x4000, //needed??
 
             // detector level signals and flow objects
             CaloCluster  = Neutral | 0x0100,
             Track        = Charged | 0x0200,
             Muon         = Charged | 0x0400,
             PFlow        = 0x0010,
             NeutralPFlow = Neutral | PFlow,
             ChargedPFlow = Charged | PFlow,
 
             // higher level flow objects
             TCC          = 0x0020,
             NeutralTCC   = Neutral | TCC,
             ChargedTCC   = Charged | TCC,
             UFO          = 0x0001,
             NeutralUFO   = Neutral | UFO,
             ChargedUFO   = Charged | UFO,
 
             // unknown
             Unknown      = 0x0000
    };

Member Function Documentation

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

◆ charge()

float xAOD::FlowElement_v1::charge ( ) const

◆ chargedObject()

const xAOD::IParticle * xAOD::FlowElement_v1::chargedObject ( std::size_t i ) const

Definition at line 127 of file FlowElement_v1.cxx.

                                                                       {
    const auto & elV = chargedObjectLinks();
    // should we check if i >= size() and throw ourselves ? or trust the user ?
    return elV[i].isValid()? *(elV[i]) : nullptr ;
  }

◆ chargedObjectAndWeight()

std::pair< const xAOD::IParticle *, float > xAOD::FlowElement_v1::chargedObjectAndWeight ( std::size_t i ) const

Definition at line 133 of file FlowElement_v1.cxx.

                                                                                                  {
    const auto & elV = chargedObjectLinks();
    const std::vector<float> & wV = chargedObjectWeights();
 
    if( elV[i].isValid() )  return { *(elV[i]), wV[i] } ;
    else return {nullptr, wV[i] } ;    
  }

◆ chargedObjectLinks()

const std::vector< ElementLink< IParticleContainer > > & xAOD::FlowElement_v1::chargedObjectLinks ( ) const

Access to the EL.

◆ chargedObjects()

std::vector< const xAOD::IParticle * > xAOD::FlowElement_v1::chargedObjects ( ) const

Access directly the charged underlying IParticle (typically : TrackParticle) nullptr are returned if the ElementLink to the IParticle are invalid (ex: after thinning)

Definition at line 94 of file FlowElement_v1.cxx.

                                                                       {
    const auto & elV = chargedObjectLinks();
    std::vector<const xAOD::IParticle*> result;
    result.reserve( elV.size() );
    for(const auto& el: elV ){
      result.push_back( el.isValid() ? *el : nullptr ) ; 
    }
    return result;
  }

◆ chargedObjectsAndWeights()

std::vector< std::pair< const xAOD::IParticle *, float > > xAOD::FlowElement_v1::chargedObjectsAndWeights ( ) const

Definition at line 104 of file FlowElement_v1.cxx.

                                                                                                 {
 
    const auto & elV = chargedObjectLinks();
    const std::vector<float> & wV = chargedObjectWeights();
    std::vector< std::pair<const xAOD::IParticle*,float> > result;
    result.reserve( elV.size() );
    if(wV.empty()) {
      for(const auto& el: elV ){
    result.emplace_back( el.isValid() ? *el : nullptr , 1. ) ; 
      }
    } else {
      for(size_t i=0;i<elV.size();i++){
    const xAOD::IParticle* p = elV[i].isValid() ? *(elV[i]) : nullptr;
    result.emplace_back(p , wV[i] ); 
      }
    }      
    return result;
  }

◆ chargedObjectWeights()

const std::vector< float > & xAOD::FlowElement_v1::chargedObjectWeights ( ) const

◆ e()

double xAOD::FlowElement_v1::e ( ) const

overridevirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 25 of file FlowElement_v1.cxx.

                                 {
    return PtEtaPhiMVector(pt(), eta(), phi(), m() ).E();
  }

◆ eta()

virtual double xAOD::FlowElement_v1::eta ( ) const

overridevirtual

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

Implements xAOD::IParticle.

◆ IParticle() [1/3]

xAOD::IParticle::IParticle ( )

default

◆ IParticle() [2/3]

xAOD::IParticle::IParticle ( const IParticle & )

default

◆ IParticle() [3/3]

xAOD::IParticle::IParticle ( IParticle && )

delete

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

◆ isCharged()

bool xAOD::FlowElement_v1::isCharged ( ) const

Access charge

Definition at line 56 of file FlowElement_v1.cxx.

56{ return !bool( signalType()& Neutral );}

xAOD::FlowElement_v1::signalType

signal_t signalType() const

xAOD::bool

setBGCode setTAP setLVL2ErrorBits bool

Definition TrigDecision_v1.cxx:60

◆ isMatchedToPV()

bool xAOD::FlowElement_v1::isMatchedToPV ( MatchedPVType vxtype = HardScatter ) const

Acess vertex types

Definition at line 63 of file FlowElement_v1.cxx.

                                                                {
    return (vertexType()==vxtype);
  }

◆ m()

virtual double xAOD::FlowElement_v1::m ( ) const

overridevirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

◆ nChargedObjects()

std::size_t xAOD::FlowElement_v1::nChargedObjects ( ) const

Definition at line 123 of file FlowElement_v1.cxx.

                                                  {
    return chargedObjectLinks().size();
  }

◆ nOtherObjects()

std::size_t xAOD::FlowElement_v1::nOtherObjects ( ) const

Definition at line 192 of file FlowElement_v1.cxx.

                                                {
    return otherObjectLinks().size();
  }

◆ otherObject()

const xAOD::IParticle * xAOD::FlowElement_v1::otherObject ( std::size_t i ) const

Definition at line 196 of file FlowElement_v1.cxx.

                                                                     {
    const auto & elV = otherObjectLinks();
    // should we check if i >= size() and throw ourselves ? or trust the user ?
    return elV[i].isValid()? *(elV[i]) : nullptr ;
  }

◆ otherObjectAndWeight()

std::pair< const xAOD::IParticle *, float > xAOD::FlowElement_v1::otherObjectAndWeight ( std::size_t i ) const

Definition at line 202 of file FlowElement_v1.cxx.

                                                                                                 {
    const auto & elV = otherObjectLinks();
    const std::vector<float> & wV = otherObjectWeights();
 
    if( elV[i].isValid() )  return { *(elV[i]), wV[i] };
    else return {nullptr, wV[i] } ;    
  }

◆ otherObjectLinks()

const std::vector< ElementLink< IParticleContainer > > & xAOD::FlowElement_v1::otherObjectLinks ( ) const

Access to the EL

◆ otherObjects()

std::vector< const xAOD::IParticle * > xAOD::FlowElement_v1::otherObjects ( ) const

Access directly the 'other' underlying IParticle (typically neutral CaloCluster) nullptr are returned if the ElementLink to the IParticle are invalid (ex: after thinning)

Definition at line 163 of file FlowElement_v1.cxx.

                                                                     {
    const auto & elV = otherObjectLinks();
    std::vector<const xAOD::IParticle*> result;
    result.reserve( elV.size() );
    for(const auto& el: elV ){
      result.push_back( el.isValid() ? *el : nullptr ) ; 
    }
    return result;
  }

◆ otherObjectsAndWeights()

std::vector< std::pair< const xAOD::IParticle *, float > > xAOD::FlowElement_v1::otherObjectsAndWeights ( ) const

Definition at line 173 of file FlowElement_v1.cxx.

                                                                                               {
 
    const auto & elV = otherObjectLinks();
    const std::vector<float> & wV = otherObjectWeights();
    std::vector< std::pair<const xAOD::IParticle*,float> > result;
    result.reserve( elV.size() );
    if(wV.empty()) {
      for(const auto& el: elV ){
    result.emplace_back( el.isValid() ? *el : nullptr , 1. ) ; 
      }
    } else {
      for(size_t i=0;i<elV.size();i++){
    const xAOD::IParticle* p = elV[i].isValid() ? *(elV[i]) : nullptr;
    result.emplace_back(p , wV[i] ); 
      }
    }      
    return result;
  }

◆ otherObjectWeights()

const std::vector< float > & xAOD::FlowElement_v1::otherObjectWeights ( ) const

◆ p4()

FlowElement_v1::FourMom_t xAOD::FlowElement_v1::p4 ( ) const

overridevirtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 33 of file FlowElement_v1.cxx.

                                                   {
    FourMom_t p4;
    p4.SetPtEtaPhiE( pt(), eta(), phi(), e() );       
    return p4;
  }

◆ phi()

virtual double xAOD::FlowElement_v1::phi ( ) const

overridevirtual

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

Implements xAOD::IParticle.

◆ pt()

virtual double xAOD::FlowElement_v1::pt ( ) const

overridevirtual

kinematics (IParticle interface)

Implements xAOD::IParticle.

◆ rapidity()

double xAOD::FlowElement_v1::rapidity ( ) const

overridevirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 29 of file FlowElement_v1.cxx.

                                        {
    return PtEtaPhiMVector(pt(), eta(), phi(), m() ).Rapidity();
  }

◆ setCharge()

void xAOD::FlowElement_v1::setCharge ( float c )

◆ setChargedObjectLinks() [1/2]

void xAOD::FlowElement_v1::setChargedObjectLinks ( const std::vector< ElementLink< IParticleContainer > > & elV )

◆ setChargedObjectLinks() [2/2]

void xAOD::FlowElement_v1::setChargedObjectLinks	(	const std::vector< ElementLink< IParticleContainer > > &	elV,
		const std::vector< float > &	wV )

◆ setOtherObjectLinks() [1/2]

void xAOD::FlowElement_v1::setOtherObjectLinks ( const std::vector< ElementLink< IParticleContainer > > & elV )

◆ setOtherObjectLinks() [2/2]

void xAOD::FlowElement_v1::setOtherObjectLinks	(	const std::vector< ElementLink< IParticleContainer > > &	elV,
		const std::vector< float > &	wV )

◆ setP4() [1/2]

void xAOD::FlowElement_v1::setP4 ( const FourMom_t & p4 )

Definition at line 51 of file FlowElement_v1.cxx.

                                               {
    setP4(p4.Pt(), p4.Eta(), p4.Phi(), p4.M());
  }

◆ setP4() [2/2]

void xAOD::FlowElement_v1::setP4	(	float	pt,
		float	eta,
		float	phi,
		float	m )

Definition at line 39 of file FlowElement_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;     
    static const  Accessor< float > acc4( "m" );     
    acc4( *this ) = m;     
 
  }

◆ setSignalType()

void xAOD::FlowElement_v1::setSignalType ( signal_t t )

◆ setVertexType()

void xAOD::FlowElement_v1::setVertexType ( vertex_t t )

◆ signalType()

signal_t xAOD::FlowElement_v1::signalType ( ) const

Access signal type

◆ type()

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

overridevirtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 68 of file FlowElement_v1.cxx.

                                            {
    return Type::FlowElement;
  }

◆ vertexType()

vertex_t xAOD::FlowElement_v1::vertexType ( ) const

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ FourMom_t

◆ signal_t

◆ vertex_t

Member Enumeration Documentation

◆ MatchedPVType

◆ SignalType

Member Function Documentation

◆ auxdata() [1/2]

◆ auxdata() [2/2]

◆ charge()

◆ chargedObject()

◆ chargedObjectAndWeight()

◆ chargedObjectLinks()

◆ chargedObjects()

◆ chargedObjectsAndWeights()

◆ chargedObjectWeights()

◆ e()

◆ eta()

◆ IParticle() [1/3]

◆ IParticle() [2/3]

◆ IParticle() [3/3]

◆ isAvailable()

◆ isAvailableWritable()

◆ isCharged()

◆ isMatchedToPV()

◆ m()

◆ nChargedObjects()

◆ nOtherObjects()

◆ otherObject()

◆ otherObjectAndWeight()

◆ otherObjectLinks()

◆ otherObjects()

◆ otherObjectsAndWeights()

◆ otherObjectWeights()

◆ p4()

◆ phi()

◆ pt()

◆ rapidity()

◆ setCharge()

◆ setChargedObjectLinks() [1/2]

◆ setChargedObjectLinks() [2/2]

◆ setOtherObjectLinks() [1/2]

◆ setOtherObjectLinks() [2/2]

◆ setP4() [1/2]

◆ setP4() [2/2]

◆ setSignalType()

◆ setVertexType()

◆ signalType()

◆ type()

◆ vertexType()