ATLAS Offline Software
Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
GlobalSim::IOBitwise::eEmEg1BDTTOB Class Referenceabstract

Class to hold eGamma1 BDT decision bits. More...

#include <eEmEg1BDTTOB.h>

Inheritance diagram for GlobalSim::IOBitwise::eEmEg1BDTTOB:
Collaboration diagram for GlobalSim::IOBitwise::eEmEg1BDTTOB:

Public Member Functions

 eEmEg1BDTTOB (const xAOD::eFexEMRoI &eFexTOB, std::bitset< s_eGamma1BDT_width > eGamma1BDT_bits)
 Constructor taking an eFexROITOB and eGamma1 BDT output bits to initialise bits. More...
 
 eEmEg1BDTTOB (const IeEmTOB &eEmTOB, std::bitset< s_eGamma1BDT_width > eGamma1BDT_bits)
 Constructor taking an eEmTOB and eGamma1 BDT output bits to initialise bits. More...
 
virtual ~eEmEg1BDTTOB ()
 Destructor. More...
 
virtual std::bitset< s_eGamma1BDT_widtheGamma1BDT_bits () const override
 Returns the eGamma1 BDT result bits. More...
 
virtual std::string to_string () const override
 print out contents to string More...
 
virtual const std::bitset< s_RHad_width > & RHad_bits () const =0
 Returns the eFexRoI Rhad threshold bits. More...
 
virtual const std::bitset< s_WsTot_width > & WsTot_bits () const =0
 Returns the eFexRoI Wstot threshold bits. More...
 
virtual const std::bitset< s_REta_width > & REta_bits () const =0
 Returns the eFexRoI REta threshold bits. More...
 
virtual const std::bitset< s_Seed_width > & Seed_bits () const =0
 Returns the eFexRoI seed eta position bits. More...
 
virtual const std::bitset< s_UpNotDown_width > & UpNotDown_bit () const =0
 Returns the eFexRoI up not down bit. More...
 
virtual const std::bitset< s_SeedIsMax_width > & SeedIsMax_bit () const =0
 Returns the eFexRoI seed is a local maxima bit. More...
 
virtual std::bitset< s_et_widthet_bits () const =0
 Returns the eT bits of this TOB. More...
 
virtual std::bitset< s_eta_widtheta_bits () const =0
 Returns the eta bits of this TOB. More...
 
virtual std::bitset< s_phi_widthphi_bits () const =0
 Returns the phi bits of this TOB. More...
 

Static Public Attributes

static const std::size_t s_eGamma1BDT_width {10}
 Count: Size of output bits of the eGamma1 BDT algorithm. More...
 
static const std::size_t s_RHad_width {2}
 Count: Size of hadronic thresholds satisfied bitset. More...
 
static const std::size_t s_WsTot_width {2}
 Count: Size of WsTot algorithm thresholds satisfied bitset. More...
 
static const std::size_t s_REta_width {2}
 Count: Size of R0 thresholds satisfied bitset. More...
 
static const std::size_t s_Seed_width {2}
 Count: Size of Seed eta position in the TOB bitset. More...
 
static const std::size_t s_UpNotDown_width {1}
 Count: Size of UpnotDown bit. More...
 
static const std::size_t s_SeedIsMax_width {1}
 Count: Size of Seed supercell is a local maxima bit. More...
 
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 Member Functions

virtual const std::bitset< s_RHad_width > & RHad_bits () const override
 Returns the eFexRoI Rhad threshold bits. More...
 
virtual const std::bitset< s_WsTot_width > & WsTot_bits () const override
 Returns the eFexRoI Wstot threshold bits. More...
 
virtual const std::bitset< s_REta_width > & REta_bits () const override
 Returns the eFexRoI REta threshold bits. More...
 
virtual const std::bitset< s_Seed_width > & Seed_bits () const override
 Returns the eFexRoI seed eta position bits. More...
 
virtual const std::bitset< s_UpNotDown_width > & UpNotDown_bit () const override
 Returns the eFexRoI up not down bit. More...
 
virtual const std::bitset< s_SeedIsMax_width > & SeedIsMax_bit () const override
 Returns the eFexRoI seed is a local maxima bit. More...
 
