Helper class to handle z-phi symmetry of calibration constants in MC. More...

#include <LArMCSym.h>

Collaboration diagram for LArMCSym:

Public Member Functions
	LArMCSym ()=delete
	LArMCSym (const LArOnlineID_Base onlId, const CaloCell_Base_ID caloId, std::vector< HWIdentifier > &&oflHashtoSymOnl, std::vector< HWIdentifier > &&onlHashtoSymOnl, std::vector< HWIdentifier > &&symIds)
	Constructor.
HWIdentifier	ZPhiSymOfl (const Identifier notSymOffId) const
	Find the symmetric HWID for an offline cell identifier.
HWIdentifier	ZPhiSymOfl (const IdentifierHash notSymOffHash) const
	Find the symmetric HWID for an offline cell hash.
size_t	ZPhiSymOflIndex (const Identifier notSymOffId) const
	Find the index in symIds() of the symmetric HWID for an offline cell identifier.
size_t	ZPhiSymOflIndex (const IdentifierHash notSymOffHash) const
	Find the index in symIds() of the symmetric HWID for an offline cell hash.
HWIdentifier	ZPhiSymOnl (const HWIdentifier notSymOnlId) const
	Find the symmetric HWID for an online channel identifier.
HWIdentifier	ZPhiSymOnl (const IdentifierHash notSymOnlHash) const
	Find the symmetric HWID for an online channel hash.
size_t	ZPhiSymOnlIndex (const HWIdentifier notSymOnlId) const
	Find the index in symIds() of the symmetric HWID for an online channel identifier.
size_t	ZPhiSymOnlIndex (const IdentifierHash notSymOnlHash) const
	Find the index in symIds() of the symmetric HWID for an online channel hash.
const std::vector< HWIdentifier > &	symIds () const
	Return the list of symmetric hashes.
std::pair< size_t, size_t >	hashMax () const
	Return the hash-max as pair<onlHashMax,oflHashMax>

Static Public Attributes
static constexpr size_t	NO_INDEX = static_cast<size_t> (-1)
	Return for an index if there's no valid symmetric identifier.

Private Types
typedef std::pair< Identifier32::value_type, uint32_t >	IdPair_t

Private Member Functions
std::vector< IdPair_t >	initIndices (const std::vector< HWIdentifier > &ids, const std::vector< HWIdentifier > &symIds) const

Private Attributes
const LArOnlineID_Base *	m_onlineID
const CaloCell_Base_ID *	m_caloCellID
const std::vector< IdPair_t >	m_oflHashtoSymOnl
const std::vector< IdPair_t >	m_onlHashtoSymOnl
const std::vector< HWIdentifier >	m_symIds

Detailed Description

Helper class to handle z-phi symmetry of calibration constants in MC.

Definition at line 18 of file LArMCSym.h.

Member Typedef Documentation

◆ IdPair_t

typedef std::pair<Identifier32::value_type, uint32_t> LArMCSym::IdPair_t

private

Definition at line 146 of file LArMCSym.h.

Constructor & Destructor Documentation

◆ LArMCSym() [1/2]

LArMCSym::LArMCSym ( )

delete

◆ LArMCSym() [2/2]

LArMCSym::LArMCSym	(	const LArOnlineID_Base *	onlId,
		const CaloCell_Base_ID *	caloId,
		std::vector< HWIdentifier > &&	oflHashtoSymOnl,
		std::vector< HWIdentifier > &&	onlHashtoSymOnl,
		std::vector< HWIdentifier > &&	symIds )

Constructor.

onlId Online ID helper.

caloId Offline ID helper.

oflHashtoSymOnl Symmetric HWID corresponding to each offline hash.

onlHashtoSymOnl Symmetric HWID corresponding to each online hash.

symIds List of all symmetric HWIDs. MUST BE SORTED.

