Class to hold common (eta/eta/phi) TOB bits. More...

#include <CommonTOB.h>

Inheritance diagram for GlobalSim::IOBitwise::CommonTOB:

Collaboration diagram for GlobalSim::IOBitwise::CommonTOB:

Public Member Functions
	CommonTOB (const xAOD::eFexEMRoI &eFexTOB)
	Constructor taking an eFexROITOB to initialise common bits. More...

	CommonTOB (const GlobalSim::IOBitwise::ICommonTOB &CommonTOB)
	Constructor taking an existing CommonTOB to initialise common bits. More...

	CommonTOB (const std::bitset< CommonTOB::s_et_width > &et_bits, const std::bitset< CommonTOB::s_eta_width > &eta_bits, const std::bitset< CommonTOB::s_phi_width > &phi_bits)
	Constructor taking raw bitsets to initialise common bits. More...

virtual	~CommonTOB ()
	Destructor. More...

virtual std::bitset< s_et_width >	et_bits () const override
	Returns the eT bits of this TOB. More...

virtual std::bitset< s_eta_width >	eta_bits () const override
	Returns the eta bits of this TOB. More...

virtual std::bitset< s_phi_width >	phi_bits () const override
	Returns the phi bits of this TOB. More...

virtual std::string	to_string () const override
	print out contents to string More...

Static Public Attributes
static constexpr std::size_t	s_et_width {13}
	Size of the eT bitset. More...

static constexpr std::size_t	s_eta_width {10}
	Size of the eta bitset. More...

static constexpr std::size_t	s_phi_width {9}
	Size of the phi bitset. More...

static constexpr std::size_t	s_eFex_granularity {100}

static constexpr ulong	max_et {(1UL << s_et_width)-1}

Private Attributes
std::bitset< ICommonTOB::s_et_width >	m_et_bits
	Property: eT bitset within the common TOB word. More...

std::bitset< ICommonTOB::s_eta_width >	m_eta_bits
	Property: eta bitset within the common TOB word. More...

std::bitset< ICommonTOB::s_phi_width >	m_phi_bits
	Property: phi bitset within the common TOB word. More...

Detailed Description

Class to hold common (eta/eta/phi) TOB bits.

This base class defines the bitsets to hold the common et, eta, phi bits in GlobalTOBs, and their retrieval functions.

Definition at line 23 of file CommonTOB.h.

Constructor & Destructor Documentation

◆ CommonTOB() [1/3]

GlobalSim::IOBitwise::CommonTOB::CommonTOB ( const xAOD::eFexEMRoI & eFexTOB )

Constructor taking an eFexROITOB to initialise common bits.

Parameters

[in] eFexTOB The input eFexRoI TOB defining the common/eFex bits.

To be used to create, and initilise a CommonTOB from an existing eFexTOB

Definition at line 10 of file CommonTOB.cxx.

                                                   : m_et_bits(static_cast<ulong>(eFexTOB.et())/s_eFex_granularity),
                             m_eta_bits(eFexTOB.iEtaTopo()),
                             m_phi_bits(eFexTOB.iPhiTopo()){
   }

◆ CommonTOB() [2/3]

GlobalSim::IOBitwise::CommonTOB::CommonTOB ( const GlobalSim::IOBitwise::ICommonTOB & CommonTOB )

Constructor taking an existing CommonTOB to initialise common bits.

Parameters

[in] CommonTOB The input Global CommonTOB defining the common bits.

To be used to create and initilaise a CommonTOB from an existing CommonTOB

Definition at line 15 of file CommonTOB.cxx.

                                                                    : m_et_bits(CommonTOB.et_bits()),
                                 m_eta_bits(CommonTOB.eta_bits()),
                                 m_phi_bits(CommonTOB.phi_bits()){}

◆ CommonTOB() [3/3]

GlobalSim::IOBitwise::CommonTOB::CommonTOB	(	const std::bitset< CommonTOB::s_et_width > &	et_bits,
		const std::bitset< CommonTOB::s_eta_width > &	eta_bits,
		const std::bitset< CommonTOB::s_phi_width > &	phi_bits
	)

Constructor taking raw bitsets to initialise common bits.

Parameters

[in]	et_bits	the transverse energy bits
[in]	eta_bits	the eta bits
[in]	phi_bits	the phi bits

