xAOD::GBlock_v1 Class Reference

#include <GBlock_v1.h>

Inheritance diagram for xAOD::GBlock_v1:

Collaboration diagram for xAOD::GBlock_v1:

Public Types
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.

Public Member Functions
	GBlock_v1 ()=default
	Default constructor.
	GBlock_v1 (const GBlock_v1 &other)
	Copy constructor.
GBlock_v1 &	operator= (const GBlock_v1 &other)
	Assignment operator.
virtual	~GBlock_v1 () override
	Default destructor.
virtual double	pt () const final
	The transverse momentum of the particle.
virtual double	eta () const final
	The pseudorapidity ( \(\eta\)) of the particle.
void	setEta (double)
virtual double	phi () const final
	The azimuthal angle ( \(\phi\)) of the particle.
void	setPhi (double)
float	deta () const
	The pseudorapidity ( \(\eta\)) of the particle.
void	setdEta (float)
float	dphi () const
	The azimuthal angle ( \(\phi\)) of the particle.
void	setdPhi (float)
float	et () const
void	setEt (float)
virtual double	m () const final
	The invariant mass of the particle.
virtual double	e () const final
	The total energy of the particle.
virtual double	rapidity () const final
	The true rapidity (y) of the particle.
virtual FourMom_t	p4 () const final
	The full 4-momentum of the particle as a TLoretzVector.
virtual Type::ObjectType	type () const final
	The type of the object as a simple enumeration, remains pure virtual in e/gamma.
const ElementLink< JGTowerContainer > &	seedTowerLink () const
	The element link to the seed tower of this gBlock.
const JGTower *	seedTower () const
	The seed tower for this gBlock.
std::size_t	nTowers () const
	The number of towers that make up this gBlock (including the seed).
const std::vector< ElementLink< JGTowerContainer > > &	towerLinks () const
	Element links to the towers making up this gBlock (including the seed).
const JGTower *	getTower (std::size_t idx) const
	Get a link by number.
float	area () const
	The area of the gBlock.
void	setArea (float)
	Set the area.
void	setSeedTowerLink (const ElementLink< JGTowerContainer > &link)
	Set the seed link.
void	setTowerLinks (const std::vector< ElementLink< JGTowerContainer > > &links)
	set the tower links
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

Definition at line 16 of file GBlock_v1.h.

Member Typedef Documentation

FourMom_t

typedef IParticle::FourMom_t xAOD::GBlock_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 60 of file GBlock_v1.h.

Constructor & Destructor Documentation

GBlock_v1() [1/2]

xAOD::GBlock_v1::GBlock_v1 ( )

default

Default constructor.

GBlock_v1() [2/2]

xAOD::GBlock_v1::GBlock_v1

(

const GBlock_v1 &

other

)

Copy constructor.

Definition at line 18 of file GBlock_v1.cxx.

      : IParticle(other)
  {
  }

~GBlock_v1()

xAOD::GBlock_v1::~GBlock_v1 ( )

overridevirtual

Default destructor.

Definition at line 36 of file GBlock_v1.cxx.

{}

Member Function Documentation

area()

float xAOD::GBlock_v1::area

(

)

const

The area of the gBlock.

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

deta()

float xAOD::GBlock_v1::deta

(

)

const

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

dphi()

float xAOD::GBlock_v1::dphi

(

)

const

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

e()

double xAOD::GBlock_v1::e ( ) const

finalvirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 56 of file GBlock_v1.cxx.

{ return p4().E(); }

et()

float xAOD::GBlock_v1::et

(

)

const

eta()

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

finalvirtual

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

Implements xAOD::IParticle.

getTower()

const JGTower * xAOD::GBlock_v1::getTower

(

std::size_t

idx

)

const

Get a link by number.

Definition at line 89 of file GBlock_v1.cxx.

  {
    const std::vector<ElementLink<JGTowerContainer>> &links = towerLinks();
    return idx >= links.size() ? nullptr : *links[idx];
  }

