CMS 3D CMS Logo

Public Types | Public Member Functions | Static Public Attributes | Private Attributes

HODataFrame Class Reference

#include <HODataFrame.h>

List of all members.

Public Types

typedef HcalDetId key_type
 For the sorted collection.

Public Member Functions

const HcalElectronicsIdelecId () 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)
 HODataFrame ()
 HODataFrame (const HcalDetId &id)
const HcalDetIdid () 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 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
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)
uint32_t zsCrossingMask () const
 zs crossing mask (which sums considered)
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_
HcalDetId id_
int size_

Detailed Description

Precision readout digi for HO

Definition at line 16 of file HODataFrame.h.


Member Typedef Documentation

For the sorted collection.

Definition at line 18 of file HODataFrame.h.


Constructor & Destructor Documentation

HODataFrame::HODataFrame ( )

Definition at line 4 of file HODataFrame.cc.

                         : id_(0), 
                             size_(0),
                             hcalPresamples_(0)
{
}
HODataFrame::HODataFrame ( const HcalDetId id) [explicit]

Definition at line 10 of file HODataFrame.cc.

                                            : 
  id_(id), 
  size_(0),
  hcalPresamples_(0)
{
  // TODO : test id for HcalOuter
}

Member Function Documentation

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

Definition at line 24 of file HODataFrame.h.

References electronicsId_.

{ return electronicsId_; }
int HODataFrame::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)

Definition at line 50 of file HODataFrame.cc.

References hcalPresamples_.

Referenced by operator<<().

                                       {
  int val=(hcalPresamples_&0xF00)>>8;
  return (val==0)?(-1000):(((val&0x8)==0)?(-(val&0x7)):(val&0x7));
}
const HcalDetId& HODataFrame::id ( void  ) const [inline]
const HcalQIESample& HODataFrame::operator[] ( int  i) const [inline]

access a sample

Definition at line 38 of file HODataFrame.h.

References data_, and i.

{ return data_[i]; }
int HODataFrame::presamples ( ) const [inline]

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

Definition at line 29 of file HODataFrame.h.

References hcalPresamples_.

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

{ return hcalPresamples_&0xF; }
const HcalQIESample& HODataFrame::sample ( int  i) const [inline]
void HODataFrame::setFiberIdleOffset ( int  offset)

Definition at line 55 of file HODataFrame.cc.

References hcalPresamples_, and evf::evtn::offset().

                                               {
  hcalPresamples_&=0xFFFF0FF;
  if (offset>=7) hcalPresamples_|=0xF00;
  else if (offset>=0) hcalPresamples_|=(0x800)|(offset<<8);
  else if (offset>=-7) hcalPresamples_|=((-offset)<<8);
  else hcalPresamples_|=0x700;
}  
void HODataFrame::setPresamples ( int  ps)

Definition at line 23 of file HODataFrame.cc.

References hcalPresamples_.

                                      {
   hcalPresamples_|=ps&0xF;
}
void HODataFrame::setReadoutIds ( const HcalElectronicsId eid)

Definition at line 26 of file HODataFrame.cc.

References electronicsId_.

                                                            {
  electronicsId_=eid;
}
void HODataFrame::setSample ( int  i,
const HcalQIESample sam 
) [inline]

Definition at line 51 of file HODataFrame.h.

References data_, and i.

{ data_[i]=sam; }
void HODataFrame::setSize ( int  size)

Definition at line 18 of file HODataFrame.cc.

References MAXSAMPLES, size(), and size_.

                                  {
  if (size>MAXSAMPLES) size_=MAXSAMPLES;
  else if (size<=0) size_=0;
  else size_=size;
}
void HODataFrame::setZSInfo ( bool  unsuppressed,
bool  markAndPass,
uint32_t  crossingMask = 0 
)

Definition at line 42 of file HODataFrame.cc.

References hcalPresamples_.

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

}
int HODataFrame::size ( void  ) const [inline]
bool HODataFrame::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 30 of file HODataFrame.cc.

References HcalQIESample::capid(), data_, castor_dqm_sourceclient_file_cfg::firstSample, i, 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 HODataFrame::zsCrossingMask ( ) const [inline]

zs crossing mask (which sums considered)

Definition at line 35 of file HODataFrame.h.

References hcalPresamples_.

Referenced by HcalZSAlgoRealistic::shouldKeep().

{ return (hcalPresamples_&0x3FF000)>>12; }
bool HODataFrame::zsMarkAndPass ( ) const [inline]

was ZS MarkAndPass?

Definition at line 31 of file HODataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_&0x10); }
bool HODataFrame::zsUnsuppressed ( ) const [inline]

was ZS unsuppressed?

Definition at line 33 of file HODataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_&0x20); }

Member Data Documentation

Definition at line 61 of file HODataFrame.h.

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

Definition at line 58 of file HODataFrame.h.

Referenced by elecId(), and setReadoutIds().

Definition at line 57 of file HODataFrame.h.

Referenced by id().

const int HODataFrame::MAXSAMPLES = 10 [static]

Definition at line 55 of file HODataFrame.h.

Referenced by setSize().

int HODataFrame::size_ [private]

Definition at line 59 of file HODataFrame.h.

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