Definition at line 18 of file LArMCSym.cxx.

                                             :
  m_onlineID(onlId),
  m_caloCellID(caloId),
  m_oflHashtoSymOnl (initIndices (oflHashtoSymOnl, symIds)),
  m_onlHashtoSymOnl (initIndices (onlHashtoSymOnl, symIds)),
  m_symIds(std::move(symIds))
{
}

Member Function Documentation

◆ hashMax()

std::pair< size_t, size_t > LArMCSym::hashMax ( ) const

inline

Return the hash-max as pair<onlHashMax,oflHashMax>

Definition at line 139 of file LArMCSym.h.

                                         {
    return std::make_pair(m_onlHashtoSymOnl.size(),m_oflHashtoSymOnl.size());
  }

◆ initIndices()

std::vector< LArMCSym::IdPair_t > LArMCSym::initIndices	(	const std::vector< HWIdentifier > &	ids,
		const std::vector< HWIdentifier > &	symIds ) const

private

Definition at line 33 of file LArMCSym.cxx.

{
  std::vector<IdPair_t> out;
  out.reserve (ids.size());
  HWIdentifier last_id;
  size_t idx = NO_INDEX;
  for (const HWIdentifier& id : ids) {
    if (!id.is_valid()) {
      idx = NO_INDEX;
    }
    else if (id != last_id) {
      if (idx < symIds.size()-1 && symIds[idx+1] == id) {
        ++idx;
      }
      else {
        auto it = std::lower_bound (symIds.begin(), symIds.end(), id);
        if (it == symIds.end() || *it != id) std::abort();
        idx = it - symIds.begin();
      }
    }
    out.emplace_back (id.get_identifier32().get_compact(), idx);
    last_id = id;
  }
 
  return out;
}

◆ symIds()

const std::vector< HWIdentifier > & LArMCSym::symIds ( ) const

inline

Return the list of symmetric hashes.

Definition at line 132 of file LArMCSym.h.

                                                {
    return m_symIds;
  }

◆ ZPhiSymOfl() [1/2]

HWIdentifier LArMCSym::ZPhiSymOfl ( const Identifier notSymOffId ) const

inline

Find the symmetric HWID for an offline cell identifier.

May return an invalid identifier.

Definition at line 48 of file LArMCSym.h.

                                                              {
    if (m_caloCellID->is_tile(notSymOffId)) return HWIdentifier();
    const IdentifierHash h=m_caloCellID->calo_cell_hash(notSymOffId);
    return ZPhiSymOfl(h);
  }

◆ ZPhiSymOfl() [2/2]

HWIdentifier LArMCSym::ZPhiSymOfl ( const IdentifierHash notSymOffHash ) const

inline

Find the symmetric HWID for an offline cell hash.

May return an invalid identifier.

Definition at line 59 of file LArMCSym.h.

                                                                    {
    assert(notSymOffHash < m_oflHashtoSymOnl.size());
    return HWIdentifier (m_oflHashtoSymOnl[notSymOffHash].first);
  }

◆ ZPhiSymOflIndex() [1/2]

size_t LArMCSym::ZPhiSymOflIndex ( const Identifier notSymOffId ) const

inline

Find the index in symIds() of the symmetric HWID for an offline cell identifier.

Returns NO_INDEX if no symmetric identifier is defined.

Definition at line 70 of file LArMCSym.h.

                                                             {
    if (m_caloCellID->is_tile(notSymOffId)) return NO_INDEX;
    const IdentifierHash h=m_caloCellID->calo_cell_hash(notSymOffId);
    return ZPhiSymOflIndex(h);
  }

◆ ZPhiSymOflIndex() [2/2]

size_t LArMCSym::ZPhiSymOflIndex ( const IdentifierHash notSymOffHash ) const

inline

Find the index in symIds() of the symmetric HWID for an offline cell hash.

Returns NO_INDEX if no symmetric identifier is defined.

Definition at line 81 of file LArMCSym.h.

                                                                   {
    assert(notSymOffHash < m_oflHashtoSymOnl.size());
    return m_oflHashtoSymOnl[notSymOffHash].second;
  }

