#include <HFDataFrame.h>

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

Public Member Functions
constexpr HcalElectronicsId const &	elecId () const

constexpr 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...

constexpr	HFDataFrame ()

constexpr	HFDataFrame (const HcalDetId &id)

constexpr HcalDetId const &	id () const

constexpr HcalQIESample const &	operator[] (int i) const
	access a sample More...

constexpr int	presamples () const
	number of samples before the sample from the triggered beam crossing (according to the hardware) More...

constexpr HcalQIESample const &	sample (int i) const
	access a sample More...

constexpr void	setFiberIdleOffset (int offset)

constexpr void	setPresamples (int ps)

constexpr void	setReadoutIds (const HcalElectronicsId &eid)

constexpr void	setSample (int i, const HcalQIESample &sam)

constexpr void	setSize (int size)

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

constexpr int	size () const
	total number of samples in the digi More...

constexpr 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...

constexpr uint32_t	zsCrossingMask () const
	zs crossing mask (which sums considered) More...

constexpr bool	zsMarkAndPass () const
	was ZS MarkAndPass? More...

constexpr bool	zsUnsuppressed () const
	was ZS unsuppressed? More...

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 HF

Definition at line 14 of file HFDataFrame.h.

Member Typedef Documentation

◆ key_type

typedef HcalDetId HFDataFrame::key_type

For the sorted collection.

Definition at line 16 of file HFDataFrame.h.

Constructor & Destructor Documentation

◆ HFDataFrame() [1/2]

constexpr HFDataFrame::HFDataFrame ( )

inlineconstexpr

Definition at line 18 of file HFDataFrame.h.

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

◆ HFDataFrame() [2/2]

constexpr HFDataFrame::HFDataFrame ( const HcalDetId & id )

inlineexplicitconstexpr

Definition at line 19 of file HFDataFrame.h.

20 : id_(id), size_(0), hcalPresamples_(0) { // TODO : test id for HcalForward

21 }

Member Function Documentation

◆ elecId()

constexpr HcalElectronicsId const& HFDataFrame::elecId ( ) const

inlineconstexpr

Definition at line 24 of file HFDataFrame.h.

24 { return electronicsId_; }

References electronicsId_.

◆ fiberIdleOffset()

constexpr int HFDataFrame::fiberIdleOffset ( ) const

inlineconstexpr

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 43 of file HFDataFrame.h.

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

References hcalPresamples_, and heppy_batch::val.

Referenced by operator<<().

◆ id()

constexpr HcalDetId const& HFDataFrame::id ( ) const

inlineconstexpr

Definition at line 23 of file HFDataFrame.h.

23 { return id_; }

References id_.

Referenced by HFRaddamTask::_process(), operator<<(), HcalPedestalAnalysis::processEvent(), HcalLedAnalysis::processLedEvent(), and HcalSimpleRecAlgo::reconstruct().

◆ operator[]()

constexpr HcalQIESample const& HFDataFrame::operator[] ( int i ) const

inlineconstexpr

access a sample

Definition at line 38 of file HFDataFrame.h.

38 { return data_[i]; }

References data_, and mps_fire::i.

◆ presamples()

constexpr int HFDataFrame::presamples ( ) const

inlineconstexpr

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

Definition at line 29 of file HFDataFrame.h.

29 { return hcalPresamples_ & 0xF; }

References hcalPresamples_.

Referenced by operator<<().

◆ sample()

constexpr HcalQIESample const& HFDataFrame::sample ( int i ) const

inlineconstexpr

access a sample

Definition at line 40 of file HFDataFrame.h.

40 { return data_[i]; }

References data_, and mps_fire::i.

Referenced by HFRaddamTask::_process(), HcalHFStatusBitFromDigis::hfSetFlagFromDigi(), operator<<(), and HcalPedestalAnalysis::processEvent().

◆ setFiberIdleOffset()

constexpr void HFDataFrame::setFiberIdleOffset ( int offset )

inlineconstexpr

Definition at line 83 of file HFDataFrame.h.

                                                 {
     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;
   }

References hcalPresamples_, and hltrates_dqm_sourceclient-live_cfg::offset.

◆ setPresamples()

constexpr void HFDataFrame::setPresamples ( int ps )

inlineconstexpr

Definition at line 72 of file HFDataFrame.h.

72 { hcalPresamples_ |= ps & 0xF; }

References hcalPresamples_.

◆ setReadoutIds()

