HcalUpgradeDataFrame Class Reference

#include <HcalUpgradeDataFrame.h>

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

Public Member Functions
uint16_t	adc (int iSample=0) const
int	capId (int iSample=0) const
const HcalElectronicsId &	elecId () const
	HcalUpgradeDataFrame ()
	HcalUpgradeDataFrame (HcalDetId id)
	HcalUpgradeDataFrame (HcalDetId id, int capId, int samples, int presamples)
const HcalDetId &	id () const
HcalUpgradeQIESample	operator[] (int iSample) const
int	presamples () const
void	setPresamples (int presamples)
void	setReadoutIds (const HcalElectronicsId &eid)
void	setSample (int iSample, uint16_t adc, uint16_t tdc, bool dv)
void	setSize (int size)
void	setStartingCapId (int capId)
void	setZSInfo (bool unsuppressed, bool markAndPass, uint32_t crossingMask=0)
int	size () const
int	startingCapId () const
uint16_t	tdc (int iSample=0) const
bool	valid (int iSample=0) const
uint32_t	zsCrossingMask () const
bool	zsMarkAndPass () const
bool	zsUnsuppressed () const

Static Public Attributes
static const int	MAXSAMPLES = 10

Private Attributes
uint16_t	adc_ [MAXSAMPLES]
int	capId_
bool	dv_ [MAXSAMPLES]
HcalElectronicsId	electronicsId_
HcalDetId	id_
int	presamples_
int	size_
uint16_t	tdc_ [MAXSAMPLES]

Detailed Description

Precision readout digi for Upgrade work.

Definition at line 15 of file HcalUpgradeDataFrame.h.

Member Typedef Documentation

typedef HcalDetId HcalUpgradeDataFrame::key_type

For the sorted collection.

Definition at line 17 of file HcalUpgradeDataFrame.h.

Constructor & Destructor Documentation

HcalUpgradeDataFrame::HcalUpgradeDataFrame

(

)

Definition at line 3 of file HcalUpgradeDataFrame.cc.

                                           : id_(0), 
                           electronicsId_(0),
                           capId_(0),
                           size_(0),
                           presamples_(0)
{
}

HcalUpgradeDataFrame::HcalUpgradeDataFrame

(

HcalDetId

id

)

Definition at line 11 of file HcalUpgradeDataFrame.cc.

                                                       : id_(id),
                               electronicsId_(0),
                               capId_(0),
                               size_(0),
                               presamples_(0) 
{
}

HcalUpgradeDataFrame::HcalUpgradeDataFrame	(	HcalDetId	id,
		int	capId,
		int	samples,
		int	presamples
	)

Definition at line 19 of file HcalUpgradeDataFrame.cc.

References setPresamples(), and setSize().

  : id_(id),
    electronicsId_(0),
    capId_(capId)
{
  setSize(samples) ;
  setPresamples(presamples) ;
}

Member Function Documentation

uint16_t HcalUpgradeDataFrame::adc ( int  iSample = 0 ) const

inline

Definition at line 36 of file HcalUpgradeDataFrame.h.

References adc_.

Referenced by HcalZSAlgoRealistic::keepMe(), operator<<(), operator[](), and HcalTDC::timing().

{ return adc_[iSample] ; } 

int HcalUpgradeDataFrame::capId ( int  iSample = 0 ) const

inline

Definition at line 33 of file HcalUpgradeDataFrame.h.

References capId_.

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

{ return (capId_+iSample)%4; }

const HcalElectronicsId& HcalUpgradeDataFrame::elecId ( ) const

inline

Definition at line 24 of file HcalUpgradeDataFrame.h.

References electronicsId_.

{ return electronicsId_; }

const HcalDetId& HcalUpgradeDataFrame::id ( ) const

inline

Definition at line 23 of file HcalUpgradeDataFrame.h.

References id_.

Referenced by HcalZSAlgoRealistic::keepMe(), operator<<(), HcalSimpleRecAlgo::reconstructHFUpgrade(), HcalZSAlgoRealistic::shouldKeep(), and HcalTDC::timing().

{ return id_; }

HcalUpgradeQIESample HcalUpgradeDataFrame::operator[]

(

int

iSample

)

const

Definition at line 44 of file HcalUpgradeDataFrame.cc.

References adc(), and capId_.

                                                                 {
  return HcalUpgradeQIESample(adc(i), (capId_+i)%4, 0, 0);
}

int HcalUpgradeDataFrame::presamples ( ) const

inline

Definition at line 27 of file HcalUpgradeDataFrame.h.

References presamples_.

Referenced by operator<<().

{ return presamples_&0xF ; }

void HcalUpgradeDataFrame::setPresamples

(

int

presamples

)

Definition at line 34 of file HcalUpgradeDataFrame.cc.

References MAXSAMPLES, and presamples_.

Referenced by HcalUpgradeDataFrame().

                                                       {
  if (presamples>MAXSAMPLES) presamples_|=MAXSAMPLES&0xF;
  else if (presamples<=0) presamples_=0;
  else presamples_|=presamples&0xF;
}