virtual std::bitset< s_et_widthet_bits () const override
 Returns the eT bits of this TOB. More...
 
virtual std::bitset< s_eta_widtheta_bits () const override
 Returns the eta bits of this TOB. More...
 
virtual std::bitset< s_phi_widthphi_bits () const override
 Returns the phi bits of this TOB. More...
 

Private Attributes

std::bitset< s_eGamma1BDT_widthm_eGamma1BDT_bits
 Property: Bitset to hold the eGamma1BDT bits. More...
 
std::bitset< s_RHad_widthm_RHad_bits
 Property: RHad threshold bitset within the eEmTOB word. More...
 
std::bitset< s_WsTot_widthm_WsTot_bits
 Property: Wstot threshold bitset within the eEmTOB word. More...
 
std::bitset< s_REta_widthm_REta_bits
 Property: REta threshold bitset within the eEmTOB word. More...
 
std::bitset< s_Seed_widthm_Seed_bits
 Property: Seed eta position bitset within the eEmTOB word. More...
 
std::bitset< s_UpNotDown_widthm_UpNotDown_bit
 Property: Up not down bitset within the eEmTOB word. More...
 
std::bitset< s_SeedIsMax_widthm_SeedIsMax_bit
 Property: Seed is a maximum bitset within the eEmTOB word. More...
 
std::bitset< ICommonTOB::s_et_widthm_et_bits
 Property: eT bitset within the common TOB word. More...
 
std::bitset< ICommonTOB::s_eta_widthm_eta_bits
 Property: eta bitset within the common TOB word. More...
 
std::bitset< ICommonTOB::s_phi_widthm_phi_bits
 Property: phi bitset within the common TOB word. More...
 

Detailed Description

Class to hold eGamma1 BDT decision bits.

This class stores the result of the eGamma1 BDT and defines functions to retrieve this information. It has access to the eEmTOB and CommonTOB class information and can be used as an eEmTOB or CommonTOB.

Definition at line 23 of file eEmEg1BDTTOB.h.

Constructor & Destructor Documentation

◆ eEmEg1BDTTOB() [1/2]

GlobalSim::IOBitwise::eEmEg1BDTTOB::eEmEg1BDTTOB ( const xAOD::eFexEMRoI eFexTOB,
std::bitset< s_eGamma1BDT_width eGamma1BDT_bits 
)

Constructor taking an eFexROITOB and eGamma1 BDT output bits to initialise bits.

Parameters
[in]eFexTOBThe input eFexRoI TOB defining the common/eFex bits.
[in]eGamma1BDT_bitsThe input eGamma1 BDT bits defining the result of the algorithm.

To be used to create, and initilise a global eEmTOB from an existing eFexTOB and an eGamma1 BDT result eGamma1 BDT result bits are set here, eFexRoI threshold bits are set in the eEmTOB constructor, the CommonTOB constructor is used to initialise the common bits.

◆ eEmEg1BDTTOB() [2/2]

GlobalSim::IOBitwise::eEmEg1BDTTOB::eEmEg1BDTTOB ( const IeEmTOB eEmTOB,
std::bitset< s_eGamma1BDT_width eGamma1BDT_bits 
)

Constructor taking an eEmTOB and eGamma1 BDT output bits to initialise bits.

Parameters
[in]eEmTOBThe input eEmTOB defining the common/eFex bits.
[in]eGamma1BDT_bitsThe input eGamma1 BDT bits defining the result of the algorithm.

To be used to create, and initilise a global eEmTOB from an existing eEmTOB and an eGamma1 BDT result eGamma1 BDT result bits are set here, eFexRoI threshold bits are set in the eEmTOB constructor, the CommonTOB constructor is used to initialise the common bits.

◆ ~eEmEg1BDTTOB()

virtual GlobalSim::IOBitwise::eEmEg1BDTTOB::~eEmEg1BDTTOB ( )
inlinevirtual

Destructor.

Definition at line 52 of file eEmEg1BDTTOB.h.

52 {};

Member Function Documentation

◆ eGamma1BDT_bits()

