CMS 3D CMS Logo

HcalCalibDataFrame Class Reference

Precision readout digi for HcalCalib. More...

#include <DataFormats/HcalDigi/interface/HcalCalibDataFrame.h>

List of all members.

Public Types

typedef HcalCalibDetId key_type
 For the sorted collection.

Public Member Functions

const HcalElectronicsIdelecId () const
 HcalCalibDataFrame (const HcalCalibDetId &id)
 HcalCalibDataFrame ()
const HcalCalibDetIdid () const
const HcalQIESampleoperator[] (int i) const
 access a sample
int presamples () const
 number of samples before the sample from the triggered beam crossing (according to the hardware)
const HcalQIESamplesample (int i) const
 access a sample
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)
int size () const
 total number of samples in the digi
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)
bool zsMarkAndPass () const
 was ZS MarkAndPass?
bool zsUnsuppressed () const
 was ZS unsuppressed?

Static Public Attributes

static const int MAXSAMPLES = 10

Private Attributes

HcalQIESample data_ [MAXSAMPLES]
HcalElectronicsId electronicsId_
int hcalPresamples_
HcalCalibDetId id_
int size_


Detailed Description

Precision readout digi for HcalCalib.

Definition at line 15 of file HcalCalibDataFrame.h.


Member Typedef Documentation

typedef HcalCalibDetId HcalCalibDataFrame::key_type

For the sorted collection.

Definition at line 17 of file HcalCalibDataFrame.h.


Constructor & Destructor Documentation

HcalCalibDataFrame::HcalCalibDataFrame (  ) 

Definition at line 3 of file HcalCalibDataFrame.cc.

00003                                        : id_(0), 
00004                              size_(0),
00005                              hcalPresamples_(0)
00006 {
00007 }

HcalCalibDataFrame::HcalCalibDataFrame ( const HcalCalibDetId id  )  [explicit]

Definition at line 9 of file HcalCalibDataFrame.cc.

00009                                                                : 
00010   id_(id), 
00011   size_(0),
00012   hcalPresamples_(0)
00013 {
00014   // TODO : test id for HcalForward
00015 }


Member Function Documentation

const HcalElectronicsId& HcalCalibDataFrame::elecId (  )  const [inline]

Definition at line 23 of file HcalCalibDataFrame.h.

References electronicsId_.

Referenced by HcalLedAnalysis::processLedEvent().

00023 { return electronicsId_; }

const HcalCalibDetId& HcalCalibDataFrame::id ( void   )  const [inline]

Definition at line 22 of file HcalCalibDataFrame.h.

References id_.

Referenced by HcalNominalCoder::adc2fC(), operator<<(), HcalLedAnalysis::processLedEvent(), and HcalQLPlotAnalAlgos::recoCalib().

00022 { return id_; }

const HcalQIESample& HcalCalibDataFrame::operator[] ( int  i  )  const [inline]

access a sample

Definition at line 35 of file HcalCalibDataFrame.h.

References data_.

00035 { return data_[i]; }

int HcalCalibDataFrame::presamples (  )  const [inline]

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

Definition at line 28 of file HcalCalibDataFrame.h.

References hcalPresamples_.

Referenced by HcalNominalCoder::adc2fC(), operator<<(), and HcalQLPlotAnalAlgos::recoCalib().

00028 { return hcalPresamples_&0xF; }

const HcalQIESample& HcalCalibDataFrame::sample ( int  i  )  const [inline]

access a sample

Definition at line 37 of file HcalCalibDataFrame.h.

References data_.

Referenced by operator<<(), and HcalLedAnalysis::ProcessCalibEvent().

00037 { return data_[i]; }

void HcalCalibDataFrame::setPresamples ( int  ps  ) 

Definition at line 22 of file HcalCalibDataFrame.cc.

References hcalPresamples_.

00022                                              {
00023   hcalPresamples_|=ps&0xF;
00024 }

void HcalCalibDataFrame::setReadoutIds ( const HcalElectronicsId eid  ) 

Definition at line 25 of file HcalCalibDataFrame.cc.

References electronicsId_.

00025                                                                    {
00026   electronicsId_=eid;
00027 }

void HcalCalibDataFrame::setSample ( int  i,
const HcalQIESample sam 
) [inline]

Definition at line 44 of file HcalCalibDataFrame.h.

References data_.

00044 { data_[i]=sam; }

void HcalCalibDataFrame::setSize ( int  size  ) 

Definition at line 17 of file HcalCalibDataFrame.cc.

References MAXSAMPLES, and size_.

00017                                          {
00018   if (size>MAXSAMPLES) size_=MAXSAMPLES;
00019   else if (size<=0) size_=0;
00020   else size_=size;
00021 }

void HcalCalibDataFrame::setZSInfo ( bool  unsuppressed,
bool  markAndPass 
)

Definition at line 41 of file HcalCalibDataFrame.cc.

References hcalPresamples_.

00041                                                                       {
00042   if (markAndPass) hcalPresamples_|=0x10;
00043   if (unsuppressed) hcalPresamples_|=0x20;
00044 }

int HcalCalibDataFrame::size ( void   )  const [inline]

total number of samples in the digi

Definition at line 26 of file HcalCalibDataFrame.h.

References size_.

Referenced by HcalNominalCoder::adc2fC(), operator<<(), HcalLedAnalysis::ProcessCalibEvent(), and HcalQLPlotAnalAlgos::recoCalib().

00026 { return size_&0xF; }

bool HcalCalibDataFrame::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)

Definition at line 29 of file HcalCalibDataFrame.cc.

References HcalQIESample::capid(), data_, i, and size_.

00029                                                                      {
00030   int capid=-1;
00031   bool ok=true;
00032   for (int i=0; ok && i<nSamples && i+firstSample<size_; i++) {
00033     if (data_[i+firstSample].er() || !data_[i+firstSample].dv()) ok=false;
00034     if (i==0) capid=data_[i+firstSample].capid();
00035     if (capid!=data_[i+firstSample].capid()) ok=false;
00036     capid=(capid+1)%4;
00037   }
00038   return ok;
00039 }

bool HcalCalibDataFrame::zsMarkAndPass (  )  const [inline]

was ZS MarkAndPass?

Definition at line 30 of file HcalCalibDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

00030 { return (hcalPresamples_&0x10); }

bool HcalCalibDataFrame::zsUnsuppressed (  )  const [inline]

was ZS unsuppressed?

Definition at line 32 of file HcalCalibDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

00032 { return (hcalPresamples_&0x20); }


Member Data Documentation

HcalQIESample HcalCalibDataFrame::data_[MAXSAMPLES] [private]

Definition at line 54 of file HcalCalibDataFrame.h.

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

HcalElectronicsId HcalCalibDataFrame::electronicsId_ [private]

Definition at line 51 of file HcalCalibDataFrame.h.

Referenced by elecId(), and setReadoutIds().

int HcalCalibDataFrame::hcalPresamples_ [private]

Definition at line 53 of file HcalCalibDataFrame.h.

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

HcalCalibDetId HcalCalibDataFrame::id_ [private]

Definition at line 50 of file HcalCalibDataFrame.h.

Referenced by id().

const int HcalCalibDataFrame::MAXSAMPLES = 10 [static]

Definition at line 48 of file HcalCalibDataFrame.h.

Referenced by setSize().

int HcalCalibDataFrame::size_ [private]

Definition at line 52 of file HcalCalibDataFrame.h.

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


The documentation for this class was generated from the following files:
Generated on Tue Jun 9 18:23:29 2009 for CMSSW by  doxygen 1.5.4