ME0DetId Class Reference

#include <ME0DetId.h>

Inheritance diagram for ME0DetId:

Public Member Functions
int	chamber () const
	Chamber id: it identifies a chamber in a ring it goes from 1 to 36. More...
ME0DetId	chamberId () const
	Return the corresponding ChamberId (mask layers) More...
int	layer () const
	Layer id: each chamber has six layers of chambers: layer 1 is the inner layer and layer 6 is the outer layer. More...
ME0DetId	layerId () const
	Return the corresponding LayerId (mask eta partition) More...
	ME0DetId ()
	ME0DetId (uint32_t id)
	ME0DetId (DetId id)
	ME0DetId (int region, int layer, int chamber, int roll)
	Construct from fully qualified identifier. More...
int	nlayers () const
	For future modifications (implement more layers) More...
bool	operator< (const ME0DetId &r) const
	Sort Operator based on the raw detector id. More...
int	region () const
	Region id: 0 for Barrel Not in use, +/-1 For +/- Endcap. More...
int	roll () const
int	station () const
Public Member Functions inherited from DetId
Detector	det () const
	get the detector field from this detid More...
	DetId ()
	Create an empty or null id (also for persistence) More...
	DetId (uint32_t id)
	Create an id from a raw number. More...
	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
bool	null () const
	is this a null id ? More...
	operator uint32_t () const
bool	operator!= (DetId id) const
	inequality More...
uint32_t	operator() () const
bool	operator< (DetId id) const
	comparison More...
bool	operator== (DetId id) const
	equality More...
uint32_t	rawId () const
	get the raw id More...
int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Attributes
static const int	maxChamberId = 18
static const int	maxLayerId = 6
static const int	maxRegionId = 1
static const int	maxRollId = 1
static const int	minChamberId = 0
static const int	minLayerId = 0
static const int	minRegionId = -1
static const int	minRollId = 0
Static Public Attributes inherited from DetId
static const int	kDetOffset = 28
static const int	kSubdetOffset = 25

Private Member Functions
void	init (int region, int layer, int chamber, int roll)

Private Attributes
int	trind

Static Private Attributes
static const uint32_t	chamberIdMask_ = ~( (LayerMask_<<LayerStartBit_) | (RollMask_<<RollStartBit_))
static const unsigned int	ChamberMask_ = 0X3F
static const int	ChamberNumBits_ = 6
static const int	ChamberStartBit_ = RegionStartBit_+RegionNumBits_
static const uint32_t	layerIdMask_ = ~(RollMask_<<RollStartBit_)
static const unsigned int	LayerMask_ = 0X1F
static const int	LayerNumBits_ = 5
static const int	LayerStartBit_ = ChamberStartBit_+ChamberNumBits_
static const int	RegionMask_ = 0X3
static const int	RegionNumBits_ = 2
static const int	RegionStartBit_ = 0
static const unsigned int	RollMask_ = 0X1F
static const int	RollNumBits_ = 5
static const int	RollStartBit_ = LayerStartBit_+LayerNumBits_

Additional Inherited Members
Public Types inherited from DetId
enum	Detector {   Tracker =1, Muon =2, Ecal =3, Hcal =4,   Calo =5, Forward =6, VeryForward =7 }
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

DetUnit identifier for ME0s

Definition at line 16 of file ME0DetId.h.

Constructor & Destructor Documentation

ME0DetId::ME0DetId

(

)

Definition at line 8 of file ME0DetId.cc.

Referenced by chamberId(), and layerId().

:DetId(DetId::Muon, MuonSubdetId::ME0){}

ME0DetId::ME0DetId

(

uint32_t

id

)

Construct from a packed id. It is required that the Detector part of id is Muon and the SubDet part is ME0, otherwise an exception is thrown.

Definition at line 11 of file ME0DetId.cc.

References DetId::det(), Exception, MuonSubdetId::ME0, DetId::Muon, and DetId::subdetId().

                             :DetId(id){
  if (det()!=DetId::Muon || subdetId()!=MuonSubdetId::ME0) {
    throw cms::Exception("InvalidDetId") << "ME0DetId ctor:"
                     << " det: " << det()
                     << " subdet: " << subdetId()
                     << " is not a valid ME0 id";  
  }
}

ME0DetId::ME0DetId

(

DetId

id

)

Definition at line 20 of file ME0DetId.cc.

