EcalSampleMask Class Reference

#include <EcalSampleMask.h>

Public Member Functions
	EcalSampleMask ()
	EcalSampleMask (const unsigned int ebmask, const unsigned int eemask)
	EcalSampleMask (const std::vector< unsigned int > &ebmask, const std::vector< unsigned int > &eemask)
float	getEcalSampleMaskRecordEB () const
float	getEcalSampleMaskRecordEE () const
void	print (std::ostream &s) const
void	setEcalSampleMaskRecordEB (const unsigned int mask)
void	setEcalSampleMaskRecordEB (const std::vector< unsigned int > &ebmask)
void	setEcalSampleMaskRecordEE (const unsigned int mask)
void	setEcalSampleMaskRecordEE (const std::vector< unsigned int > &eemask)
bool	useSample (const int sampleId, DetId &theCrystal) const
bool	useSampleEB (const int sampleId) const
bool	useSampleEE (const int sampleId) const
	~EcalSampleMask ()

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
unsigned int	sampleMaskEB_
unsigned int	sampleMaskEE_

Friends
class	boost::serialization::access
template<typename CondSerializationT , typename Enabled >
struct	cond::serialization::access

Detailed Description

Author: Giovanni Franzoni, UMN Created: 09 Apr 2012

Id

EcalSampleMask.h,v 1.1 2012/05/10 08:22:10 argiro Exp

Definition at line 16 of file EcalSampleMask.h.

Constructor & Destructor Documentation

EcalSampleMask() [1/3]

EcalSampleMask::EcalSampleMask

(

)

Definition at line 14 of file EcalSampleMask.cc.

References EcalDataFrame::MAXSAMPLES, funct::pow(), sampleMaskEB_, and sampleMaskEE_.

                               {
  // by default, all samples are set as active
  sampleMaskEB_ = pow(2, EcalDataFrame::MAXSAMPLES) - 1;
  sampleMaskEE_ = pow(2, EcalDataFrame::MAXSAMPLES) - 1;
}

EcalSampleMask() [2/3]

EcalSampleMask::EcalSampleMask	(	const unsigned int	ebmask,
		const unsigned int	eemask
	)

Definition at line 20 of file EcalSampleMask.cc.

References sampleMaskEB_, and sampleMaskEE_.

                                                                                   {
  sampleMaskEB_ = ebmask;
  sampleMaskEE_ = eemask;
}

EcalSampleMask() [3/3]

EcalSampleMask::EcalSampleMask	(	const std::vector< unsigned int > &	ebmask,
		const std::vector< unsigned int > &	eemask
	)

Definition at line 25 of file EcalSampleMask.cc.

References setEcalSampleMaskRecordEB(), and setEcalSampleMaskRecordEE().

                                                                                                           {
  setEcalSampleMaskRecordEB(ebmask);
  setEcalSampleMaskRecordEE(eemask);
}

~EcalSampleMask()

EcalSampleMask::~EcalSampleMask

(

)

Definition at line 30 of file EcalSampleMask.cc.

{}

Member Function Documentation

getEcalSampleMaskRecordEB()

float EcalSampleMask::getEcalSampleMaskRecordEB ( ) const

inline

Definition at line 32 of file EcalSampleMask.h.

References sampleMaskEB_.

{ return sampleMaskEB_; }

getEcalSampleMaskRecordEE()

float EcalSampleMask::getEcalSampleMaskRecordEE ( ) const

inline

Definition at line 33 of file EcalSampleMask.h.

References sampleMaskEE_.

{ return sampleMaskEE_; }

print()

void EcalSampleMask::print ( std::ostream &  s ) const

inline

Definition at line 34 of file EcalSampleMask.h.

References alignCSCRings::s, sampleMaskEB_, and sampleMaskEE_.

{ s << "EcalSampleMask: EB " << sampleMaskEB_ << "; EE " << sampleMaskEE_; }

serialize()

template<class Archive >

void EcalSampleMask::serialize ( Archive &  ar, const unsigned int  version  )

private

setEcalSampleMaskRecordEB() [1/2]

void EcalSampleMask::setEcalSampleMaskRecordEB ( const unsigned int  mask )

inline

Definition at line 27 of file EcalSampleMask.h.