std::bitset< IeEmEg1BDTTOB::s_eGamma1BDT_width > GlobalSim::IOBitwise::eEmEg1BDTTOB::eGamma1BDT_bits ( ) const
overridevirtual

Returns the eGamma1 BDT result bits.

Implements GlobalSim::IOBitwise::IeEmEg1BDTTOB.

Definition at line 17 of file eEmEg1BDTTOB.cxx.

17  {
18  return m_eGamma1BDT_bits;
19  }

◆ et_bits() [1/2]

virtual std::bitset<s_et_width> GlobalSim::IOBitwise::ICommonTOB::et_bits ( ) const
pure virtualinherited

Returns the eT bits of this TOB.

Implemented in GlobalSim::IOBitwise::CommonTOB.

◆ et_bits() [2/2]

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

Returns the eT bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 25 of file CommonTOB.cxx.

25  {
26  return m_et_bits;
27  }

◆ eta_bits() [1/2]

virtual std::bitset<s_eta_width> GlobalSim::IOBitwise::ICommonTOB::eta_bits ( ) const
pure virtualinherited

Returns the eta bits of this TOB.

Implemented in GlobalSim::IOBitwise::CommonTOB.

◆ eta_bits() [2/2]

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

Returns the eta bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 29 of file CommonTOB.cxx.

29  {
30  return m_eta_bits;
31  }

◆ phi_bits() [1/2]

virtual std::bitset<s_phi_width> GlobalSim::IOBitwise::ICommonTOB::phi_bits ( ) const
pure virtualinherited

Returns the phi bits of this TOB.

Implemented in GlobalSim::IOBitwise::CommonTOB.

◆ phi_bits() [2/2]

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

Returns the phi bits of this TOB.

Implements GlobalSim::IOBitwise::ICommonTOB.

Definition at line 33 of file CommonTOB.cxx.

33  {
34  return m_phi_bits;
35  }

◆ REta_bits() [1/2]

virtual const std::bitset<s_REta_width>& GlobalSim::IOBitwise::IeEmTOB::REta_bits ( ) const
pure virtualinherited

Returns the eFexRoI REta threshold bits.

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ REta_bits() [2/2]

const std::bitset< eEmTOB::s_REta_width > & GlobalSim::IOBitwise::eEmTOB::REta_bits ( ) const
overridevirtualinherited

Returns the eFexRoI REta threshold bits.

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 54 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

54  {
55  return m_REta_bits;
56  }

◆ RHad_bits() [1/2]

virtual const std::bitset<s_RHad_width>& GlobalSim::IOBitwise::IeEmTOB::RHad_bits ( ) const
pure virtualinherited

Returns the eFexRoI Rhad threshold bits.

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ RHad_bits() [2/2]

const std::bitset< eEmTOB::s_RHad_width > & GlobalSim::IOBitwise::eEmTOB::RHad_bits ( ) const
overridevirtualinherited

Returns the eFexRoI Rhad threshold bits.

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 46 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

46  {
47  return m_RHad_bits;
48  }

◆ Seed_bits() [1/2]

virtual const std::bitset<s_Seed_width>& GlobalSim::IOBitwise::IeEmTOB::Seed_bits ( ) const
pure virtualinherited

Returns the eFexRoI seed eta position bits.

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ Seed_bits() [2/2]

const std::bitset< eEmTOB::s_Seed_width > & GlobalSim::IOBitwise::eEmTOB::Seed_bits ( ) const
overridevirtualinherited

Returns the eFexRoI seed eta position bits.

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 58 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

58  {
59  return m_Seed_bits;
60  }

◆ SeedIsMax_bit() [1/2]

virtual const std::bitset<s_SeedIsMax_width>& GlobalSim::IOBitwise::IeEmTOB::SeedIsMax_bit ( ) const
pure virtualinherited

Returns the eFexRoI seed is a local maxima bit.

True if the seed supercell is a local maxima

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ SeedIsMax_bit() [2/2]

const std::bitset< eEmTOB::s_SeedIsMax_width > & GlobalSim::IOBitwise::eEmTOB::SeedIsMax_bit ( ) const
overridevirtualinherited

