xAOD::TriggerTower_v2 Class Reference

Description of TriggerTower_v2. More...

#include <TriggerTower_v2.h>

Inheritance diagram for xAOD::TriggerTower_v2:

Collaboration diagram for xAOD::TriggerTower_v2:

Public Member Functions
	TriggerTower_v2 ()
	Default constructor.
	TriggerTower_v2 (const TriggerTower_v2 &other)
	Copy constructor.
TriggerTower_v2 &	operator= (const TriggerTower_v2 &other)
	Assignment operator.
virtual	~TriggerTower_v2 ()
	Default desturctor.
virtual void	initialize (const uint32_t CoolId, const float Eta, const float Phi)
	initialize
virtual void	initialize (const uint32_t CoolId, const float Eta, const float Phi, const std::vector< uint8_t > &Lut_cp, const std::vector< uint8_t > &Lut_jep, const std::vector< int16_t > &Correction, const std::vector< uint8_t > &CorrectionEnabled, const std::vector< uint8_t > &BcidVec, const std::vector< uint16_t > &Adc, const std::vector< uint8_t > &BcidExt, const std::vector< uint8_t > &Sat80Vec, const uint32_t ErrorWord, const uint8_t Peak, const uint8_t AdcPeak)
virtual void	initialize (const uint32_t CoolId, const float Eta, const float Phi, std::vector< uint8_t > &&Lut_cp, std::vector< uint8_t > &&Lut_jep, std::vector< int16_t > &&Correction, std::vector< uint8_t > &&CorrectionEnabled, std::vector< uint8_t > &&BcidVec, std::vector< uint16_t > &&Adc, std::vector< uint8_t > &&BcidExt, std::vector< uint8_t > &&Sat80Vec, const uint32_t ErrorWord, const uint8_t Peak, const uint8_t AdcPeak)
uint32_t	coolId () const
	Tower identifiers.
void	setCoolId (uint32_t)
	set coolID
int	layer () const
	get layer ( 0 = EM, 1 = Had, 2 = FCAL23) - to be confirmed
int	sampling () const
	get sampling ( 0 = EM, 1 = Had )
const std::vector< uint8_t > &	lut_cp () const
	get lut_cp
void	setLut_cp (const std::vector< uint8_t > &)
	set lut_cp
void	setLut_cp (std::vector< uint8_t > &&)
const std::vector< uint8_t > &	lut_jep () const
	get lut_jep
void	setLut_jep (const std::vector< uint8_t > &)
	set lut_jep
void	setLut_jep (std::vector< uint8_t > &&)
const std::vector< int16_t > &	correction () const
	get correction
void	setCorrection (const std::vector< int16_t > &)
	set correction
void	setCorrection (std::vector< int16_t > &&)
const std::vector< uint8_t > &	correctionEnabled () const
	get correctionEnabled
void	setCorrectionEnabled (const std::vector< uint8_t > &)
	set correctionEnabled
void	setCorrectionEnabled (std::vector< uint8_t > &&)
const std::vector< uint8_t > &	bcidVec () const
	get bcidVec
void	setBcidVec (const std::vector< uint8_t > &)
	set bcidVec
void	setBcidVec (std::vector< uint8_t > &&)
const std::vector< uint16_t > &	adc () const
	get adc
void	setAdc (const std::vector< uint16_t > &)
	set adc
void	setAdc (std::vector< uint16_t > &&)
const std::vector< uint8_t > &	bcidExt () const
	get bcidExt
void	setBcidExt (const std::vector< uint8_t > &)
	set bcidExt
void	setBcidExt (std::vector< uint8_t > &&)
const std::vector< uint8_t > &	sat80Vec () const
	get sat80Vec
void	setSat80Vec (const std::vector< uint8_t > &)
	set sat80Vec
void	setSat80Vec (std::vector< uint8_t > &&)
uint32_t	errorWord () const
	get error
void	setErrorWord (uint32_t)
	set error
