Class to hold an eFexRoI and LAr strip neighbourhood. More...

#include <eEmNbhoodTOB.h>

Inheritance diagram for GlobalSim::IOBitwise::eEmNbhoodTOB:

Collaboration diagram for GlobalSim::IOBitwise::eEmNbhoodTOB:

Public Member Functions
	eEmNbhoodTOB (const xAOD::eFexEMRoI &eFexTOB, const GlobalSim::LArStripNeighborhood &nbhood)
	Constructor taking an eFexROITOB and a LArStripNeighborhood.
	eEmNbhoodTOB (const GlobalSim::IOBitwise::eEmTOB &tob, const GlobalSim::LArStripNeighborhood &nbhood)
	Constructor taking an eEmTOB and a LArStripNeighborhood.
virtual	~eEmNbhoodTOB ()
	Destructor.
virtual const LArStripNeighborhood &	Neighbourhood () const
	Returns the LarStripNeighbourhood: 3*17 cells centred on the eFexROI.
virtual std::string	to_string () const
	print out contents to string
virtual const std::bitset< s_RHad_width > &	RHad_bits () const override
	Returns the eFexRoI Rhad threshold bits.
virtual const std::bitset< s_WsTot_width > &	WsTot_bits () const override
	Returns the eFexRoI Wstot threshold bits.
virtual const std::bitset< s_REta_width > &	REta_bits () const override
	Returns the eFexRoI REta threshold bits.
virtual const std::bitset< s_Seed_width > &	Seed_bits () const override
	Returns the eFexRoI seed eta position bits.
virtual const std::bitset< s_UpNotDown_width > &	UpNotDown_bit () const override
	Returns the eFexRoI up not down bit.
virtual const std::bitset< s_SeedIsMax_width > &	SeedIsMax_bit () const override
	Returns the eFexRoI seed is a local maxima bit.

Static Public Attributes
static constexpr std::size_t	s_RHad_width {2}
	Count: Size of hadronic thresholds satisfied bitset.
static constexpr std::size_t	s_WsTot_width {2}
	Count: Size of WsTot algorithm thresholds satisfied bitset.
static constexpr std::size_t	s_REta_width {2}
	Count: Size of R0 thresholds satisfied bitset.
static constexpr std::size_t	s_Seed_width {2}
	Count: Size of Seed eta position in the TOB bitset.
static constexpr std::size_t	s_UpNotDown_width {1}
	Count: Size of UpnotDown bit.
static constexpr std::size_t	s_SeedIsMax_width {1}
	Count: Size of Seed supercell is a local maxima bit.
static constexpr std::size_t	s_et_width {13}
	Size of the eT bitset.
static constexpr std::size_t	s_eta_width {10}
	Size of the eta bitset.
static constexpr std::size_t	s_phi_width {9}
	Size of the phi bitset.
static constexpr std::size_t	s_eFex_granularity {100}
static constexpr ulong	max_et {(1UL << s_et_width)-1}

Private Member Functions
virtual std::bitset< s_et_width >	et_bits () const override
	Returns the eT bits of this TOB.
virtual std::bitset< s_eta_width >	eta_bits () const override
	Returns the eta bits of this TOB.
virtual std::bitset< s_phi_width >	phi_bits () const override
	Returns the phi bits of this TOB.

Private Attributes
LArStripNeighborhood	m_neighbourhood
	Property: LArStripNeighborhood associated with this eEmTOB.
std::bitset< s_RHad_width >	m_RHad_bits
	Property: RHad threshold bitset within the eEmTOB word.
std::bitset< s_WsTot_width >	m_WsTot_bits
	Property: Wstot threshold bitset within the eEmTOB word.
std::bitset< s_REta_width >	m_REta_bits
	Property: REta threshold bitset within the eEmTOB word.
std::bitset< s_Seed_width >	m_Seed_bits
	Property: Seed eta position bitset within the eEmTOB word.
std::bitset< s_UpNotDown_width >	m_UpNotDown_bit
	Property: Up not down bitset within the eEmTOB word.