Returns the eFexRoI seed is a local maxima bit.

True if the seed supercell is a local maxima

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 66 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

66  {
67  return m_SeedIsMax_bit;
68  }

◆ to_string()

std::string GlobalSim::IOBitwise::eEmEg1BDTTOB::to_string ( ) const
overridevirtual

print out contents to string

Reimplemented from GlobalSim::IOBitwise::eEmTOB.

Definition at line 21 of file eEmEg1BDTTOB.cxx.

21  {
22  return IeEmEg1BDTTOB::to_string();
23  }

◆ UpNotDown_bit() [1/2]

virtual const std::bitset<s_UpNotDown_width>& GlobalSim::IOBitwise::IeEmTOB::UpNotDown_bit ( ) const
pure virtualinherited

Returns the eFexRoI up not down bit.

True, if the seed includes the supercell above in phi.

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ UpNotDown_bit() [2/2]

const std::bitset< eEmTOB::s_UpNotDown_width > & GlobalSim::IOBitwise::eEmTOB::UpNotDown_bit ( ) const
overridevirtualinherited

Returns the eFexRoI up not down bit.

True, if the seed includes the supercell above in phi.

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 62 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

62  {
63  return m_UpNotDown_bit;
64  }

◆ WsTot_bits() [1/2]

virtual const std::bitset<s_WsTot_width>& GlobalSim::IOBitwise::IeEmTOB::WsTot_bits ( ) const
pure virtualinherited

Returns the eFexRoI Wstot threshold bits.

Implemented in GlobalSim::IOBitwise::eEmTOB.

◆ WsTot_bits() [2/2]

const std::bitset< eEmTOB::s_WsTot_width > & GlobalSim::IOBitwise::eEmTOB::WsTot_bits ( ) const
overridevirtualinherited

Returns the eFexRoI Wstot threshold bits.

Implements GlobalSim::IOBitwise::IeEmTOB.

Definition at line 50 of file Global/GlobalSimulation/src/IO/eEmTOB.cxx.

50  {
51  return m_WsTot_bits;
52  }

Member Data Documentation

◆ m_eGamma1BDT_bits

std::bitset<s_eGamma1BDT_width> GlobalSim::IOBitwise::eEmEg1BDTTOB::m_eGamma1BDT_bits
private

Property: Bitset to hold the eGamma1BDT bits.

Definition at line 61 of file eEmEg1BDTTOB.h.

◆ m_et_bits

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

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
privateinherited

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
privateinherited

Property: phi bitset within the common TOB word.

Definition at line 70 of file CommonTOB.h.

◆ m_REta_bits

std::bitset<s_REta_width> GlobalSim::IOBitwise::eEmTOB::m_REta_bits
privateinherited

Property: REta threshold bitset within the eEmTOB word.

Definition at line 80 of file Global/GlobalSimulation/src/IO/eEmTOB.h.

◆ m_RHad_bits

std::bitset<s_RHad_width> GlobalSim::IOBitwise::eEmTOB::m_RHad_bits
privateinherited

Property: RHad threshold bitset within the eEmTOB word.

Definition at line 76 of file Global/GlobalSimulation/src/IO/eEmTOB.h.

◆ m_Seed_bits

std::bitset<s_Seed_width> GlobalSim::IOBitwise::eEmTOB::m_Seed_bits
privateinherited

Property: Seed eta position bitset within the eEmTOB word.

Definition at line 82 of file Global/GlobalSimulation/src/IO/eEmTOB.h.

◆ m_SeedIsMax_bit

std::bitset<s_SeedIsMax_width> GlobalSim::IOBitwise::eEmTOB::m_SeedIsMax_bit
privateinherited

Property: Seed is a maximum bitset within the eEmTOB word.

Definition at line 86 of file Global/GlobalSimulation/src/IO/eEmTOB.h.

◆ m_UpNotDown_bit

std::bitset<s_UpNotDown_width> GlobalSim::IOBitwise::eEmTOB::m_UpNotDown_bit
privateinherited

Property: Up not down bitset within the eEmTOB word.

Definition at line 84 of file Global/GlobalSimulation/src/IO/eEmTOB.h.

