HBHEDataFrame Class Reference

#include <HBHEDataFrame.h>

Public Types
typedef HcalDetId	key_type
	For the sorted collection. More...

Public Member Functions
const HcalElectronicsId &	elecId () const
int	fiberIdleOffset () const
	offset of bunch number for this channel relative to nominal set in the unpacker (range is +7->-7. -1000 indicates the data is invalid/unavailable) More...
	HBHEDataFrame ()
	HBHEDataFrame (const HcalDetId &id)
const HcalDetId &	id () const
HcalQIESample const &	operator[] (int i) const
	access a sample More...
int	presamples () const
	number of samples before the sample from the triggered beam crossing (according to the hardware) More...
HcalQIESample const &	sample (int i) const
	access a sample More...
void	setFiberIdleOffset (int offset)
void	setPresamples (int ps)
void	setReadoutIds (const HcalElectronicsId &eid)
void	setSample (int i, const HcalQIESample &sam)
void	setSize (int size)
void	setZSInfo (bool unsuppressed, bool markAndPass, uint32_t crossingMask=0)
int	size () const
	total number of samples in the digi More...
bool	validate (int firstSample=0, int nSamples=100) const
	validate appropriate DV and ER bits as well as capid rotation for the specified samples (default is all) More...
uint32_t	zsCrossingMask () const
	zs crossing mask (which sums considered) More...
bool	zsMarkAndPass () const
	was ZS MarkAndPass? More...
bool	zsUnsuppressed () const
	was ZS unsuppressed? More...

Static Public Attributes
static const int	MAXSAMPLES = 10

Private Attributes
HcalQIESample	data_ [MAXSAMPLES]
HcalElectronicsId	electronicsId_
int	hcalPresamples_
HcalDetId	id_
int	size_

Detailed Description

Precision readout digi for HB and HE.

Definition at line 14 of file HBHEDataFrame.h.

Member Typedef Documentation

typedef HcalDetId HBHEDataFrame::key_type

For the sorted collection.

Definition at line 16 of file HBHEDataFrame.h.

Constructor & Destructor Documentation

HBHEDataFrame::HBHEDataFrame ( )

inline

Definition at line 18 of file HBHEDataFrame.h.

: id_(0), size_(0), hcalPresamples_(0) {}

HBHEDataFrame::HBHEDataFrame ( const HcalDetId &  id )

inlineexplicit

Definition at line 19 of file HBHEDataFrame.h.

                                                        : id_(id), size_(0), hcalPresamples_(0) {
    // TODO : test id for HcalBarrel or HcalEndcap
  }

Member Function Documentation

const HcalElectronicsId& HBHEDataFrame::elecId ( ) const

inline

Definition at line 24 of file HBHEDataFrame.h.

References electronicsId_.

{ return electronicsId_; }

int HBHEDataFrame::fiberIdleOffset ( ) const

inline

offset of bunch number for this channel relative to nominal set in the unpacker (range is +7->-7. -1000 indicates the data is invalid/unavailable)

Definition at line 43 of file HBHEDataFrame.h.

References hcalPresamples_, and heppy_batch::val.

Referenced by operator<<().

                                        {
    int val = (hcalPresamples_ & 0xF00) >> 8;
    return (val == 0) ? (-1000) : (((val & 0x8) == 0) ? (-(val & 0x7)) : (val & 0x7));
  }

const HcalDetId& HBHEDataFrame::id ( ) const

inline

Definition at line 23 of file HBHEDataFrame.h.

References id_.

Referenced by HcalNominalCoder::adc2fC(), HcaluLUTTPGCoder::adc2Linear(), HcalTriggerPrimitiveAlgo::addSignal(), reco::HcalNoiseInfoProducer::filldigis(), HLTHcalLaserMisfireFilter::filter(), HcalLaserHBHEHFFilter2012::filter(), HcalLaserHBHEFilter2012::filter(), reco::HcalNoiseRBXArray::findHPD(), reco::HcalNoiseRBXArray::findRBX(), HcaluLUTTPGCoder::lookupMSB(), operator<<(), HcalPedestalAnalysis::processEvent(), HcalLedAnalysis::processLedEvent(), HcalSignalGenerator< HBHEDigitizerTraits >::samplesInPE(), and HcalZSAlgoRealistic::shouldKeep().