References DetId::det(), Exception, MuonSubdetId::ME0, DetId::Muon, and DetId::subdetId().

                          :DetId(id) {
  if (det()!=DetId::Muon || subdetId()!=MuonSubdetId::ME0) {
    throw cms::Exception("InvalidDetId") << "ME0DetId ctor:"
                     << " det: " << det()
                     << " subdet: " << subdetId()
                     << " is not a valid ME0 id";  
  }
}

ME0DetId::ME0DetId	(	int	region,
		int	layer,
		int	chamber,
		int	roll
	)

Construct from fully qualified identifier.

Definition at line 29 of file ME0DetId.cc.

References init().

                                                             :        
  DetId(DetId::Muon, MuonSubdetId::ME0)
{
  this->init(region,layer,chamber,roll);
}

Member Function Documentation

int ME0DetId::chamber ( ) const

inline

Chamber id: it identifies a chamber in a ring it goes from 1 to 36.

Definition at line 51 of file ME0DetId.h.

References ChamberMask_, ChamberStartBit_, DetId::id_, and minChamberId.

Referenced by ME0SegmentBuilder::build().

                     {
    return int((id_>>ChamberStartBit_) & ChamberMask_) + minChamberId;
  }

ME0DetId ME0DetId::chamberId ( ) const

inline

Return the corresponding ChamberId (mask layers)

Definition at line 67 of file ME0DetId.h.

References chamberIdMask_, DetId::id_, and ME0DetId().

                             {
    return ME0DetId(id_ & chamberIdMask_);
  }

void ME0DetId::init ( int  region, int  layer, int  chamber, int  roll  )

private

Definition at line 36 of file ME0DetId.cc.

References ChamberMask_, ChamberStartBit_, Exception, DetId::id_, LayerMask_, LayerStartBit_, maxChamberId, maxLayerId, maxRegionId, maxRollId, minChamberId, minLayerId, minRegionId, minRollId, RegionMask_, RegionStartBit_, RollMask_, and RollStartBit_.

Referenced by ME0DetId().

{
  if ( region     < minRegionId    || region    > maxRegionId ||
       layer      < minLayerId     || layer     > maxLayerId ||
       chamber    < minChamberId   || chamber   > maxChamberId ||
       roll       < minRollId      || roll      > maxRollId) {
    throw cms::Exception("InvalidDetId") << "ME0DetId ctor:" 
                     << " Invalid parameters: " 
                     << " region "<<region
                     << " layer "<<layer
                     << " chamber "<<chamber
                     << " etaPartition "<<roll
                     << std::endl;
  }
  int regionInBits=region-minRegionId;
  int layerInBits=layer-minLayerId;
  int chamberInBits=chamber-minChamberId;
  int rollInBits=roll-minRollId;
  
  id_ |= ( regionInBits    & RegionMask_)    << RegionStartBit_    | 
         ( layerInBits     & LayerMask_)     << LayerStartBit_     |
         ( chamberInBits   & ChamberMask_)    << ChamberStartBit_  |
         ( rollInBits      & RollMask_)      << RollStartBit_        ;
   
}

int ME0DetId::layer ( ) const

inline

Layer id: each chamber has six layers of chambers: layer 1 is the inner layer and layer 6 is the outer layer.

Definition at line 56 of file ME0DetId.h.

References DetId::id_, LayerMask_, LayerStartBit_, and minLayerId.

Referenced by operator<().

                   {
    return int((id_>>LayerStartBit_) & LayerMask_) + minLayerId;
  }

ME0DetId ME0DetId::layerId ( ) const

inline

Return the corresponding LayerId (mask eta partition)

Definition at line 71 of file ME0DetId.h.

References DetId::id_, layerIdMask_, and ME0DetId().

                           {
    return ME0DetId(id_ & layerIdMask_);
  }

int ME0DetId::nlayers ( ) const

inline

For future modifications (implement more layers)

Definition at line 82 of file ME0DetId.h.

References maxLayerId.

                     {
    return int(maxLayerId);
  }

bool ME0DetId::operator< ( const ME0DetId &  r ) const

inline

Sort Operator based on the raw detector id.

Definition at line 36 of file ME0DetId.h.

References layer(), and DetId::rawId().

                                           {
    if (this->layer() ==  r.layer()  ){
      return this->rawId()<r.rawId();
    }
    else{
      return (this->layer() >  r.layer());
    }
  }

int ME0DetId::region ( ) const

inline

Region id: 0 for Barrel Not in use, +/-1 For +/- Endcap.

Definition at line 46 of file ME0DetId.h.

References DetId::id_, minRegionId, RegionMask_, and RegionStartBit_.

