algorithmic methods of the legacy CaloSampling.h class used by the legacy CaloCluster object More...

#include <CaloSamplingHelper.h>

Inheritance diagram for CaloSamplingHelper:

Collaboration diagram for CaloSamplingHelper:

Public Types
enum	CaloSample
enum	CaloSample

Public Member Functions
	CaloSamplingHelper ()=default
	~CaloSamplingHelper ()=default
	CaloSamplingHelper (const CaloSamplingHelper &rhs)=delete
CaloSamplingHelper &	operator= (const CaloSamplingHelper &rhs)=delete

Static Public Member Functions
static CaloSample	getSampling (const CaloCell &c)
	Retrieves the sampling indicator for a cell.
static unsigned int	getSamplingBit (const CaloSample &rSample)
	Return a unique bit set for a given sampling.
static unsigned int	getSamplingBit (const CaloCell &rCell)
	Return a unique bit set for a given sampling.
static bool	isEMSampling (const CaloSample &rSample)
	Get sampling characteristics.
static bool	isHADSampling (const CaloSample &rSample)
static bool	isBarrelSampling (const CaloSample &rSample)
static bool	isEndCapSampling (const CaloSample &rSample)
static bool	isLArSampling (const CaloSample &rSample)
static bool	isTileSampling (const CaloSample &rSample)
static const std::string &	getSamplingName (const CaloSampling::CaloSample theSample)
	Returns a string (name) for each CaloSampling.
static CaloSampling::CaloSample	getSamplingId (const std::string &samplingName)
	Returns the `CaloSampling::CaloSample` enumerator value.
static bool	getSamplings (const std::vector< CaloCell_ID::SUBCALO > &theCalos, std::vector< CaloSampling::CaloSample > &theSamplings)
	Returns a list of samplings enumerators for a list of sub-calos.
static bool	getSamplings (const CaloCell_ID::SUBCALO &theCalo, std::vector< CaloSampling::CaloSample > &theSamplings)
	Returns a list of samplings enumerators for a list of sub-calos This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
static bool	getCalos (const std::vector< CaloSampling::CaloSample > &theSamplings, std::vector< CaloCell_ID::SUBCALO > &theCalos)
	Returns a list of sub-calos for a list of samplings.
static constexpr unsigned int	getNumberOfSamplings ()
	Get number of available samplings.
static unsigned int	getNumberOfSamplings ()
	Get number of available samplings.
static unsigned int	getSamplingPattern (const CaloSample s)
	Get a unsigned with one bit set.
static unsigned int	getSamplingPattern (const CaloSample s)
	Get a unsigned with one bit set.
static constexpr unsigned int	barrelPattern ()
	Get the bit-pattern for barrel samplings.
static unsigned int	barrelPattern ()
	Get the bit-pattern for barrel samplings.
static constexpr unsigned int	endcapPattern ()
	Get the bit-pattern for endcap samplings.
static unsigned int	endcapPattern ()
	Get the bit-pattern for endcap samplings.
static std::string	getSamplingName (unsigned int theSample)
	Returns a string (name) for each CaloSampling.
static CaloSample	getSampling (const std::string &name)
	Return the sampling code for a given name.

Static Private Member Functions
static bool	matchPattern (const CaloSample &rSample, const unsigned int &mask)

Static Private Attributes
static const unsigned int	m_EMMask = 0x000000ff
static const unsigned int	m_HADMask = 0x00ffff00
static const unsigned int	m_BarrelMask = 0x001ff00f
static const unsigned int	m_EndCapMask = 0x00e00ff0
static const unsigned int	m_LArMask = 0x00e00fff
static const unsigned int	m_TileMask = 0x001ff000
static const std::map< std::string, CaloSampling::CaloSample >	m_lookUp
static const std::string	m_unknown ="Unknown"

Detailed Description

algorithmic methods of the legacy CaloSampling.h class used by the legacy CaloCluster object

Definition at line 19 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

Member Enumeration Documentation

◆ CaloSample [1/2]

enum CaloSampling::CaloSample

inherited

Definition at line 22 of file Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h.

                   {
#define CALOSAMPLING(NAME, ISBARREL, ISENDCAP) NAME,
#include "CaloGeoHelpers/CaloSampling.def"
#undef CALOSAMPLING
   };

◆ CaloSample [2/2]

enum CaloSampling::CaloSample

inherited

Definition at line 22 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/CaloGeoHelpers/CaloSampling.h.

                   {
#define CALOSAMPLING(NAME, ISBARREL, ISENDCAP) NAME,
#include "CaloGeoHelpers/CaloSampling.def"
#undef CALOSAMPLING
   };