isAvailable()

template<class T>

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

inlineinherited

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

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

Parameters

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

Returns

Whether the decoration exists or not

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

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

isAvailableWritable()

template<class T>

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

inlineinherited

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

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

Parameters

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

Returns

Whether the decoration is possible to set

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

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

m()

double xAOD::GBlock_v1::m ( ) const

finalvirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 54 of file GBlock_v1.cxx.

{ return 0; }

nTowers()

std::size_t xAOD::GBlock_v1::nTowers

(

)

const

The number of towers that make up this gBlock (including the seed).

operator=()

GBlock_v1 & xAOD::GBlock_v1::operator=

(

const GBlock_v1 &

other

)

Assignment operator.

Definition at line 23 of file GBlock_v1.cxx.

  {
    if (this != &other)
    {
      if (!container() && !hasStore())
      {
        makePrivateStore();
      }
      IParticle::operator=(other);
    }
    return *this;
  }

p4()

GBlock_v1::FourMom_t xAOD::GBlock_v1::p4 ( ) const

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 60 of file GBlock_v1.cxx.

  {
    FourMom_t p4;
    double PT = (pt() > 0) ? 1000. * static_cast<double>(pt()) : 0.01;
    p4.SetPtEtaPhiM(PT, eta(), phi(), m());
    return p4;
  }

phi()

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

finalvirtual

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

Implements xAOD::IParticle.

pt()

double xAOD::GBlock_v1::pt ( ) const

finalvirtual

The transverse momentum of the particle.

Implements xAOD::IParticle.

Definition at line 38 of file GBlock_v1.cxx.

{ return et(); }

rapidity()

double xAOD::GBlock_v1::rapidity ( ) const

finalvirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 58 of file GBlock_v1.cxx.

{ return p4().Rapidity(); }

seedTower()

const JGTower * xAOD::GBlock_v1::seedTower

(

)

const

The seed tower for this gBlock.

Definition at line 78 of file GBlock_v1.cxx.

  {
    const ElementLink<JGTowerContainer> &link = seedTowerLink();
    return link.isValid() ? *link : nullptr;
  }

seedTowerLink()

const ElementLink< JGTowerContainer > & xAOD::GBlock_v1::seedTowerLink

(

)

const

The element link to the seed tower of this gBlock.

Definition at line 73 of file GBlock_v1.cxx.

  {
    return accSeedTower(*this);
  }

setArea()

void xAOD::GBlock_v1::setArea

(

float

)

Set the area.

setdEta()

void xAOD::GBlock_v1::setdEta

(

float

)

setdPhi()

void xAOD::GBlock_v1::setdPhi

(

float

)

setEt()

void xAOD::GBlock_v1::setEt

(

float

)

setEta()

void xAOD::GBlock_v1::setEta

(

double

)

setPhi()

void xAOD::GBlock_v1::setPhi

(

double

)

setSeedTowerLink()

void xAOD::GBlock_v1::setSeedTowerLink

(

const ElementLink< JGTowerContainer > &

link

)

Set the seed link.

Definition at line 95 of file GBlock_v1.cxx.

  {
    decSeedTower(*this) = link;
  }

setTowerLinks()

void xAOD::GBlock_v1::setTowerLinks

(

const std::vector< ElementLink< JGTowerContainer > > &

links

)

set the tower links

Definition at line 101 of file GBlock_v1.cxx.

  {
    decTowers(*this) = links;
  }

towerLinks()

const std::vector< ElementLink< JGTowerContainer > > & xAOD::GBlock_v1::towerLinks

(

)

const

Element links to the towers making up this gBlock (including the seed).

Definition at line 84 of file GBlock_v1.cxx.

  {
    return accTowers(*this);
  }

type()

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

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 68 of file GBlock_v1.cxx.

  {
    return Type::Other;
  }

---

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

• GBlock_v1.h
• GBlock_v1.cxx