◆ ZPhiSymOnl() [1/2]

HWIdentifier LArMCSym::ZPhiSymOnl ( const HWIdentifier notSymOnlId ) const

inline

Find the symmetric HWID for an online channel identifier.

May return an invalid identifier.

Definition at line 91 of file LArMCSym.h.

                                                                {
    const IdentifierHash h=m_onlineID->channel_Hash(notSymOnlId);
    return ZPhiSymOnl(h);
  }

◆ ZPhiSymOnl() [2/2]

HWIdentifier LArMCSym::ZPhiSymOnl ( const IdentifierHash notSymOnlHash ) const

inline

Find the symmetric HWID for an online channel hash.

May return an invalid identifier.

Definition at line 101 of file LArMCSym.h.

                                                                    {
    assert(notSymOnlHash < m_onlHashtoSymOnl.size());
    return HWIdentifier (m_onlHashtoSymOnl[notSymOnlHash].first);
  }

◆ ZPhiSymOnlIndex() [1/2]

size_t LArMCSym::ZPhiSymOnlIndex ( const HWIdentifier notSymOnlId ) const

inline

Find the index in symIds() of the symmetric HWID for an online channel identifier.

Returns NO_INDEX if no symmetric identifier is defined.

Definition at line 112 of file LArMCSym.h.

                                                               {
    const IdentifierHash h=m_onlineID->channel_Hash(notSymOnlId);
    return ZPhiSymOnlIndex(h);
  }

◆ ZPhiSymOnlIndex() [2/2]

size_t LArMCSym::ZPhiSymOnlIndex ( const IdentifierHash notSymOnlHash ) const

inline

Find the index in symIds() of the symmetric HWID for an online channel hash.

Returns NO_INDEX if no symmetric identifier is defined.

Definition at line 123 of file LArMCSym.h.

                                                                   {
    assert(notSymOnlHash < m_onlHashtoSymOnl.size());
    return m_onlHashtoSymOnl[notSymOnlHash].second;
  }

Member Data Documentation

◆ m_caloCellID

const CaloCell_Base_ID* LArMCSym::m_caloCellID

private

Definition at line 153 of file LArMCSym.h.

◆ m_oflHashtoSymOnl

const std::vector<IdPair_t> LArMCSym::m_oflHashtoSymOnl

private

Definition at line 154 of file LArMCSym.h.

◆ m_onlHashtoSymOnl

const std::vector<IdPair_t> LArMCSym::m_onlHashtoSymOnl

private

Definition at line 155 of file LArMCSym.h.

◆ m_onlineID

const LArOnlineID_Base* LArMCSym::m_onlineID

private

Definition at line 152 of file LArMCSym.h.

◆ m_symIds

const std::vector<HWIdentifier> LArMCSym::m_symIds

private

Definition at line 156 of file LArMCSym.h.

◆ NO_INDEX

size_t LArMCSym::NO_INDEX = static_cast<size_t> (-1)

staticconstexpr

Return for an index if there's no valid symmetric identifier.

Definition at line 41 of file LArMCSym.h.

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

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IdPair_t

Constructor & Destructor Documentation

◆ LArMCSym() [1/2]

◆ LArMCSym() [2/2]

Member Function Documentation

◆ hashMax()

◆ initIndices()

◆ symIds()

◆ ZPhiSymOfl() [1/2]

◆ ZPhiSymOfl() [2/2]

◆ ZPhiSymOflIndex() [1/2]

◆ ZPhiSymOflIndex() [2/2]

◆ ZPhiSymOnl() [1/2]

◆ ZPhiSymOnl() [2/2]

◆ ZPhiSymOnlIndex() [1/2]

◆ ZPhiSymOnlIndex() [2/2]

Member Data Documentation

◆ m_caloCellID

◆ m_oflHashtoSymOnl

◆ m_onlHashtoSymOnl

◆ m_onlineID

◆ m_symIds

◆ NO_INDEX