ZDCDataFrame Class Reference

#include <ZDCDataFrame.h>

Public Types
typedef HcalZDCDetId	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...
const HcalZDCDetId &	id () const
const HcalQIESample &	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...
const HcalQIESample &	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...
	ZDCDataFrame ()
	ZDCDataFrame (const HcalZDCDetId &id)
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_
HcalZDCDetId	id_
int	size_

Detailed Description

Precision readout digi for ZDC

Definition at line 15 of file ZDCDataFrame.h.

Member Typedef Documentation

typedef HcalZDCDetId ZDCDataFrame::key_type

For the sorted collection.

Definition at line 17 of file ZDCDataFrame.h.

Constructor & Destructor Documentation

ZDCDataFrame::ZDCDataFrame

(

)

Definition at line 3 of file ZDCDataFrame.cc.

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

ZDCDataFrame::ZDCDataFrame ( const HcalZDCDetId &  id )

explicit

Definition at line 5 of file ZDCDataFrame.cc.

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

Member Function Documentation

const HcalElectronicsId& ZDCDataFrame::elecId ( ) const

inline

Definition at line 23 of file ZDCDataFrame.h.

References electronicsId_.

Referenced by ZDCTask::analyze().

{ return electronicsId_; }

int ZDCDataFrame::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 44 of file ZDCDataFrame.cc.

References hcalPresamples_, and heppy_batch::val.

Referenced by operator<<(), and sample().

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

const HcalZDCDetId& ZDCDataFrame::id ( ) const

inline

Definition at line 22 of file ZDCDataFrame.h.

References id_.

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

{ return id_; }

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

inline

access a sample

Definition at line 37 of file ZDCDataFrame.h.

References data_, and mps_fire::i.

{ return data_[i]; }

int ZDCDataFrame::presamples ( ) const

inline

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

Definition at line 28 of file ZDCDataFrame.h.

References hcalPresamples_.

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

{ return hcalPresamples_ & 0xF; }

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

inline

access a sample

Definition at line 39 of file ZDCDataFrame.h.

References data_, fiberIdleOffset(), castor_dqm_sourceclient-live_cfg::firstSample, mps_fire::i, DigiNZS_cff::markAndPass, PresampleTask_cfi::nSamples, setPresamples(), setSize(), setZSInfo(), size(), and validate().

Referenced by ZDCDigiStudy::analyze(), and operator<<().

{ return data_[i]; }

void ZDCDataFrame::setFiberIdleOffset

(

int

offset

)

Definition at line 49 of file ZDCDataFrame.cc.

References hcalPresamples_, and hltrates_dqm_sourceclient-live_cfg::offset.

Referenced by setSample().

                                                {
  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 ZDCDataFrame::setPresamples

(

int

ps

)

Definition at line 17 of file ZDCDataFrame.cc.

References hcalPresamples_.

Referenced by sample().

{ hcalPresamples_ |= ps & 0xF; }

void ZDCDataFrame::setReadoutIds

(

const HcalElectronicsId &

eid

)

Definition at line 18 of file ZDCDataFrame.cc.

References runTauDisplay::eid, and electronicsId_.

Referenced by setSample().

{ electronicsId_ = eid; }

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

inline

Definition at line 50 of file ZDCDataFrame.h.

References data_, runTauDisplay::eid, mps_fire::i, hltrates_dqm_sourceclient-live_cfg::offset, setFiberIdleOffset(), and setReadoutIds().

{ data_[i] = sam; }

void ZDCDataFrame::setSize

(

int

size

)

Definition at line 9 of file ZDCDataFrame.cc.

References MAXSAMPLES, size(), and size_.

Referenced by sample().

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

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

Definition at line 35 of file ZDCDataFrame.cc.

References hcalPresamples_.

Referenced by sample().

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

int ZDCDataFrame::size ( void  ) const

inline

total number of samples in the digi

Definition at line 26 of file ZDCDataFrame.h.

References size_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), HcalNominalCoder::adc2fC(), ZDCTask::analyze(), ZDCDigiStudy::analyze(), operator<<(), sample(), and setSize().

{ return size_ & 0xF; }

bool ZDCDataFrame::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 20 of file ZDCDataFrame.cc.

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

Referenced by sample().

                                                               {
  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 ZDCDataFrame::zsCrossingMask ( ) const

inline

zs crossing mask (which sums considered)

Definition at line 34 of file ZDCDataFrame.h.

References hcalPresamples_.

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

bool ZDCDataFrame::zsMarkAndPass ( ) const

inline

was ZS MarkAndPass?

Definition at line 30 of file ZDCDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_ & 0x10); }

bool ZDCDataFrame::zsUnsuppressed ( ) const

inline

was ZS unsuppressed?

Definition at line 32 of file ZDCDataFrame.h.

References hcalPresamples_.

Referenced by operator<<().

{ return (hcalPresamples_ & 0x20); }

Member Data Documentation

HcalQIESample ZDCDataFrame::data_[MAXSAMPLES]

private

Definition at line 61 of file ZDCDataFrame.h.

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

HcalElectronicsId ZDCDataFrame::electronicsId_

private

Definition at line 58 of file ZDCDataFrame.h.

Referenced by elecId(), and setReadoutIds().

int ZDCDataFrame::hcalPresamples_

private

Definition at line 60 of file ZDCDataFrame.h.

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

HcalZDCDetId ZDCDataFrame::id_

private

Definition at line 57 of file ZDCDataFrame.h.

Referenced by id().

const int ZDCDataFrame::MAXSAMPLES = 10

static

Definition at line 54 of file ZDCDataFrame.h.

Referenced by setSize(), and ZdcUnpacker::ZdcUnpacker().

int ZDCDataFrame::size_

private

Definition at line 59 of file ZDCDataFrame.h.

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