void HcalUpgradeDataFrame::setReadoutIds

(

const HcalElectronicsId &

eid

)

Definition at line 40 of file HcalUpgradeDataFrame.cc.

References electronicsId_.

                                                                     {
  electronicsId_=eid;
}

void HcalUpgradeDataFrame::setSample	(	int	iSample,
		uint16_t	adc,
		uint16_t	tdc,
		bool	dv
	)

Definition at line 48 of file HcalUpgradeDataFrame.cc.

References adc_, dv_, and tdc_.

Referenced by HcalCoderDb::fCUpgrade2adc_(), and HcalTDC::timing().

                              { 
  if ( iSample < MAXSAMPLES && iSample>=0) { 
    adc_[iSample] = adc&0xFF ; 
    tdc_[iSample] = tdc&0xFFFF ; 
    dv_[iSample] = dv ; 
  }    
}

void HcalUpgradeDataFrame::setSize

(

int

size

)

Definition at line 28 of file HcalUpgradeDataFrame.cc.

References MAXSAMPLES, size(), and size_.

Referenced by HcalUpgradeDataFrame().

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

void HcalUpgradeDataFrame::setStartingCapId ( int  capId )

inline

Definition at line 43 of file HcalUpgradeDataFrame.h.

References capId(), and capId_.

{ capId_ = capId ; } 

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

Definition at line 59 of file HcalUpgradeDataFrame.cc.

References presamples_.

Referenced by HcalZeroSuppressionAlgo::suppress().

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

int HcalUpgradeDataFrame::size ( void  ) const

inline

Definition at line 26 of file HcalUpgradeDataFrame.h.

References size_.

Referenced by operator<<(), HcalTDCReco::reconstruct(), setSize(), and HcalZSAlgoRealistic::shouldKeep().

{ return size_ ; }

int HcalUpgradeDataFrame::startingCapId ( ) const

inline

Definition at line 32 of file HcalUpgradeDataFrame.h.

References capId_.

{ return capId_ ; }

uint16_t HcalUpgradeDataFrame::tdc ( int  iSample = 0 ) const

inline

Definition at line 37 of file HcalUpgradeDataFrame.h.

References tdc_.

Referenced by operator<<(), and HcalTDCReco::reconstruct().

{ return tdc_[iSample] ; } 

bool HcalUpgradeDataFrame::valid ( int  iSample = 0 ) const

inline

Definition at line 35 of file HcalUpgradeDataFrame.h.

References dv_.

Referenced by operator<<().

{ return dv_[iSample] ; }

uint32_t HcalUpgradeDataFrame::zsCrossingMask ( ) const

inline

Definition at line 30 of file HcalUpgradeDataFrame.h.

References presamples_.

Referenced by HcalZSAlgoRealistic::shouldKeep().

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

bool HcalUpgradeDataFrame::zsMarkAndPass ( ) const

inline

Definition at line 28 of file HcalUpgradeDataFrame.h.

References presamples_.

Referenced by operator<<().

{ return (presamples_&0x10); }

bool HcalUpgradeDataFrame::zsUnsuppressed ( ) const

inline

Definition at line 29 of file HcalUpgradeDataFrame.h.

References presamples_.

Referenced by operator<<().

{ return (presamples_&0x20); }

Member Data Documentation

uint16_t HcalUpgradeDataFrame::adc_[MAXSAMPLES]

private

Definition at line 54 of file HcalUpgradeDataFrame.h.

Referenced by adc(), and setSample().

int HcalUpgradeDataFrame::capId_

private

Definition at line 51 of file HcalUpgradeDataFrame.h.

Referenced by capId(), operator[](), setStartingCapId(), and startingCapId().

bool HcalUpgradeDataFrame::dv_[MAXSAMPLES]

private

Definition at line 53 of file HcalUpgradeDataFrame.h.

Referenced by setSample(), and valid().

HcalElectronicsId HcalUpgradeDataFrame::electronicsId_

private

Definition at line 50 of file HcalUpgradeDataFrame.h.

Referenced by elecId(), and setReadoutIds().

HcalDetId HcalUpgradeDataFrame::id_

private

Definition at line 49 of file HcalUpgradeDataFrame.h.

Referenced by id().

const int HcalUpgradeDataFrame::MAXSAMPLES = 10

static

Definition at line 47 of file HcalUpgradeDataFrame.h.

Referenced by setPresamples(), and setSize().

int HcalUpgradeDataFrame::presamples_

private

Definition at line 52 of file HcalUpgradeDataFrame.h.

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

int HcalUpgradeDataFrame::size_

private

Definition at line 52 of file HcalUpgradeDataFrame.h.

Referenced by setSize(), and size().

uint16_t HcalUpgradeDataFrame::tdc_[MAXSAMPLES]

private

Definition at line 55 of file HcalUpgradeDataFrame.h.

Referenced by setSample(), and tdc().