Constructor & Destructor Documentation

◆ CaloSamplingHelper() [1/2]

CaloSamplingHelper::CaloSamplingHelper ( )

default

◆ ~CaloSamplingHelper()

CaloSamplingHelper::~CaloSamplingHelper ( )

default

◆ CaloSamplingHelper() [2/2]

CaloSamplingHelper::CaloSamplingHelper ( const CaloSamplingHelper & rhs )

delete

Member Function Documentation

◆ barrelPattern() [1/2]

unsigned int CaloSampling::barrelPattern ( )

inlinestaticconstexprinherited

Get the bit-pattern for barrel samplings.

Definition at line 75 of file Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h.

                                         {
  return (//EM Barrel
#define CALOSAMPLING(NAME, ISBARREL, ISENDCAP) (((unsigned)ISBARREL)<<NAME) |
#include "CaloGeoHelpers/CaloSampling.def"
#undef CALOSAMPLING
      0 );
}

◆ barrelPattern() [2/2]

unsigned int CaloSampling::barrelPattern ( )

staticinherited

Get the bit-pattern for barrel samplings.

◆ endcapPattern() [1/2]

unsigned int CaloSampling::endcapPattern ( )

inlinestaticconstexprinherited

Get the bit-pattern for endcap samplings.

Definition at line 84 of file Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h.

                                         {
  return (//EMEC:
#define CALOSAMPLING(NAME, ISBARREL, ISENDCAP) (((unsigned)ISENDCAP)<<NAME) |
#include "CaloGeoHelpers/CaloSampling.def"
#undef CALOSAMPLING
      0 );
}

◆ endcapPattern() [2/2]

unsigned int CaloSampling::endcapPattern ( )

staticinherited

Get the bit-pattern for endcap samplings.

◆ getCalos()

bool CaloSamplingHelper::getCalos	(	const std::vector< CaloSampling::CaloSample > &	theSamplings,
		std::vector< CaloCell_ID::SUBCALO > &	theCalos )

static

Returns a list of sub-calos for a list of samplings.

Parameters

[in]	theSamplings	vector of sampling enumerators
[out]	theCalos	vector of calo enumerators

Definition at line 127 of file CaloUtils/src/CaloSamplingHelper.cxx.

                                                                                                                                {
  const size_t oldSize = theCalos.size();
  for (auto fSample : theSamplings) {
    CaloCell_ID::SUBCALO theCaloId = CaloCell_ID::NOT_VALID;
    switch (fSample) {
      case PreSamplerB:
      case EMB1:
      case EMB2:
      case EMB3:
      case PreSamplerE:
      case EME1:
      case EME2:
      case EME3:
        theCaloId = CaloCell_ID::LAREM;
        break;
      case HEC0:
      case HEC1:
      case HEC2:
      case HEC3:
        theCaloId = CaloCell_ID::LARHEC;
        break;
      case FCAL0:
      case FCAL1:
      case FCAL2:
        theCaloId = CaloCell_ID::LARFCAL;
        break;
      case TileBar0:
      case TileBar1:
      case TileBar2:
      case TileGap1:
      case TileGap2:
      case TileGap3:
      case TileExt0:
      case TileExt1:
      case TileExt2:
        theCaloId = CaloCell_ID::TILE;
        break;
      case MINIFCAL0:
      case MINIFCAL1:
      case MINIFCAL2:
      case MINIFCAL3:
        theCaloId = CaloCell_ID::LARMINIFCAL;
        break;
      default:
        break;
    }
    // check if not there yet (actually a std::set would be better than a
    // vector)
    if (std::find(theCalos.begin(), theCalos.end(), theCaloId) ==  theCalos.end()) {
      theCalos.push_back(theCaloId);
    }
  }
  return theCalos.size() > oldSize;
}

◆ getNumberOfSamplings() [1/2]

unsigned int CaloSampling::getNumberOfSamplings ( )

inlinestaticconstexprinherited

Get number of available samplings.

Definition at line 30 of file Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h.

   {
     return static_cast<unsigned int>(Unknown);
   }

◆ getNumberOfSamplings() [2/2]

unsigned int CaloSampling::getNumberOfSamplings ( )

staticinherited

Get number of available samplings.

◆ getSampling() [1/2]

CaloSampling::CaloSample CaloSampling::getSampling ( const std::string & name )

staticinherited

Return the sampling code for a given name.