std::bitset< s_SeedIsMax_width >	m_SeedIsMax_bit
	Property: Seed is a maximum bitset within the eEmTOB word.
std::bitset< ICommonTOB::s_et_width >	m_et_bits
	Property: eT bitset within the common TOB word.
std::bitset< ICommonTOB::s_eta_width >	m_eta_bits
	Property: eta bitset within the common TOB word.
std::bitset< ICommonTOB::s_phi_width >	m_phi_bits
	Property: phi bitset within the common TOB word.

Detailed Description

Class to hold an eFexRoI and LAr strip neighbourhood.

This class stores the eFEXROI information contained in an eEmTOB and associates it with a LArStripNeighborhood: a window of 3*17 cells around the centre of an eFexRoI

Additionally holds an LArStripNeighborhood alongside the eEmTOB information.

Definition at line 27 of file eEmNbhoodTOB.h.

Constructor & Destructor Documentation

◆ eEmNbhoodTOB() [1/2]

GlobalSim::IOBitwise::eEmNbhoodTOB::eEmNbhoodTOB	(	const xAOD::eFexEMRoI &	eFexTOB,
		const GlobalSim::LArStripNeighborhood &	nbhood )

Constructor taking an eFexROITOB and a LArStripNeighborhood.

Parameters

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

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

Definition at line 10 of file eEmNbhoodTOB.cxx.

11 :

12 eEmTOB(eFexTOB), m_neighbourhood(nbhood){}

GlobalSim::IOBitwise::eEmNbhoodTOB::m_neighbourhood

LArStripNeighborhood m_neighbourhood

Property: LArStripNeighborhood associated with this eEmTOB.

Definition eEmNbhoodTOB.h:65

GlobalSim::IOBitwise::eEmTOB::eEmTOB

eEmTOB(const xAOD::eFexEMRoI &eFexTOB)

Constructor taking an eFexROITOB to inisialise bits.

Definition Global/GlobalSimulation/src/IO/eEmTOB.cxx:10

◆ eEmNbhoodTOB() [2/2]

GlobalSim::IOBitwise::eEmNbhoodTOB::eEmNbhoodTOB	(	const GlobalSim::IOBitwise::eEmTOB &	tob,
		const GlobalSim::LArStripNeighborhood &	nbhood )

Constructor taking an eEmTOB and a LArStripNeighborhood.

Parameters

[in]	eFexTOB	The input eEmTOB
[in]	nbhood	The associated input neighbourhood

To be used to create, and initilise a global eEmTOB from an existing eEmTOB alongside an associated LArStripNeighbourhood. eFexRoI threshold bits are set here, the CommonTOB constructor is used to initialise the common bits.

Definition at line 14 of file eEmNbhoodTOB.cxx.

15 :

16 eEmTOB(tob), m_neighbourhood(nbhood){}

◆ ~eEmNbhoodTOB()

virtual GlobalSim::IOBitwise::eEmNbhoodTOB::~eEmNbhoodTOB ( )

inlinevirtual

Destructor.

Definition at line 55 of file eEmNbhoodTOB.h.

55{};

Member Function Documentation

◆ et_bits()

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.

                                                          {
    return m_et_bits;
  }

◆ eta_bits()

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.

                                                            {
    return m_eta_bits;
  }

◆ Neighbourhood()

const LArStripNeighborhood & GlobalSim::IOBitwise::eEmNbhoodTOB::Neighbourhood ( ) const

virtual

Returns the LarStripNeighbourhood: 3*17 cells centred on the eFexROI.

Definition at line 18 of file eEmNbhoodTOB.cxx.

                                                                {
    return m_neighbourhood;
  }

◆ phi_bits()

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.

                                                            {
    return m_phi_bits;
  }

◆ REta_bits()

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.

                                                               {
    return m_REta_bits;
  }

◆ RHad_bits()

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.

                                                               {
    return m_RHad_bits;
  }

◆ Seed_bits()

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.

                                                               {
    return m_Seed_bits;
  }