References sampleMaskEB_.

Referenced by EcalSampleMask().

{ sampleMaskEB_ = mask; }

setEcalSampleMaskRecordEB() [2/2]

void EcalSampleMask::setEcalSampleMaskRecordEB

(

const std::vector< unsigned int > &

ebmask

)

Definition at line 32 of file EcalSampleMask.cc.

References cms::cuda::assert(), EcalDataFrame::MAXSAMPLES, alignCSCRings::s, and sampleMaskEB_.

                                                                                    {
  // check that size of the vector is adequate
  if (ebmask.size() != static_cast<unsigned int>(EcalDataFrame::MAXSAMPLES)) {
    LogError("DataMismatch") << " in EcalSampleMask::setEcalSampleMaskRecordEB size of ebmask (" << ebmask.size()
                             << ") need to be: " << EcalDataFrame::MAXSAMPLES << ". Bailing out." << std::endl;
    assert(0);
  }

  // check that values of vector are allowed
  for (unsigned int s = 0; s < ebmask.size(); s++) {
    if (ebmask.at(s) == 0 || ebmask.at(s) == 1) {
      ;
    } else {
      LogError("DataMismatch")
          << "in EcalSampleMask::setEcalSampleMaskRecordEB ebmask can only have values 0 or 1, while " << ebmask.at(s)
          << " was found. Bailing out. " << std::endl;
      assert(0);
    }
  }

  // ordering of bits:
  // ebmask.at(0)                         refers to the first sample read out and is mapped into the _most_ significant bit of sampleMaskEB_
  // ebmask.at(EcalDataFrame::MAXSAMPLES) refers to the last  sample read out and is mapped into the _least_ significant bit of sampleMaskEB_
  sampleMaskEB_ = 0;
  for (unsigned int sampleId = 0; sampleId < ebmask.size(); sampleId++) {
    sampleMaskEB_ |= (0x1 << (EcalDataFrame::MAXSAMPLES - (sampleId + 1)));
  }
}

setEcalSampleMaskRecordEE() [1/2]

void EcalSampleMask::setEcalSampleMaskRecordEE ( const unsigned int  mask )

inline

Definition at line 28 of file EcalSampleMask.h.

References sampleMaskEE_.

Referenced by EcalSampleMask().

{ sampleMaskEE_ = mask; }

setEcalSampleMaskRecordEE() [2/2]

void EcalSampleMask::setEcalSampleMaskRecordEE

(

const std::vector< unsigned int > &

eemask

)

Definition at line 61 of file EcalSampleMask.cc.

References cms::cuda::assert(), EcalDataFrame::MAXSAMPLES, alignCSCRings::s, and sampleMaskEE_.

                                                                                    {
  // check that size of the vector is adequate
  if (eemask.size() != static_cast<unsigned int>(EcalDataFrame::MAXSAMPLES)) {
    LogError("DataMismatch") << " in EcalSampleMask::setEcalSampleMaskRecordEE size of eemask (" << eemask.size()
                             << ") need to be: " << EcalDataFrame::MAXSAMPLES << ". Bailing out." << std::endl;
    assert(0);
  }

  // check that values of vector are allowed
  for (unsigned int s = 0; s < eemask.size(); s++) {
    if (eemask.at(s) == 0 || eemask.at(s) == 1) {
      ;
    } else {
      LogError("DataMismatch")
          << "in EcalSampleMask::setEcalSampleMaskRecordEE eemask can only have values 0 or 1, while " << eemask.at(s)
          << " was found. Bailing out. " << std::endl;
      assert(0);
    }
  }

  // ordering of bits:
  // eemask.at(0)                         refers to the first sample read out and is mapped into the _most_ significant bit of sampleMaskEE_
  // eemask.at(EcalDataFrame::MAXSAMPLES) refers to the last  sample read out and is mapped into the _least_ significant bit of sampleMaskEE_
  sampleMaskEE_ = 0;
  for (unsigned int sampleId = 0; sampleId < eemask.size(); sampleId++) {
    sampleMaskEE_ |= (0x1 << (EcalDataFrame::MAXSAMPLES - (sampleId + 1)));
  }
}

useSample()

