CastorDataFrame Class Reference

#include <CastorDataFrame.h>

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

Public Member Functions
	CastorDataFrame ()
	CastorDataFrame (const HcalCastorDetId &id)
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 HcalCastorDetId &	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	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]
int	hcalPresamples_
HcalCastorDetId	id_
int	size_

Detailed Description

Precision readout digi for Castor

Definition at line 15 of file CastorDataFrame.h.

Member Typedef Documentation

typedef HcalCastorDetId CastorDataFrame::key_type

For the sorted collection.

Definition at line 17 of file CastorDataFrame.h.

Constructor & Destructor Documentation

CastorDataFrame::CastorDataFrame

(

)

Definition at line 3 of file CastorDataFrame.cc.

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

CastorDataFrame::CastorDataFrame ( const HcalCastorDetId &  id )

explicit

Definition at line 5 of file CastorDataFrame.cc.

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

Member Function Documentation

int CastorDataFrame::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 47 of file CastorDataFrame.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 HcalCastorDetId& CastorDataFrame::id ( ) const

inline

Definition at line 22 of file CastorDataFrame.h.

References id_.

Referenced by CastorNominalCoder::adc2fC(), CastorPedestalsAnalysis::analyze(), CastorTTRecord::getEnergy_fC(), operator<<(), CastorDigiMonitor::processEvent(), CastorLEDMonitor::processEvent(), CastorPedestalAnalysis::processEvent(), and CastorLedAnalysis::processLedEvent().

{ return id_; }

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

inline

access a sample

Definition at line 37 of file CastorDataFrame.h.

References data_, and mps_fire::i.

{ return data_[i]; }

int CastorDataFrame::presamples ( ) const

inline

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

Definition at line 28 of file CastorDataFrame.h.

References hcalPresamples_.

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

{ return hcalPresamples_ & 0xF; }

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

inline

access a sample

Definition at line 39 of file CastorDataFrame.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 CastorPedestalsAnalysis::analyze(), operator<<(), CastorDigiMonitor::processEvent(), CastorLEDMonitor::processEvent(), and CastorPedestalAnalysis::processEvent().

{ return data_[i]; }

void CastorDataFrame::setFiberIdleOffset

(

int

offset

)

Definition at line 52 of file CastorDataFrame.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 CastorDataFrame::setPresamples

(

int

ps

)

Definition at line 18 of file CastorDataFrame.cc.

References hcalPresamples_.

Referenced by sample(), and CastorCtdcUnpacker::unpack().

{ hcalPresamples_ |= ps & 0xF; }

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

inline

Definition at line 49 of file CastorDataFrame.h.

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

Referenced by CastorCtdcUnpacker::unpack().

{ data_[i] = sam; }

void CastorDataFrame::setSize

(

int

size

)

Definition at line 9 of file CastorDataFrame.cc.

References MAXSAMPLES, size(), and size_.

Referenced by sample(), and CastorCtdcUnpacker::unpack().

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

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

Definition at line 38 of file CastorDataFrame.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 CastorDataFrame::size ( void  ) const

inline

total number of samples in the digi

Definition at line 26 of file CastorDataFrame.h.

References size_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), CastorNominalCoder::adc2fC(), CastorPedestalsAnalysis::analyze(), CastorLedAnalysis::LedCastorHists(), operator<<(), CastorDigiMonitor::processEvent(), CastorLEDMonitor::processEvent(), CastorPedestalAnalysis::processEvent(), sample(), and setSize().

{ return size_ & 0xF; }

bool CastorDataFrame::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 23 of file CastorDataFrame.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 CastorDataFrame::zsCrossingMask ( ) const

inline

zs crossing mask (which sums considered)

Definition at line 34 of file CastorDataFrame.h.

References hcalPresamples_.

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

bool CastorDataFrame::zsMarkAndPass ( ) const

inline

was ZS MarkAndPass?

Definition at line 30 of file CastorDataFrame.h.

References hcalPresamples_.

{ return (hcalPresamples_ & 0x10); }

bool CastorDataFrame::zsUnsuppressed ( ) const

inline

was ZS unsuppressed?

Definition at line 32 of file CastorDataFrame.h.

References hcalPresamples_.

{ return (hcalPresamples_ & 0x20); }

Member Data Documentation

HcalQIESample CastorDataFrame::data_[MAXSAMPLES]

private

Definition at line 61 of file CastorDataFrame.h.

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

int CastorDataFrame::hcalPresamples_

private

Definition at line 60 of file CastorDataFrame.h.

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

HcalCastorDetId CastorDataFrame::id_

private

Definition at line 57 of file CastorDataFrame.h.

Referenced by id().

const int CastorDataFrame::MAXSAMPLES = 10

static

Definition at line 54 of file CastorDataFrame.h.

Referenced by CastorCtdcUnpacker::CastorCtdcUnpacker(), CastorUnpacker::CastorUnpacker(), and setSize().

int CastorDataFrame::size_

private

Definition at line 59 of file CastorDataFrame.h.

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