constexpr void HFDataFrame::setReadoutIds ( const HcalElectronicsId & eid )

inlineconstexpr

Definition at line 82 of file HFDataFrame.h.

82 { electronicsId_ = eid; }

References runTauDisplay::eid, and electronicsId_.

◆ setSample()

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

inlineconstexpr

Definition at line 81 of file HFDataFrame.h.

81 { data_[i] = sam; }

References data_, and mps_fire::i.

◆ setSize()

constexpr void HFDataFrame::setSize ( int size )

inlineconstexpr

Definition at line 64 of file HFDataFrame.h.

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

References MAXSAMPLES, size(), and size_.

◆ setZSInfo()

constexpr void HFDataFrame::setZSInfo	(	bool	unsuppressed,
		bool	markAndPass,
		uint32_t	crossingMask = `0`
	)

inlineconstexpr

Definition at line 73 of file HFDataFrame.h.

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

References hcalPresamples_, and DigiNZS_cff::markAndPass.

◆ size()

constexpr int HFDataFrame::size ( void ) const

inlineconstexpr

total number of samples in the digi

Definition at line 27 of file HFDataFrame.h.

27 { return size_ & 0xF; }

References size_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), HFRaddamTask::_process(), HcalHFStatusBitFromDigis::hfSetFlagFromDigi(), HcalLedAnalysis::LedHFHists(), operator<<(), HcalPedestalAnalysis::processEvent(), setSize(), and HcalZSAlgoRealistic::shouldKeep().

◆ validate()

constexpr bool HFDataFrame::validate	(	int	firstSample = `0`,
		int	nSamples = `100`
	)		const

inlineconstexpr

validate appropriate DV and ER bits as well as capid rotation for the specified samples (default is all)

Definition at line 49 of file HFDataFrame.h.

                                                                          {
     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;
   }

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

◆ zsCrossingMask()

constexpr uint32_t HFDataFrame::zsCrossingMask ( ) const

inlineconstexpr

zs crossing mask (which sums considered)

Definition at line 35 of file HFDataFrame.h.

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

References hcalPresamples_.

Referenced by HcalZSAlgoRealistic::shouldKeep().

◆ zsMarkAndPass()

constexpr bool HFDataFrame::zsMarkAndPass ( ) const

inlineconstexpr

was ZS MarkAndPass?

Definition at line 31 of file HFDataFrame.h.

31 { return (hcalPresamples_ & 0x10); }

References hcalPresamples_.

Referenced by operator<<().

◆ zsUnsuppressed()

constexpr bool HFDataFrame::zsUnsuppressed ( ) const

inlineconstexpr

was ZS unsuppressed?

Definition at line 33 of file HFDataFrame.h.

33 { return (hcalPresamples_ & 0x20); }

References hcalPresamples_.

Referenced by operator<<().

Member Data Documentation

◆ data_

HcalQIESample HFDataFrame::data_[MAXSAMPLES]

private

Definition at line 102 of file HFDataFrame.h.

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

◆ electronicsId_

HcalElectronicsId HFDataFrame::electronicsId_

private

Definition at line 99 of file HFDataFrame.h.

Referenced by elecId(), and setReadoutIds().

◆ hcalPresamples_

int HFDataFrame::hcalPresamples_

private

Definition at line 101 of file HFDataFrame.h.

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

◆ id_

HcalDetId HFDataFrame::id_

private

Definition at line 98 of file HFDataFrame.h.

Referenced by id().

◆ MAXSAMPLES

const int HFDataFrame::MAXSAMPLES = 10

static

Definition at line 95 of file HFDataFrame.h.

Referenced by setSize().

◆ size_

int HFDataFrame::size_

private

Definition at line 100 of file HFDataFrame.h.

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

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ key_type

Constructor & Destructor Documentation

◆ HFDataFrame() [1/2]

◆ HFDataFrame() [2/2]

Member Function Documentation

◆ elecId()

◆ fiberIdleOffset()

◆ id()

◆ operator[]()

◆ presamples()

◆ sample()

◆ setFiberIdleOffset()

◆ setPresamples()

◆ setReadoutIds()

◆ setSample()

◆ setSize()

◆ setZSInfo()

◆ size()

◆ validate()

◆ zsCrossingMask()

◆ zsMarkAndPass()

◆ zsUnsuppressed()

Member Data Documentation

◆ data_

◆ electronicsId_

◆ hcalPresamples_

◆ id_

◆ MAXSAMPLES

◆ size_