bool EcalSampleMask::useSample	(	const int	sampleId,
		DetId &	theCrystal
	)		const

Definition at line 116 of file EcalSampleMask.cc.

References cms::cuda::assert(), EcalBarrel, EcalEndcap, EcalDataFrame::MAXSAMPLES, DetId::subdetId(), useSampleEB(), and useSampleEE().

                                                                            {
  if (sampleId >= EcalDataFrame::MAXSAMPLES) {
    LogError("DataMismatch") << "in EcalSampleMask::useSample only sampleId up to: " << EcalDataFrame::MAXSAMPLES
                             << " can be used, while: " << sampleId << " was found. Bailing out." << std::endl;
    assert(0);
  }

  if (theCrystalId.subdetId() == EcalBarrel) {
    return useSampleEB(sampleId);
  } else if (theCrystalId.subdetId() == EcalEndcap) {
    return useSampleEE(sampleId);
  } else {
    LogError("DataMismatch")
        << "EcalSampleMaskuseSample::useSample can only be called for EcalBarrel or EcalEndcap DetID" << std::endl;
    assert(0);
  }
}

useSampleEB()

bool EcalSampleMask::useSampleEB

(

const int

sampleId

)

const

Definition at line 90 of file EcalSampleMask.cc.

References cms::cuda::assert(), EcalDataFrame::MAXSAMPLES, sampleMaskEB_, and testProducerWithPsetDescEmpty_cfi::x1.

Referenced by useSample().

                                                         {
  if (sampleId >= EcalDataFrame::MAXSAMPLES) {
    LogError("DataMismatch") << "in EcalSampleMask::useSampleEB only sampleId up to: " << EcalDataFrame::MAXSAMPLES
                             << " can be used, while: " << sampleId << " was found. Bailing out." << std::endl;
    assert(0);
  }

  // ordering convention:
  // ebmask.at(0)                         refers to the first sample read out and is mapped into the _most_ significant bit of sampleMaskEB_
  // ebmask.at(EcalDataFrame::MAXSAMPLES) refers to the last  sample read out and is mapped into the _least_ significant bit of sampleMaskEB_
  return (sampleMaskEB_ & (0x1 << (EcalDataFrame::MAXSAMPLES - (sampleId + 1))));
}

useSampleEE()

bool EcalSampleMask::useSampleEE

(

const int

sampleId

)

const

Definition at line 103 of file EcalSampleMask.cc.

References cms::cuda::assert(), EcalDataFrame::MAXSAMPLES, sampleMaskEE_, and testProducerWithPsetDescEmpty_cfi::x1.

Referenced by useSample().

                                                         {
  if (sampleId >= EcalDataFrame::MAXSAMPLES) {
    LogError("DataMismatch") << "in EcalSampleMask::useSampleEE only sampleId up to: " << EcalDataFrame::MAXSAMPLES
                             << " can be used, while: " << sampleId << " was found. Bailing out." << std::endl;
    assert(0);
  }

  // ordering convention:
  // ebmask.at(0)                         refers to the first sample read out and is mapped into the _most_ significant bit of sampleMaskEB_
  // ebmask.at(EcalDataFrame::MAXSAMPLES) refers to the last  sample read out and is mapped into the _least_ significant bit of sampleMaskEB_
  return (sampleMaskEE_ & (0x1 << (EcalDataFrame::MAXSAMPLES - (sampleId + 1))));
}

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 44 of file EcalSampleMask.h.

cond::serialization::access

template<typename CondSerializationT , typename Enabled >

friend struct cond::serialization::access

friend

Definition at line 44 of file EcalSampleMask.h.

Member Data Documentation

sampleMaskEB_

unsigned int EcalSampleMask::sampleMaskEB_

private

Definition at line 41 of file EcalSampleMask.h.

Referenced by EcalSampleMask(), getEcalSampleMaskRecordEB(), print(), setEcalSampleMaskRecordEB(), and useSampleEB().

sampleMaskEE_

unsigned int EcalSampleMask::sampleMaskEE_

private

Definition at line 42 of file EcalSampleMask.h.

Referenced by EcalSampleMask(), getEcalSampleMaskRecordEE(), print(), setEcalSampleMaskRecordEE(), and useSampleEE().