{ return id_; }

HcalQIESample const& HBHEDataFrame::operator[] ( int  i ) const

inline

access a sample

Definition at line 38 of file HBHEDataFrame.h.

References data_, and mps_fire::i.

{ return data_[i]; }

int HBHEDataFrame::presamples ( ) const

inline

number of samples before the sample from the triggered beam crossing (according to the hardware)

Definition at line 29 of file HBHEDataFrame.h.

References hcalPresamples_.

Referenced by HcalNominalCoder::adc2fC(), HcalTriggerPrimitiveAlgo::addSignal(), operator<<(), and HcalSignalGenerator< HBHEDigitizerTraits >::samplesInPE().

{ return hcalPresamples_ & 0xF; }

HcalQIESample const& HBHEDataFrame::sample ( int  i ) const

inline

access a sample

Definition at line 40 of file HBHEDataFrame.h.

References data_, and mps_fire::i.

Referenced by HLTHcalLaserMisfireFilter::filter(), HcaluLUTTPGCoder::lookupMSB(), operator<<(), HcalPedestalAnalysis::processEvent(), HBHETimeProfileStatusBitSetter::TotalEnergyInDataFrame(), and HBHETimeProfileStatusBitSetter::~HBHETimeProfileStatusBitSetter().

{ return data_[i]; }

void HBHEDataFrame::setFiberIdleOffset ( int  offset )

inline

Definition at line 83 of file HBHEDataFrame.h.

References hcalPresamples_, and hltrates_dqm_sourceclient-live_cfg::offset.

                                                {
    hcalPresamples_ &= 0x7FFFF0FF;
    if (offset >= 7)
      hcalPresamples_ |= 0xF00;
    else if (offset >= 0)
      hcalPresamples_ |= (0x800) | (offset << 8);
    else if (offset >= -7)
      hcalPresamples_ |= ((-offset) << 8);
    else
      hcalPresamples_ |= 0x700;
  }

void HBHEDataFrame::setPresamples ( int  ps )

inline

Definition at line 72 of file HBHEDataFrame.h.

References hcalPresamples_.

{ hcalPresamples_ |= ps & 0xF; }

void HBHEDataFrame::setReadoutIds ( const HcalElectronicsId &  eid )

inline

Definition at line 82 of file HBHEDataFrame.h.

References runTauDisplay::eid, and electronicsId_.

{ electronicsId_ = eid; }

void HBHEDataFrame::setSample ( int  i, const HcalQIESample &  sam  )

inline

Definition at line 81 of file HBHEDataFrame.h.

References data_, and mps_fire::i.

{ data_[i] = sam; }

void HBHEDataFrame::setSize ( int  size )

inline

Definition at line 64 of file HBHEDataFrame.h.

References MAXSAMPLES, size(), and size_.

                                   {
    if (size > MAXSAMPLES)
      size_ = MAXSAMPLES;
    else if (size <= 0)
      size_ = 0;
    else
      size_ = size;
  }

void HBHEDataFrame::setZSInfo ( bool  unsuppressed, bool  markAndPass, uint32_t  crossingMask = 0  )

inline

Definition at line 73 of file HBHEDataFrame.h.

References hcalPresamples_.

Referenced by HcalZeroSuppressionAlgo::suppress().

                                                                                           {
    hcalPresamples_ &= 0x7FC00F0F;  // preserve actual presamples and fiber idle offset
    if (markAndPass)
      hcalPresamples_ |= 0x10;
    if (unsuppressed)
      hcalPresamples_ |= 0x20;
    hcalPresamples_ |= (crossingMask & 0x3FF) << 12;
  }