Parameters

[in] name The name to translate.

Returns Unknown if the name is not known.

Definition at line 32 of file Calorimeter/CaloGeoHelpers/Root/CaloSampling.cxx.

{
  for (int samp = 0; samp != static_cast<int>(Unknown); ++samp) {
    if (sample_names[samp] == name) {
      return static_cast<CaloSample> (samp);
    }
  }
  return Unknown;
}

◆ getSampling() [2/2]

CaloSamplingHelper::CaloSample CaloSamplingHelper::getSampling ( const CaloCell & c )

static

Retrieves the sampling indicator for a cell.

Parameters

c	reference to a non-modifiable CaloCell

Returns CaloSampling::Unknown if sampling cannot be found.

Definition at line 39 of file CaloEvent/src/CaloSamplingHelper.cxx.

                                                      {
 
  const CaloDetDescrElement * theCaloDDE= cell.caloDDE() ;
  if (theCaloDDE!=nullptr) {
    return (CaloSamplingHelper::CaloSample) theCaloDDE->getSampling();
      }
  else{
    return Unknown;
    
  }
}

◆ getSamplingBit() [1/2]

unsigned int CaloSamplingHelper::getSamplingBit ( const CaloCell & rCell )

static

Return a unique bit set for a given sampling.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

rCell const reference to a CaloCell object

Returns 0 if cell has CaloSampling::Unknown indicator.

Definition at line 51 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return getSamplingBit(getSampling(rCell));
}

◆ getSamplingBit() [2/2]

unsigned int CaloSamplingHelper::getSamplingBit ( const CaloSample & rSample )

inlinestatic

Return a unique bit set for a given sampling.

Parameters

rSample reference to a non-modifiable sampling indicator

Returns 0 for CaloSampling::Unknown .

Definition at line 48 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

                                                                 {
      return CaloSampling::getSamplingPattern(rSample);
   }

◆ getSamplingId()

CaloSampling::CaloSample CaloSamplingHelper::getSamplingId ( const std::string & samplingName )

static

Returns the CaloSampling::CaloSample enumerator value.

Parameters

[in] samplingName string with sampling name

Definition at line 63 of file CaloUtils/src/CaloSamplingHelper.cxx.

{
  return m_lookUp.find(name) != m_lookUp.end()
    ? (*m_lookUp.find(name)).second
    : CaloSampling::Unknown;
}

◆ getSamplingName() [1/2]

std::string CaloSampling::getSamplingName ( unsigned int theSample )

staticinherited

Returns a string (name) for each CaloSampling.

Parameters

[in] theSample CaloSampling::CaloSample enumerator value

Definition at line 24 of file Calorimeter/CaloGeoHelpers/Root/CaloSampling.cxx.

{
  if (theSample >= getNumberOfSamplings())
    return "";
  return sample_names[theSample];
}

◆ getSamplingName() [2/2]

const std::string & CaloSamplingHelper::getSamplingName ( const CaloSampling::CaloSample theSample )

static

Returns a string (name) for each CaloSampling.

Parameters

[in] theSample CaloSampling::CaloSample enumerator value

Definition at line 44 of file CaloUtils/src/CaloSamplingHelper.cxx.

                                                                                           {
  //Linear search for the value in the std::map m_lookUp. 
  //Slow, but acceptable because: 
  //  1. The map has only 28 entries 
  //  2. It's and integer-comparision 
  //  3. The method is only use for log-output (eg not too often)
 
  //Implementation uses a C++11 lambda function
  //[&theSample] defines the lambda function and says that it depends on the external variable theSampling (captured by reference)
  //(std::pair<std::string,CaloSample> i) is the parameter of the function
  //{return (i.second==theSample);} Is the code of the function
  auto it=std::find_if(m_lookUp.begin(),m_lookUp.end(),[&theSample](const std::pair<std::string,CaloSampling::CaloSample>& i) {return (i.second==theSample);});
  if (it==m_lookUp.end())
    return m_unknown;
  else
    return it->first;
}

◆ getSamplingPattern() [1/2]

unsigned int CaloSampling::getSamplingPattern ( const CaloSample s )

inlinestaticinherited

Get a unsigned with one bit set.

Definition at line 36 of file Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h.

                                                              {
     return (0x1U << s);
   }

◆ getSamplingPattern() [2/2]

unsigned int CaloSampling::getSamplingPattern ( const CaloSample s )

inlinestaticinherited

Get a unsigned with one bit set.