uint8_t	peak () const
	get peak
void	setPeak (uint8_t)
	set peak
uint8_t	adcPeak () const
	get adcPeak
void	setAdcPeak (uint8_t)
	set adcPeak
uint8_t	cpET () const
	get cpET from peak of lut_cp
uint8_t	jepET () const
	get jepET from peak of lut_jep
bool	isCpSaturated () const
	Is tower saturated?
bool	isJepSaturated () const
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 Private Attributes
static const uint8_t	m_saturation = 255

xAOD::IParticle functions
These are already virtual due to IParticle
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type.
typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for trigger tower.
virtual double	pt () const final
	The transverse momentum ( \(p_T\)) of the particle.
virtual double	eta () const final
	The pseudorapidity ( \(\eta\)) of the particle.
void	setEta (float)
virtual double	phi () const final
	The azimuthal angle ( \(\phi\)) of the particle.
void	setPhi (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.
GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector type.
virtual Type::ObjectType	type () const final
	The type of the object as a simple enumeration, remains pure virtual in e/gamma.

Detailed Description

Description of TriggerTower_v2.

Author

John Morris john..nosp@m.morr.nosp@m.is@ce.nosp@m.rn.c.nosp@m.h

Revision

793304

Date

2017-01-21 05:50:44 +0100 (Sat, 21 Jan 2017)

Trigger towers are the inputs to all other parts of the calorimeter trigger. They are formed by analogue summation of cells (represented in simulation by LArTTL1 and TileTTL1 objects). The L1Calo PreProcessor digitizes these, performs Bunch-Crossing IDentification, final calibration and reduction to 8 bit words.

The TriggerTower class represents the output of the PreProcessor.

For each tower, the TriggerTower contains the final ET (LUT output) as well as a vector of ADC data (at 25ns intervals) from which it was formed, plus error flags and raw BCID output. As the PreProcessor readout can read variable numbers of slices of all of these data, the internal storage is in std::vectors, and methods exist to return all slices as well as just the data corresponding to the triggered crossing.

The TriggerTower_v2 class inherits from IParticle in order to assist The Level 1.5 jet HLT algorithm

Definition at line 49 of file TriggerTower_v2.h.

Member Typedef Documentation

FourMom_t

typedef IParticle::FourMom_t xAOD::TriggerTower_v2::FourMom_t

Definition of the 4-momentum type.

Definition at line 85 of file TriggerTower_v2.h.

GenVecFourMom_t

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

Base 4 Momentum type for trigger tower.

Definition at line 91 of file TriggerTower_v2.h.

Constructor & Destructor Documentation

TriggerTower_v2() [1/2]

xAOD::TriggerTower_v2::TriggerTower_v2

(

)

Default constructor.

Definition at line 15 of file TriggerTower_v2.cxx.

                                   :
    IParticle()
  {        
  }

TriggerTower_v2() [2/2]

xAOD::TriggerTower_v2::TriggerTower_v2

(

const TriggerTower_v2 &

other

)

Copy constructor.

Definition at line 20 of file TriggerTower_v2.cxx.

                                                               :
    IParticle( other )
  {   
  }

~TriggerTower_v2()

virtual xAOD::TriggerTower_v2::~TriggerTower_v2 ( )

inlinevirtual

Default desturctor.

Definition at line 58 of file TriggerTower_v2.h.

{}

Member Function Documentation

adc()

const std::vector< uint16_t > & xAOD::TriggerTower_v2::adc

(

)

const

get adc

adcPeak()

uint8_t xAOD::TriggerTower_v2::adcPeak

(

)

const

get adcPeak

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

bcidExt()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::bcidExt

(

)

const

get bcidExt

bcidVec()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::bcidVec

(

)

const

get bcidVec

coolId()

uint32_t xAOD::TriggerTower_v2::coolId

(

)

const

Tower identifiers.

get coolId

correction()

const std::vector< int16_t > & xAOD::TriggerTower_v2::correction

(

)

const

get correction

correctionEnabled()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::correctionEnabled

(

)

const

get correctionEnabled

cpET()

uint8_t xAOD::TriggerTower_v2::cpET

(

)

const

get cpET from peak of lut_cp

Definition at line 180 of file TriggerTower_v2.cxx.

  {
    return peak() < lut_cp().size()? lut_cp()[ peak() ]: 0;
  }

e()

double xAOD::TriggerTower_v2::e ( ) const

finalvirtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 244 of file TriggerTower_v2.cxx.

  {
    return genvecP4().E();
  }

errorWord()

uint32_t xAOD::TriggerTower_v2::errorWord

(

)

const

get error

eta()

double xAOD::TriggerTower_v2::eta ( ) const

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 210 of file TriggerTower_v2.cxx.

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

genvecP4()

TriggerTower_v2::GenVecFourMom_t xAOD::TriggerTower_v2::genvecP4

(

)

const

The full 4-momentum of the particle : GenVector type.

this provides a GenVector (pt, eta, phi, m)

Definition at line 262 of file TriggerTower_v2.cxx.

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

initialize() [1/3]

void xAOD::TriggerTower_v2::initialize ( const uint32_t CoolId, const float Eta, const float Phi )

virtual

initialize

Definition at line 60 of file TriggerTower_v2.cxx.

  {
    setCoolId( CoolId );
    setEta( Eta );
    setPhi( Phi );    
  }

initialize() [2/3]

void xAOD::TriggerTower_v2::initialize ( const uint32_t CoolId, const float Eta, const float Phi, const std::vector< uint8_t > & Lut_cp, const std::vector< uint8_t > & Lut_jep, const std::vector< int16_t > & Correction, const std::vector< uint8_t > & CorrectionEnabled, const std::vector< uint8_t > & BcidVec, const std::vector< uint16_t > & Adc, const std::vector< uint8_t > & BcidExt, const std::vector< uint8_t > & Sat80Vec, const uint32_t ErrorWord, const uint8_t Peak, const uint8_t AdcPeak )

virtual

Definition at line 67 of file TriggerTower_v2.cxx.

  {
    setCoolId( CoolId );
    setEta( Eta );
    setPhi( Phi );
    setLut_cp( Lut_cp );
    setLut_jep( Lut_jep );
    setCorrection( Correction );
    setCorrectionEnabled( CorrectionEnabled );
    setBcidVec( BcidVec );
    setAdc( Adc );
    setBcidExt( BcidExt );
    setSat80Vec( Sat80Vec );
    setErrorWord( ErrorWord );
    setPeak( Peak );
    setAdcPeak( AdcPeak );
  }

initialize() [3/3]

void xAOD::TriggerTower_v2::initialize ( const uint32_t CoolId, const float Eta, const float Phi, std::vector< uint8_t > && Lut_cp, std::vector< uint8_t > && Lut_jep, std::vector< int16_t > && Correction, std::vector< uint8_t > && CorrectionEnabled, std::vector< uint8_t > && BcidVec, std::vector< uint16_t > && Adc, std::vector< uint8_t > && BcidExt, std::vector< uint8_t > && Sat80Vec, const uint32_t ErrorWord, const uint8_t Peak, const uint8_t AdcPeak )

virtual

Definition at line 92 of file TriggerTower_v2.cxx.

  {
    setCoolId( CoolId );
    setEta( Eta );
    setPhi( Phi );
    setLut_cp( std::move(Lut_cp) );
    setLut_jep( std::move(Lut_jep) );
    setCorrection( std::move(Correction) );
    setCorrectionEnabled( std::move(CorrectionEnabled) );
    setBcidVec( std::move(BcidVec) );
    setAdc( std::move(Adc) );
    setBcidExt( std::move(BcidExt) );
    setSat80Vec( std::move(Sat80Vec) );
    setErrorWord( ErrorWord );
    setPeak( Peak );
    setAdcPeak( AdcPeak );
  }

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

isCpSaturated()

bool xAOD::TriggerTower_v2::isCpSaturated

(

)

const

Is tower saturated?

Definition at line 196 of file TriggerTower_v2.cxx.

  {
    return cpET() >= m_saturation;    
  }

isJepSaturated()

bool xAOD::TriggerTower_v2::isJepSaturated

(

)

const

Definition at line 201 of file TriggerTower_v2.cxx.

  {    
    return jepET() >= m_saturation;    
  }  

jepET()

uint8_t xAOD::TriggerTower_v2::jepET

(

)

const

get jepET from peak of lut_jep

Definition at line 186 of file TriggerTower_v2.cxx.

  {
    return peak() < lut_jep().size()? lut_jep()[ peak() ]: 0;
  }

layer()

int xAOD::TriggerTower_v2::layer

(

)

const

get layer ( 0 = EM, 1 = Had, 2 = FCAL23) - to be confirmed

Definition at line 121 of file TriggerTower_v2.cxx.

  {
    unsigned int theCoolId = coolId();
    unsigned int cnum = ( theCoolId >> 24 ) & 0x7;
    unsigned int mnum = ( theCoolId >> 16 ) & 0xf;
    // unsigned int chan = theCoolId & 0x3; // To be used for FCAL2,FCAL3 soon
 
    if (cnum < 4) {  // EMB,EMEC
      return 0;
    }
    else if (cnum < 6) {  // HEC,FCAL
      if (mnum == 0) {
        return 0;  // FCAL1
      }
      else if (mnum == 8) {  // FCAL2,FCAL3
        // Detail to be determined (using chan): for now use layer 1
        return 1;
      }
      else {  // HEC
        return 1;
      }
    }
    else {  // Tile
      return 1;
    } 
    // really shouldn't get this far
    return 1;
  }

lut_cp()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::lut_cp

(

)

const

get lut_cp

lut_jep()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::lut_jep

(

)

const

get lut_jep

m()

double xAOD::TriggerTower_v2::m ( ) const

finalvirtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 239 of file TriggerTower_v2.cxx.

  {
    return 0.;
  }

operator=()

TriggerTower_v2 & xAOD::TriggerTower_v2::operator=

(

const TriggerTower_v2 &

other

)

Assignment operator.

Definition at line 25 of file TriggerTower_v2.cxx.

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

p4()

TriggerTower_v2::FourMom_t xAOD::TriggerTower_v2::p4 ( ) const

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 254 of file TriggerTower_v2.cxx.

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

peak()

uint8_t xAOD::TriggerTower_v2::peak

(

)

const

get peak

phi()

double xAOD::TriggerTower_v2::phi ( ) const

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 222 of file TriggerTower_v2.cxx.

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

pt()

double xAOD::TriggerTower_v2::pt ( ) const

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 234 of file TriggerTower_v2.cxx.

  {
    return static_cast< double >( jepET() );
  }

rapidity()

double xAOD::TriggerTower_v2::rapidity ( ) const

finalvirtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 249 of file TriggerTower_v2.cxx.

  {
    return genvecP4().Rapidity();
  }

sampling()

int xAOD::TriggerTower_v2::sampling

(

)

const

get sampling ( 0 = EM, 1 = Had )

Definition at line 150 of file TriggerTower_v2.cxx.

  {
    unsigned int theCoolId = coolId();
    unsigned int cnum = ( theCoolId >> 24 ) & 0x7;
    unsigned int mnum = ( theCoolId >> 16 ) & 0xf;
    // unsigned int chan = theCoolId & 0x3; // To be used for FCAL2,FCAL3 soon
 
    if (cnum < 4) {  // EMB,EMEC
      return 0;
    }
    else if (cnum < 6) {  // HEC,FCAL
      if (mnum == 0) {
        return 0;  // FCAL1
      }
      else if (mnum == 8) {  // FCAL2,FCAL3
        // Detail to be determined (using chan): for now use layer 1
        return 1;
      }
      else {  // HEC
        return 1;
      }
    }
    else {  // Tile
      return 1;
    } 
    // really shouldn't get this far
    return 1;    
  }

sat80Vec()

const std::vector< uint8_t > & xAOD::TriggerTower_v2::sat80Vec

(

)

const

get sat80Vec

setAdc() [1/2]

void xAOD::TriggerTower_v2::setAdc

(

const std::vector< uint16_t > &

)

set adc

setAdc() [2/2]

void xAOD::TriggerTower_v2::setAdc

(

std::vector< uint16_t > &&

)

setAdcPeak()

void xAOD::TriggerTower_v2::setAdcPeak

(

uint8_t

)

set adcPeak

setBcidExt() [1/2]

void xAOD::TriggerTower_v2::setBcidExt

(

const std::vector< uint8_t > &

)

set bcidExt

setBcidExt() [2/2]

void xAOD::TriggerTower_v2::setBcidExt

(

std::vector< uint8_t > &&

)

setBcidVec() [1/2]

void xAOD::TriggerTower_v2::setBcidVec

(

const std::vector< uint8_t > &

)

set bcidVec

setBcidVec() [2/2]

void xAOD::TriggerTower_v2::setBcidVec

(

std::vector< uint8_t > &&

)

setCoolId()

void xAOD::TriggerTower_v2::setCoolId

(

uint32_t

)

set coolID

setCorrection() [1/2]

void xAOD::TriggerTower_v2::setCorrection

(

const std::vector< int16_t > &

)

set correction

setCorrection() [2/2]

void xAOD::TriggerTower_v2::setCorrection

(

std::vector< int16_t > &&

)

setCorrectionEnabled() [1/2]

void xAOD::TriggerTower_v2::setCorrectionEnabled

(

const std::vector< uint8_t > &

)

set correctionEnabled

setCorrectionEnabled() [2/2]

void xAOD::TriggerTower_v2::setCorrectionEnabled

(

std::vector< uint8_t > &&

)

setErrorWord()

void xAOD::TriggerTower_v2::setErrorWord

(

uint32_t

)

set error

setEta()

void xAOD::TriggerTower_v2::setEta

(

float

eta

)

Definition at line 216 of file TriggerTower_v2.cxx.

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

setLut_cp() [1/2]

void xAOD::TriggerTower_v2::setLut_cp

(

const std::vector< uint8_t > &

)

set lut_cp

setLut_cp() [2/2]

void xAOD::TriggerTower_v2::setLut_cp

(

std::vector< uint8_t > &&

)

setLut_jep() [1/2]

void xAOD::TriggerTower_v2::setLut_jep

(

const std::vector< uint8_t > &

)

set lut_jep

setLut_jep() [2/2]

void xAOD::TriggerTower_v2::setLut_jep

(

std::vector< uint8_t > &&

)

setPeak()

void xAOD::TriggerTower_v2::setPeak

(

uint8_t

)

set peak

setPhi()

void xAOD::TriggerTower_v2::setPhi

(

float

phi

)

Definition at line 228 of file TriggerTower_v2.cxx.

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

setSat80Vec() [1/2]

void xAOD::TriggerTower_v2::setSat80Vec

(

const std::vector< uint8_t > &

)

set sat80Vec

setSat80Vec() [2/2]

void xAOD::TriggerTower_v2::setSat80Vec

(

std::vector< uint8_t > &&

)

type()

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

finalvirtual

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

Implements xAOD::IParticle.

Definition at line 266 of file TriggerTower_v2.cxx.

  {
    return Type::Jet;
  }

Member Data Documentation

m_saturation

const uint8_t xAOD::TriggerTower_v2::m_saturation = 255

staticprivate

Definition at line 224 of file TriggerTower_v2.h.

---

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

• TriggerTower_v2.h
• TriggerTower_v2.cxx