◆ m_WsTot_bits

std::bitset<s_WsTot_width> GlobalSim::IOBitwise::eEmTOB::m_WsTot_bits
privateinherited

Property: Wstot threshold bitset within the eEmTOB word.

Definition at line 78 of file Global/GlobalSimulation/src/IO/eEmTOB.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_eGamma1BDT_width

const std::size_t GlobalSim::IOBitwise::IeEmEg1BDTTOB::s_eGamma1BDT_width {10}
staticinherited

Count: Size of output bits of the eGamma1 BDT algorithm.

Definition at line 35 of file IeEmEg1BDTTOB.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.

◆ s_REta_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_REta_width {2}
staticinherited

Count: Size of R0 thresholds satisfied bitset.

Definition at line 42 of file IeEmTOB.h.

◆ s_RHad_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_RHad_width {2}
staticinherited

Count: Size of hadronic thresholds satisfied bitset.

Definition at line 38 of file IeEmTOB.h.

◆ s_Seed_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_Seed_width {2}
staticinherited

Count: Size of Seed eta position in the TOB bitset.

Definition at line 44 of file IeEmTOB.h.

◆ s_SeedIsMax_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_SeedIsMax_width {1}
staticinherited

Count: Size of Seed supercell is a local maxima bit.

Definition at line 48 of file IeEmTOB.h.

◆ s_UpNotDown_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_UpNotDown_width {1}
staticinherited

Count: Size of UpnotDown bit.

Definition at line 46 of file IeEmTOB.h.

◆ s_WsTot_width

const std::size_t GlobalSim::IOBitwise::IeEmTOB::s_WsTot_width {2}
staticinherited

Count: Size of WsTot algorithm thresholds satisfied bitset.

Definition at line 40 of file IeEmTOB.h.


The documentation for this class was generated from the following files:
GlobalSim::IOBitwise::CommonTOB::m_et_bits
std::bitset< ICommonTOB::s_et_width > m_et_bits
Property: eT bitset within the common TOB word.
Definition: CommonTOB.h:66
GlobalSim::IOBitwise::eEmTOB::m_WsTot_bits
std::bitset< s_WsTot_width > m_WsTot_bits
Property: Wstot threshold bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:78
GlobalSim::IOBitwise::eEmEg1BDTTOB::m_eGamma1BDT_bits
std::bitset< s_eGamma1BDT_width > m_eGamma1BDT_bits
Property: Bitset to hold the eGamma1BDT bits.
Definition: eEmEg1BDTTOB.h:61
GlobalSim::IOBitwise::eEmTOB::m_Seed_bits
std::bitset< s_Seed_width > m_Seed_bits
Property: Seed eta position bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:82
GlobalSim::IOBitwise::eEmTOB::m_UpNotDown_bit
std::bitset< s_UpNotDown_width > m_UpNotDown_bit
Property: Up not down bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:84
GlobalSim::IOBitwise::CommonTOB::m_phi_bits
std::bitset< ICommonTOB::s_phi_width > m_phi_bits
Property: phi bitset within the common TOB word.
Definition: CommonTOB.h:70
GlobalSim::IOBitwise::eEmTOB::m_REta_bits
std::bitset< s_REta_width > m_REta_bits
Property: REta threshold bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:80
GlobalSim::IOBitwise::IeEmEg1BDTTOB::to_string
virtual std::string to_string() const =0
print out contents to string
Definition: IeEmEg1BDTTOB.cxx:10
GlobalSim::IOBitwise::eEmTOB::m_SeedIsMax_bit
std::bitset< s_SeedIsMax_width > m_SeedIsMax_bit
Property: Seed is a maximum bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:86
GlobalSim::IOBitwise::eEmTOB::m_RHad_bits
std::bitset< s_RHad_width > m_RHad_bits
Property: RHad threshold bitset within the eEmTOB word.
Definition: Global/GlobalSimulation/src/IO/eEmTOB.h:76
GlobalSim::IOBitwise::CommonTOB::m_eta_bits
std::bitset< ICommonTOB::s_eta_width > m_eta_bits
Property: eta bitset within the common TOB word.
Definition: CommonTOB.h:68