Referenced by ME0SegmentBuilder::build().

                    {
    return int((id_>>RegionStartBit_) & RegionMask_) + minRegionId;
  }

int ME0DetId::roll ( ) const

inline

Roll id (also known as eta partition): each chamber is divided along the strip direction in several parts (rolls) ME0 up to 10

Definition at line 62 of file ME0DetId.h.

References DetId::id_, minRollId, RollMask_, and RollStartBit_.

                  {
    return int((id_>>RollStartBit_) & RollMask_) + minRollId; // value 0 is used as wild card
  }

int ME0DetId::station ( ) const

inline

Definition at line 76 of file ME0DetId.h.

                     {
    return 1;
  }

Member Data Documentation

const uint32_t ME0DetId::chamberIdMask_ = ~( (LayerMask_<<LayerStartBit_) | (RollMask_<<RollStartBit_))

staticprivate

Definition at line 115 of file ME0DetId.h.

Referenced by chamberId().

const unsigned int ME0DetId::ChamberMask_ = 0X3F

staticprivate

Definition at line 105 of file ME0DetId.h.

Referenced by chamber(), and init().

const int ME0DetId::ChamberNumBits_ = 6

staticprivate

Definition at line 103 of file ME0DetId.h.

const int ME0DetId::ChamberStartBit_ = RegionStartBit_+RegionNumBits_

staticprivate

Definition at line 104 of file ME0DetId.h.

Referenced by chamber(), and init().

const uint32_t ME0DetId::layerIdMask_ = ~(RollMask_<<RollStartBit_)

staticprivate

Definition at line 116 of file ME0DetId.h.

Referenced by layerId().

const unsigned int ME0DetId::LayerMask_ = 0X1F

staticprivate

Definition at line 109 of file ME0DetId.h.

Referenced by init(), and layer().

const int ME0DetId::LayerNumBits_ = 5

staticprivate

Definition at line 107 of file ME0DetId.h.

const int ME0DetId::LayerStartBit_ = ChamberStartBit_+ChamberNumBits_

staticprivate

Definition at line 108 of file ME0DetId.h.

Referenced by init(), and layer().

const int ME0DetId::maxChamberId = 18

static

Definition at line 90 of file ME0DetId.h.

Referenced by MuonME0DetLayerGeometryBuilder::buildEndcapLayers(), and init().

const int ME0DetId::maxLayerId = 6

static

Definition at line 93 of file ME0DetId.h.

Referenced by init(), and nlayers().

const int ME0DetId::maxRegionId = 1

static

Definition at line 87 of file ME0DetId.h.

Referenced by init().

const int ME0DetId::maxRollId = 1

static

Definition at line 96 of file ME0DetId.h.

Referenced by MuonME0DetLayerGeometryBuilder::buildEndcapLayers(), and init().

const int ME0DetId::minChamberId = 0

static

Definition at line 89 of file ME0DetId.h.

Referenced by MuonME0DetLayerGeometryBuilder::buildEndcapLayers(), chamber(), and init().

const int ME0DetId::minLayerId = 0

static

Definition at line 92 of file ME0DetId.h.

Referenced by init(), and layer().

const int ME0DetId::minRegionId = -1

static

Definition at line 86 of file ME0DetId.h.

Referenced by init(), and region().

const int ME0DetId::minRollId = 0

static

Definition at line 95 of file ME0DetId.h.

Referenced by MuonME0DetLayerGeometryBuilder::buildEndcapLayers(), init(), and roll().

const int ME0DetId::RegionMask_ = 0X3

staticprivate

Definition at line 101 of file ME0DetId.h.

Referenced by init(), and region().

const int ME0DetId::RegionNumBits_ = 2

staticprivate

Definition at line 99 of file ME0DetId.h.

const int ME0DetId::RegionStartBit_ = 0

staticprivate

Definition at line 100 of file ME0DetId.h.

Referenced by init(), and region().

const unsigned int ME0DetId::RollMask_ = 0X1F

staticprivate

Definition at line 113 of file ME0DetId.h.

Referenced by init(), and roll().

const int ME0DetId::RollNumBits_ = 5

staticprivate

Definition at line 111 of file ME0DetId.h.

const int ME0DetId::RollStartBit_ = LayerStartBit_+LayerNumBits_

staticprivate

Definition at line 112 of file ME0DetId.h.

Referenced by init(), and roll().

int ME0DetId::trind

private

Definition at line 124 of file ME0DetId.h.