xAOD::CaloClusterDetails Namespace Reference

Typedefs
using	CaloSample = CaloSampling::CaloSample

Functions
bool	hasSampling (const CaloSample s, const std::uint32_t samplingPattern)
	Checks if certain smapling contributes to cluster. More...
unsigned	sampVarIdx (const CaloSample s, const std::uint32_t samplingPattern)
float	getSamplVar (const CaloSample sampling, const std::uint32_t samplingPattern, const std::span< const float > vec, const float errorvalue=defaultErrorValue)
float	energyBE (const unsigned sample, const std::uint32_t samplingPattern, const std::span< const float > e_sampl)
	Get the energy in one layer of the EM Calo. More...
float	etaBE (const unsigned sample, const std::uint32_t samplingPattern, const std::span< const float > e_sampl, const std::span< const float > eta_sampl)
	Get the eta in one layer of the EM Calo. More...

Variables
constexpr float	defaultErrorValue = -999
	the default error code to return in case of error More...

Typedef Documentation

CaloSample

using xAOD::CaloClusterDetails::CaloSample = typedef CaloSampling::CaloSample

Definition at line 39 of file CaloClusterDetails.h.

Function Documentation

energyBE()

float xAOD::CaloClusterDetails::energyBE ( const unsigned  sample, const std::uint32_t  samplingPattern, const std::span< const float >  e_sampl  )

inline

Get the energy in one layer of the EM Calo.

Parameters

layer

Layer between 0 (Presampler) and 3 (Back)

Returns

energy Works for both, barrel and endcap

Definition at line 86 of file CaloClusterDetails.h.

                                                                                                                                      {
      if (sample>3) return defaultErrorValue;
      const CaloSample barrelSample=(CaloSample)(CaloSampling::PreSamplerB+sample);
      const CaloSample endcapSample=(CaloSample)(CaloSampling::PreSamplerE+sample);
      double energy=0;
      if (hasSampling(barrelSample, samplingPattern)) {
        energy+=getSamplVar(barrelSample,samplingPattern,e_sampl); //Check for errorcode? Should not happen...
      }
      if (hasSampling(endcapSample, samplingPattern)) {
        energy+=getSamplVar(endcapSample,samplingPattern,e_sampl);
      }
      return energy;
    }

etaBE()

float xAOD::CaloClusterDetails::etaBE ( const unsigned  sample, const std::uint32_t  samplingPattern, const std::span< const float >  e_sampl, const std::span< const float >  eta_sampl  )

inline

Get the eta in one layer of the EM Calo.

Parameters

layer

Layer between 0 (Presampler) and 3 (Back)

Returns

energy Works for both, barrel and endcap

Definition at line 106 of file CaloClusterDetails.h.

                                                                                                                                                                         {
      if (sample>3) {return defaultErrorValue;}
      const CaloSample barrelSample=(CaloSample)(CaloSampling::PreSamplerB+sample);
      const CaloSample endcapSample=(CaloSample)(CaloSampling::PreSamplerE+sample);
      const bool haveBarrel=hasSampling(barrelSample, samplingPattern);
      const bool haveEndcap=hasSampling(endcapSample, samplingPattern);
      if (haveBarrel && haveEndcap) {
        //cluster spans barren and endcap
        float eBarrel=getSamplVar(barrelSample,samplingPattern,e_sampl);  //Check for errorcode? Should not happen...
        float eEndcap=getSamplVar(endcapSample,samplingPattern,e_sampl);
 
        float etaBarrel=getSamplVar(barrelSample,samplingPattern,eta_sampl);
        float etaEndcap=getSamplVar(endcapSample,samplingPattern,eta_sampl);
        float eSum=eBarrel + eEndcap;
        if (eSum > 100 /*MeV*/) {
          //E-weighted average ...
          if ((eBarrel > 0 && eEndcap > 0) || (eBarrel < 0 && eEndcap < 0))
            return (eBarrel * etaBarrel + eEndcap * etaEndcap) / eSum;
          else if (eBarrel > 0)
            return etaBarrel;
          else
            return etaEndcap;
         }//else eSum==0 case, should never happen
         return (0.5 * (etaBarrel + etaEndcap));
      }
      if (haveBarrel) {
        return getSamplVar(barrelSample,samplingPattern,eta_sampl);
      }
      if (haveEndcap) {
        return getSamplVar(endcapSample,samplingPattern,eta_sampl);
      }
  
      //Should never reach this point ...
      return defaultErrorValue;
    }

getSamplVar()

float xAOD::CaloClusterDetails::getSamplVar ( const CaloSample  sampling, const std::uint32_t  samplingPattern, const std::span< const float >  vec, const float  errorvalue = defaultErrorValue  )

inline

Definition at line 71 of file CaloClusterDetails.h.

                                                                                                                                                                                   {
      const unsigned idx=sampVarIdx(sampling, samplingPattern);
      if (idx<vec.size() ) {
        return vec[idx];
      }
  
        //std::cout <<Sampling " << sampling << ", Pattern=" << std::hex <<m_samplingPattern << std::dec << ", index=" << idx << " size=" << vec.size() << std::endl;
      return errorvalue;
    }

hasSampling()

bool xAOD::CaloClusterDetails::hasSampling ( const CaloSample  s, const std::uint32_t  samplingPattern  )

inline

Checks if certain smapling contributes to cluster.

Definition at line 51 of file CaloClusterDetails.h.

                                                                                                 {
      return (samplingPattern & (0x1U<<(std::uint32_t)s));
    }

sampVarIdx()

unsigned xAOD::CaloClusterDetails::sampVarIdx ( const CaloSample  s, const std::uint32_t  samplingPattern  )

inline

Definition at line 56 of file CaloClusterDetails.h.

                                                                                                    {
      //std::cout << "Pattern=" << std::hex << pattern << std::dec << ", Sampling=" << s << std::endl;
      if ((samplingPattern & (0x1U << s)) == 0) {
        return CaloSampling::Unknown;
      }
      if (s == 0) {
        return 0;
      } // shifting a 32-bit int by 32 bits is undefined behavior!
      return std::popcount(samplingPattern << (32 - s));
      // Explanation: Need to get the number of bit (=samples) before the sampling in question
      // Shift to the left, so bits after the sampling in question fall off the 32bit integer
      // Then use  popcount to count the numbers of 1 in the rest
    }

Variable Documentation

defaultErrorValue

constexpr float xAOD::CaloClusterDetails::defaultErrorValue = -999

constexpr

the default error code to return in case of error

FIXME: This value is currently taken from the xAOD::CaloCluster class, and should be changed to a more sensible value in the future.

Definition at line 47 of file CaloClusterDetails.h.