int HBHEDataFrame::size ( void  ) const

inline

total number of samples in the digi

Definition at line 27 of file HBHEDataFrame.h.

References size_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), HcalNominalCoder::adc2fC(), HcaluLUTTPGCoder::adc2Linear(), HcalTriggerPrimitiveAlgo::addSignal(), HLTHcalLaserMisfireFilter::filter(), HcalLedAnalysis::LedHBHEHists(), HcaluLUTTPGCoder::lookupMSB(), operator<<(), HcalPedestalAnalysis::processEvent(), HcalSignalGenerator< HBHEDigitizerTraits >::samplesInPE(), HBHEStatusBitSetter::SetFlagsFromDigi(), setSize(), HcalZSAlgoRealistic::shouldKeep(), HBHETimeProfileStatusBitSetter::TotalEnergyInDataFrame(), HcalSignalGenerator< HBHEDigitizerTraits >::validDigi(), and HBHETimeProfileStatusBitSetter::~HBHETimeProfileStatusBitSetter().

{ return size_ & 0xF; }

bool HBHEDataFrame::validate ( int  firstSample = 0, int  nSamples = 100  ) const

inline

validate appropriate DV and ER bits as well as capid rotation for the specified samples (default is all)

Definition at line 49 of file HBHEDataFrame.h.

References HcalQIESample::capid(), data_, castor_dqm_sourceclient-live_cfg::firstSample, mps_fire::i, PresampleTask_cfi::nSamples, convertSQLiteXML::ok, and size_.

                                                                         {
    int capid = -1;
    bool ok = true;
    for (int i = 0; ok && i < nSamples && i + firstSample < size_; i++) {
      if (data_[i + firstSample].er() || !data_[i + firstSample].dv())
        ok = false;
      if (i == 0)
        capid = data_[i + firstSample].capid();
      if (capid != data_[i + firstSample].capid())
        ok = false;
      capid = (capid + 1) % 4;
    }
    return ok;
  }

uint32_t HBHEDataFrame::zsCrossingMask ( ) const

inline

zs crossing mask (which sums considered)

Definition at line 35 of file HBHEDataFrame.h.

References hcalPresamples_.

Referenced by HcalZSAlgoRealistic::shouldKeep().

{ return (hcalPresamples_ & 0x3FF000) >> 12; }

bool HBHEDataFrame::zsMarkAndPass ( ) const

inline

was ZS MarkAndPass?

Definition at line 31 of file HBHEDataFrame.h.

References hcalPresamples_.

Referenced by reco::HcalNoiseInfoProducer::filldigis(), and operator<<().

{ return (hcalPresamples_ & 0x10); }

bool HBHEDataFrame::zsUnsuppressed ( ) const

inline

was ZS unsuppressed?

Definition at line 33 of file HBHEDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_ & 0x20); }

Member Data Documentation

HcalQIESample HBHEDataFrame::data_[MAXSAMPLES]

private

Definition at line 102 of file HBHEDataFrame.h.

Referenced by operator[](), sample(), setSample(), and validate().

HcalElectronicsId HBHEDataFrame::electronicsId_

private

Definition at line 99 of file HBHEDataFrame.h.

Referenced by elecId(), and setReadoutIds().

int HBHEDataFrame::hcalPresamples_

private

Definition at line 101 of file HBHEDataFrame.h.

Referenced by fiberIdleOffset(), presamples(), setFiberIdleOffset(), setPresamples(), setZSInfo(), zsCrossingMask(), zsMarkAndPass(), and zsUnsuppressed().

HcalDetId HBHEDataFrame::id_

private

Definition at line 98 of file HBHEDataFrame.h.

Referenced by id().

const int HBHEDataFrame::MAXSAMPLES = 10

static

Definition at line 95 of file HBHEDataFrame.h.

Referenced by setSize().

int HBHEDataFrame::size_

private

Definition at line 100 of file HBHEDataFrame.h.

Referenced by setSize(), size(), and validate().