◆ SeedIsMax_bit()

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.

                                                                        {
    return m_SeedIsMax_bit;
  }

◆ to_string()

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

virtual

print out contents to string

Reimplemented from GlobalSim::IOBitwise::eEmTOB.

Definition at line 22 of file eEmNbhoodTOB.cxx.

                                          {
    std::stringstream ss;
    
    ss << '\n'
       << IeEmTOB::to_string()
       << "\n"
       << "Neighbourhood content:\n"
       << Neighbourhood().to_string();
    return ss.str();
  }

◆ UpNotDown_bit()

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.

                                                                        {
    return m_UpNotDown_bit;
  }

◆ WsTot_bits()

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.

                                                                 {
    return m_WsTot_bits;
  }

Member Data Documentation

◆ 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_neighbourhood

LArStripNeighborhood GlobalSim::IOBitwise::eEmNbhoodTOB::m_neighbourhood

private

Property: LArStripNeighborhood associated with this eEmTOB.

Definition at line 65 of file eEmNbhoodTOB.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

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

staticconstexprinherited

Definition at line 43 of file ICommonTOB.h.

43{(1UL << s_et_width)-1};

GlobalSim::IOBitwise::ICommonTOB::s_et_width

static constexpr std::size_t s_et_width

Size of the eT bitset.

Definition ICommonTOB.h:35

◆ s_eFex_granularity

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

staticconstexprinherited

Definition at line 41 of file ICommonTOB.h.

41{100}; // MeV

◆ s_et_width

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

staticconstexprinherited

Size of the eT bitset.

Definition at line 35 of file ICommonTOB.h.

35{13};

◆ s_eta_width

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

staticconstexprinherited

Size of the eta bitset.

Definition at line 37 of file ICommonTOB.h.

37{10};

◆ s_phi_width

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

staticconstexprinherited

Size of the phi bitset.

Definition at line 39 of file ICommonTOB.h.

39{9};

◆ s_REta_width

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

staticconstexprinherited

Count: Size of R0 thresholds satisfied bitset.

Definition at line 42 of file IeEmTOB.h.

42{2};

◆ s_RHad_width

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

staticconstexprinherited

Count: Size of hadronic thresholds satisfied bitset.

Definition at line 38 of file IeEmTOB.h.

38{2};

◆ s_Seed_width

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

staticconstexprinherited

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

Definition at line 44 of file IeEmTOB.h.

44{2};

◆ s_SeedIsMax_width

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

staticconstexprinherited

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

Definition at line 48 of file IeEmTOB.h.

48{1};

◆ s_UpNotDown_width

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

staticconstexprinherited

Count: Size of UpnotDown bit.

Definition at line 46 of file IeEmTOB.h.

46{1};

◆ s_WsTot_width

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

staticconstexprinherited

Count: Size of WsTot algorithm thresholds satisfied bitset.

Definition at line 40 of file IeEmTOB.h.

40{2};

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ eEmNbhoodTOB() [1/2]

◆ eEmNbhoodTOB() [2/2]

◆ ~eEmNbhoodTOB()

Member Function Documentation

◆ et_bits()

◆ eta_bits()

◆ Neighbourhood()

◆ phi_bits()

◆ REta_bits()

◆ RHad_bits()

◆ Seed_bits()

◆ SeedIsMax_bit()

◆ to_string()

◆ UpNotDown_bit()

◆ WsTot_bits()

Member Data Documentation

◆ m_et_bits

◆ m_eta_bits

◆ m_neighbourhood

◆ m_phi_bits

◆ m_REta_bits

◆ m_RHad_bits

◆ m_Seed_bits

◆ m_SeedIsMax_bit

◆ m_UpNotDown_bit

◆ m_WsTot_bits

◆ max_et

◆ s_eFex_granularity

◆ s_et_width

◆ s_eta_width

◆ s_phi_width

◆ s_REta_width

◆ s_RHad_width

◆ s_Seed_width

◆ s_SeedIsMax_width

◆ s_UpNotDown_width

◆ s_WsTot_width