Definition at line 33 of file Simulation/ISF/ISF_FastCaloSim/ISF_FastCaloSimParametrization/tools/CaloGeoHelpers/CaloSampling.h.

                                                              {
     return (0x1U << s);
   }

◆ getSamplings() [1/2]

bool CaloSamplingHelper::getSamplings	(	const CaloCell_ID::SUBCALO &	theCalo,
		std::vector< CaloSampling::CaloSample > &	theSamplings )

static

Returns a list of samplings enumerators for a list of sub-calos This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

[in] theCalo calo enumerator

Definition at line 122 of file CaloUtils/src/CaloSamplingHelper.cxx.

                                                                                                                         {
  const std::vector<CaloCell_ID::SUBCALO> caloVector = {theCalo};
  return getSamplings(caloVector, theSamplings);
}

◆ getSamplings() [2/2]

bool CaloSamplingHelper::getSamplings	(	const std::vector< CaloCell_ID::SUBCALO > &	theCalos,
		std::vector< CaloSampling::CaloSample > &	theSamplings )

static

Returns a list of samplings enumerators for a list of sub-calos.

Parameters

[in]	theCalos	vector of calo enumerators
[out]	theSamplings	vector of sampling enumerators

Definition at line 70 of file CaloUtils/src/CaloSamplingHelper.cxx.

                                                     {
 
  const size_t oldSize = theSamplings.size();
  for (auto fCalo : theCalos) {
    switch (fCalo) {
      case CaloCell_ID::LAREM:
        theSamplings.push_back(PreSamplerB);
        theSamplings.push_back(EMB1);
        theSamplings.push_back(EMB2);
        theSamplings.push_back(EMB3);
        theSamplings.push_back(PreSamplerE);
        theSamplings.push_back(EME1);
        theSamplings.push_back(EME2);
        theSamplings.push_back(EME3);
        break;
      case CaloCell_ID::LARHEC:
        theSamplings.push_back(HEC0);
        theSamplings.push_back(HEC1);
        theSamplings.push_back(HEC2);
        theSamplings.push_back(HEC3);
        break;
      case CaloCell_ID::LARFCAL:
        theSamplings.push_back(FCAL0);
        theSamplings.push_back(FCAL1);
        theSamplings.push_back(FCAL2);
        break;
      case CaloCell_ID::TILE:
        theSamplings.push_back(TileBar0);
        theSamplings.push_back(TileBar1);
        theSamplings.push_back(TileBar2);
        theSamplings.push_back(TileExt0);
        theSamplings.push_back(TileExt1);
        theSamplings.push_back(TileExt2);
        theSamplings.push_back(TileGap1);
        theSamplings.push_back(TileGap2);
        theSamplings.push_back(TileGap3);
        break;
      case CaloCell_ID::LARMINIFCAL:
        theSamplings.push_back(MINIFCAL0);
        theSamplings.push_back(MINIFCAL1);
        theSamplings.push_back(MINIFCAL2);
        theSamplings.push_back(MINIFCAL3);
        break;
      default:
        break;
    }
  }
  return oldSize < theSamplings.size();
}

◆ isBarrelSampling()

bool CaloSamplingHelper::isBarrelSampling ( const CaloSample & rSample )

static

Definition at line 67 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_BarrelMask);
}

◆ isEMSampling()

bool CaloSamplingHelper::isEMSampling ( const CaloSample & rSample )

static

Get sampling characteristics.

Definition at line 57 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_EMMask);
}

◆ isEndCapSampling()

bool CaloSamplingHelper::isEndCapSampling ( const CaloSample & rSample )

static

Definition at line 72 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_EndCapMask);
}

◆ isHADSampling()

bool CaloSamplingHelper::isHADSampling ( const CaloSample & rSample )

static

Definition at line 62 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_HADMask);
}

◆ isLArSampling()

bool CaloSamplingHelper::isLArSampling ( const CaloSample & rSample )

static

Definition at line 77 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_LArMask);
}

◆ isTileSampling()

bool CaloSamplingHelper::isTileSampling ( const CaloSample & rSample )

static

Definition at line 82 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  return matchPattern(rSample,m_TileMask);
}

◆ matchPattern()

bool CaloSamplingHelper::matchPattern	(	const CaloSample &	rSample,
		const unsigned int &	mask )

staticprivate

Definition at line 87 of file CaloEvent/src/CaloSamplingHelper.cxx.

{
  unsigned int bitPattern = getSamplingBit(rSample);
  return ( bitPattern & mask ) == bitPattern;
}

◆ operator=()

