---

reco::CaloID Class Reference

ID information for all calorimeters. More...

#include <DataFormats/CaloRecHit/interface/CaloID.h>

List of all members.

Public Types
enum	Detectors {   DET_ECAL_BARREL = 0, DET_ECAL_ENDCAP, DET_PS1, DET_PS2,   DET_HCAL_BARREL, DET_HCAL_ENDCAP, DET_HF, DET_HO,   DET_NONE }
Public Member Functions
	CaloID (Detectors det)
	CaloID ()
	default constructor. Sets energy and position to zero
Detectors	detector () const
	Returns: the described detector if isSingleDetector(), and DET_NONE otherwise.
bool	detector (CaloID::Detectors theDetector) const
	Returns: true if this CaloID is in a given detector
unsigned	detectors () const
	Returns: packed detector information
bool	isSingleDetector () const
	Returns: true if this CaloID describes a single detector
CaloID &	operator= (const CaloID &rhs)
void	setDetector (CaloID::Detectors theDetector, bool value)
	tells the CaloID that it describes a given detector
virtual	~CaloID ()
	abstract class
Private Member Functions
int	leastSignificantBitPosition (unsigned n) const
	Returns: lsb position in an integer
Private Attributes
unsigned	detectors_
	packs the detector information into a bitmask.
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

enum reco::CaloID::Detectors

Enumerator:

DET_ECAL_BARREL
DET_ECAL_ENDCAP
DET_PS1
DET_PS2
DET_HCAL_BARREL
DET_HCAL_ENDCAP
DET_HF
DET_HO
DET_NONE

Definition at line 21 of file CaloID.h.

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

---

Constructor & Destructor Documentation

reco::CaloID::CaloID

(

)

[inline]

default constructor. Sets energy and position to zero

Definition at line 34 of file CaloID.h.

: detectors_(0) {}

reco::CaloID::CaloID

(

Detectors

det

)

[inline]

Definition at line 36 of file CaloID.h.

References setDetector().

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

virtual reco::CaloID::~CaloID

(

)

[inline, virtual]

abstract class

Definition at line 39 of file CaloID.h.

{}

---

Member Function Documentation

CaloID::Detectors CaloID::detector

(

)

const

Returns:

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

Definition at line 26 of file CaloID.cc.

References DET_NONE, detectors_, isSingleDetector(), and leastSignificantBitPosition().

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

bool CaloID::detector

(

CaloID::Detectors

theDetector

)

const

Returns:

true if this CaloID is in a given detector

Definition at line 20 of file CaloID.cc.

References detectors_.

                                                 {

  return (detectors_>>theDetector) & 1;
}

unsigned reco::CaloID::detectors

(

)

const [inline]

Returns:

packed detector information

Definition at line 45 of file CaloID.h.

References detectors_.

{return detectors_;}

bool reco::CaloID::isSingleDetector

(

)

const [inline]

Returns:

true if this CaloID describes a single detector

Definition at line 51 of file CaloID.h.

References detectors_.

Referenced by detector().

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

int CaloID::leastSignificantBitPosition

(

unsigned

n

)

const [private]

Returns:

lsb position in an integer

Definition at line 38 of file CaloID.cc.

Referenced by detector().

                                                        {
    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;
}

CaloID& reco::CaloID::operator=

(

const CaloID &

rhs

)

[inline]

Definition at line 60 of file CaloID.h.

References detectors_.

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

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.

References detectors_.

Referenced by CaloID().

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

  // cout<<detectors_<<endl;
}

---

Friends And Related Function Documentation

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

Definition at line 53 of file CaloID.cc.

                                                 {
  if(!out) return out;

  out<<"CaloID: "<<id.detectors();
  return out;
}

---

Member Data Documentation

unsigned reco::CaloID::detectors_ [private]

packs the detector information into a bitmask.

a CaloID can describe several detectors (bit or)

Definition at line 75 of file CaloID.h.

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

---

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

• DataFormats/CaloRecHit/interface/CaloID.h
• DataFormats/CaloRecHit/src/CaloID.cc

---