reco::CaloID Class Reference

#include <CaloID.h>

Public Types
enum	Detectors {   DET_ECAL_BARREL = 0, DET_ECAL_ENDCAP, DET_PS1, DET_PS2,   DET_HCAL_BARREL, DET_HCAL_ENDCAP, DET_HF, DET_HF_EM,   DET_HF_HAD, DET_HO, DET_HGCAL_ENDCAP, DET_NONE }

Public Member Functions
	CaloID ()
	default constructor. Sets energy and position to zero More...
	CaloID (Detectors det)
Detectors	detector () const
bool	detector (CaloID::Detectors theDetector) const
unsigned	detectors () const
bool	isSingleDetector () const
CaloID &	operator= (const CaloID &rhs)
void	setDetector (CaloID::Detectors theDetector, bool value)
	tells the CaloID that it describes a given detector More...
virtual	~CaloID ()
	abstract class More...

Private Member Functions
int	leastSignificantBitPosition (unsigned n) const

Private Attributes
unsigned	detectors_

Friends
std::ostream &	operator<< (std::ostream &out, const CaloID &id)

Detailed Description

ID information for all calorimeters.

Author

Colin Bernet, LLR

Definition at line 17 of file CaloID.h.

Member Enumeration Documentation

Detectors

enum reco::CaloID::Detectors

Enumerator
DET_ECAL_BARREL
DET_ECAL_ENDCAP
DET_PS1
DET_PS2
DET_HCAL_BARREL
DET_HCAL_ENDCAP
DET_HF
DET_HF_EM
DET_HF_HAD
DET_HO
DET_HGCAL_ENDCAP
DET_NONE

Definition at line 19 of file CaloID.h.

                   {
      DET_ECAL_BARREL = 0,
      DET_ECAL_ENDCAP,
      DET_PS1,
      DET_PS2,
      DET_HCAL_BARREL,
      DET_HCAL_ENDCAP,
      DET_HF,
      DET_HF_EM,
      DET_HF_HAD,
      DET_HO,
      DET_HGCAL_ENDCAP,
      DET_NONE
    };

Constructor & Destructor Documentation

CaloID() [1/2]

reco::CaloID::CaloID ( )

inline

default constructor. Sets energy and position to zero

Definition at line 35 of file CaloID.h.

: detectors_(0) {}

CaloID() [2/2]

reco::CaloID::CaloID ( Detectors  det )

inline

Definition at line 37 of file CaloID.h.

: detectors_(0) { setDetector(det, true); }

References setDetector().

~CaloID()

virtual reco::CaloID::~CaloID ( )

inlinevirtual

abstract class

Definition at line 40 of file CaloID.h.

{}

Member Function Documentation

detector() [1/2]

CaloID::Detectors CaloID::detector

(

)

const

Returns

the described detector if isSingleDetector(), and DET_NONE otherwise.

Definition at line 19 of file CaloID.cc.

                                       {
  if (!isSingleDetector())
    return DET_NONE;
 
  int pos = leastSignificantBitPosition(detectors_);
 
  CaloID::Detectors det = static_cast<CaloID::Detectors>(pos);
 
  return det;
}

detector() [2/2]

bool CaloID::detector

(

CaloID::Detectors

theDetector

)

const

Returns

true if this CaloID is in a given detector

Definition at line 17 of file CaloID.cc.

{ return (detectors_ >> theDetector) & 1; }

detectors()

unsigned reco::CaloID::detectors ( ) const

inline

Returns

packed detector information

Definition at line 46 of file CaloID.h.

{ return detectors_; }

References detectors_.

isSingleDetector()

bool reco::CaloID::isSingleDetector ( ) const

inline

Returns

true if this CaloID describes a single detector

Definition at line 52 of file CaloID.h.

                                  {
      // check that detectors_ is a power of 2
      return static_cast<bool>(detectors_ && !((detectors_ - 1) & detectors_));
    }

References detectors_.

leastSignificantBitPosition()

int CaloID::leastSignificantBitPosition ( unsigned  n ) const

private

Returns

lsb position in an integer

Definition at line 30 of file CaloID.cc.

                                                        {
  if (n == 0)
    return -1;
 
  int pos = 31;
 
  if (n & 0x000000000000FFFFLL) {
    pos -= 16;
  } else {
    n >>= 16;
  }
  if (n & 0x00000000000000FFLL) {
    pos -= 8;
  } else {
    n >>= 8;
  }
  if (n & 0x000000000000000FLL) {
    pos -= 4;
  } else {
    n >>= 4;
  }
  if (n & 0x0000000000000003LL) {
    pos -= 2;
  } else {
    n >>= 2;
  }
  if (n & 0x0000000000000001LL) {
    pos -= 1;
  }
  return pos;
}

References dqmiodumpmetadata::n.

operator=()

CaloID& reco::CaloID::operator= ( const CaloID &  rhs )

inline

Definition at line 61 of file CaloID.h.

                                         {
      detectors_ = rhs.detectors_;
      return *this;
    }

References detectors_.

setDetector()

void CaloID::setDetector	(	CaloID::Detectors	theDetector,
		bool	value
	)

tells the CaloID that it describes a given detector

Definition at line 7 of file CaloID.cc.

                                                          {
  //  cout<<"CaloID::setDetector "<<theDetector<<" "<<(1<<theDetector)<<endl;
  if (value)
    detectors_ = detectors_ | (1 << theDetector);
  else
    detectors_ = detectors_ ^ (1 << theDetector);
 
  // cout<<detectors_<<endl;
}

Referenced by CaloID().

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const CaloID &  id  )

friend

Member Data Documentation

detectors_

unsigned reco::CaloID::detectors_

private

packs the detector information into a bitmask. a CaloID can describe several detectors (bit or)

Definition at line 74 of file CaloID.h.

Referenced by detectors(), isSingleDetector(), and operator=().