To be used to create and initialise a CommonTOB from individual 4-vector bitsets.

Definition at line 19 of file CommonTOB.cxx.

                                                                : m_et_bits(et_bits),
                                       m_eta_bits(eta_bits),
                                       m_phi_bits(phi_bits){}

◆ ~CommonTOB()

virtual GlobalSim::IOBitwise::CommonTOB::~CommonTOB ( )

inlinevirtual

Destructor.

Definition at line 54 of file CommonTOB.h.

54 {};

Member Function Documentation

◆ et_bits()

std::bitset< CommonTOB::s_et_width > GlobalSim::IOBitwise::CommonTOB::et_bits ( ) const

overridevirtual

Returns the eT bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 25 of file CommonTOB.cxx.

                                                           {
     return m_et_bits;
   }

◆ eta_bits()

std::bitset< CommonTOB::s_eta_width > GlobalSim::IOBitwise::CommonTOB::eta_bits ( ) const

overridevirtual

Returns the eta bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 29 of file CommonTOB.cxx.

                                                             {
     return m_eta_bits;
   }

◆ phi_bits()

std::bitset< CommonTOB::s_phi_width > GlobalSim::IOBitwise::CommonTOB::phi_bits ( ) const

overridevirtual

Returns the phi bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 33 of file CommonTOB.cxx.

                                                             {
     return m_phi_bits;
   }

◆ to_string()

std::string GlobalSim::IOBitwise::CommonTOB::to_string ( ) const

overridevirtual

print out contents to string

Implements GlobalSim::IOBitwise::ICommonTOB.

Reimplemented in GlobalSim::IOBitwise::eEmTOB, GlobalSim::IOBitwise::eEmNbhoodTOB, GlobalSim::IOBitwise::eEmEg1eRatioTOB, and GlobalSim::IOBitwise::eEmEg1BDTTOB.

Definition at line 37 of file CommonTOB.cxx.

                                        {
     return ICommonTOB::to_string();
   }

Member Data Documentation

◆ m_et_bits

std::bitset<ICommonTOB::s_et_width> GlobalSim::IOBitwise::CommonTOB::m_et_bits

private

Property: eT bitset within the common TOB word.

Definition at line 66 of file CommonTOB.h.

◆ m_eta_bits

std::bitset<ICommonTOB::s_eta_width> GlobalSim::IOBitwise::CommonTOB::m_eta_bits

private

Property: eta bitset within the common TOB word.

Definition at line 68 of file CommonTOB.h.

◆ m_phi_bits

std::bitset<ICommonTOB::s_phi_width> GlobalSim::IOBitwise::CommonTOB::m_phi_bits

private

Property: phi bitset within the common TOB word.

Definition at line 70 of file CommonTOB.h.

◆ max_et

constexpr ulong GlobalSim::IOBitwise::ICommonTOB::max_et {(1UL << s_et_width)-1}

staticconstexprinherited

Definition at line 43 of file ICommonTOB.h.

◆ s_eFex_granularity

constexpr std::size_t GlobalSim::IOBitwise::ICommonTOB::s_eFex_granularity {100}

staticconstexprinherited

Definition at line 41 of file ICommonTOB.h.

◆ s_et_width

constexpr std::size_t GlobalSim::IOBitwise::ICommonTOB::s_et_width {13}

staticconstexprinherited

Size of the eT bitset.

Definition at line 35 of file ICommonTOB.h.

◆ s_eta_width

constexpr std::size_t GlobalSim::IOBitwise::ICommonTOB::s_eta_width {10}

staticconstexprinherited

Size of the eta bitset.

Definition at line 37 of file ICommonTOB.h.

◆ s_phi_width

constexpr std::size_t GlobalSim::IOBitwise::ICommonTOB::s_phi_width {9}

staticconstexprinherited

Size of the phi bitset.

Definition at line 39 of file ICommonTOB.h.

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

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CommonTOB() [1/3]

◆ CommonTOB() [2/3]

◆ CommonTOB() [3/3]

◆ ~CommonTOB()

Member Function Documentation

◆ et_bits()

◆ eta_bits()

◆ phi_bits()

◆ to_string()

Member Data Documentation

◆ m_et_bits

◆ m_eta_bits

◆ m_phi_bits

◆ max_et

◆ s_eFex_granularity

◆ s_et_width

◆ s_eta_width

◆ s_phi_width