CaloSamplingHelper & CaloSamplingHelper::operator= ( const CaloSamplingHelper & rhs )

delete

Member Data Documentation

◆ m_BarrelMask

const unsigned int CaloSamplingHelper::m_BarrelMask = 0x001ff00f

staticprivate

Definition at line 79 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_EMMask

const unsigned int CaloSamplingHelper::m_EMMask = 0x000000ff

staticprivate

Definition at line 77 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_EndCapMask

const unsigned int CaloSamplingHelper::m_EndCapMask = 0x00e00ff0

staticprivate

Definition at line 80 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_HADMask

const unsigned int CaloSamplingHelper::m_HADMask = 0x00ffff00

staticprivate

Definition at line 78 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_LArMask

const unsigned int CaloSamplingHelper::m_LArMask = 0x00e00fff

staticprivate

Definition at line 81 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_lookUp

const std::map< std::string, CaloSampling::CaloSample > CaloSamplingHelper::m_lookUp

staticprivate

Initial value:

{
  {"PreSamplerB",  PreSamplerB},
  {"EMB1",         EMB1},
  {"EMB2",         EMB2},
  {"EMB3",         EMB3},
  {"PreSamplerE",  PreSamplerE},
  {"EME1",         EME1},
  {"EME2",         EME2},
  {"EME3",         EME3},
  {"HEC0",         HEC0},
  {"HEC1",         HEC1},
  {"HEC2",         HEC2},
  {"HEC3",         HEC3},
  {"TileBar0",     TileBar0},
  {"TileBar1",     TileBar1},
  {"TileBar2",     TileBar2},
  {"TileGap1",     TileGap1},
  {"TileGap2",     TileGap2},
  {"TileGap3",     TileGap3},
  {"TileExt0",     TileExt0},
  {"TileExt1",     TileExt1},
  {"TileExt2",     TileExt2},
  {"FCal1",        FCAL0},
  {"FCal2",        FCAL1},
  {"FCal3",        FCAL2},
  {"MiniFCal0",    MINIFCAL0},
  {"MiniFCal1",    MINIFCAL1},
  {"MiniFCal2",    MINIFCAL2},
  {"MiniFCal3",    MINIFCAL3}
}

Definition at line 11 of file CaloUtils/CaloUtils/CaloSamplingHelper.h.

                          {
 
public:
  static const std::string& getSamplingName(const CaloSampling::CaloSample theSample);
  static CaloSampling::CaloSample getSamplingId(const std::string& samplingName);
  static bool getSamplings(const std::vector<CaloCell_ID::SUBCALO>& theCalos,
               std::vector<CaloSampling::CaloSample>& theSamplings);
   

◆ m_TileMask

const unsigned int CaloSamplingHelper::m_TileMask = 0x001ff000

staticprivate

Definition at line 82 of file CaloEvent/CaloEvent/CaloSamplingHelper.h.

◆ m_unknown

const std::string CaloSamplingHelper::m_unknown ="Unknown"

staticprivate

Definition at line 56 of file CaloUtils/CaloUtils/CaloSamplingHelper.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CaloSample [1/2]

◆ CaloSample [2/2]

Constructor & Destructor Documentation

◆ CaloSamplingHelper() [1/2]

◆ ~CaloSamplingHelper()

◆ CaloSamplingHelper() [2/2]

Member Function Documentation

◆ barrelPattern() [1/2]

◆ barrelPattern() [2/2]

◆ endcapPattern() [1/2]

◆ endcapPattern() [2/2]

◆ getCalos()

◆ getNumberOfSamplings() [1/2]

◆ getNumberOfSamplings() [2/2]

◆ getSampling() [1/2]

◆ getSampling() [2/2]

◆ getSamplingBit() [1/2]

◆ getSamplingBit() [2/2]

◆ getSamplingId()

◆ getSamplingName() [1/2]

◆ getSamplingName() [2/2]

◆ getSamplingPattern() [1/2]

◆ getSamplingPattern() [2/2]

◆ getSamplings() [1/2]

◆ getSamplings() [2/2]

◆ isBarrelSampling()

◆ isEMSampling()

◆ isEndCapSampling()

◆ isHADSampling()

◆ isLArSampling()

◆ isTileSampling()

◆ matchPattern()

◆ operator=()

Member Data Documentation

◆ m_BarrelMask

◆ m_EMMask

◆ m_EndCapMask

◆ m_HADMask

◆ m_LArMask

◆ m_lookUp

◆ m_TileMask

◆ m_unknown