QIE10DataFrame Class Reference

#include <QIE10DataFrame.h>

Classes
class	Sample

Public Member Functions
constexpr edm::DataFrame::iterator	begin ()
	iterators More...
constexpr edm::DataFrame::const_iterator	begin () const
constexpr void	copyContent (const QIE10DataFrame &digi)
constexpr DetId	detid () const
	Get the detector id. More...
constexpr edm::DataFrame::iterator	end ()
constexpr edm::DataFrame::const_iterator	end () const
constexpr uint16_t	flags () const
	get the flag word More...
constexpr int	flavor () const
constexpr edm::DataFrame::id_type	id () const
constexpr bool	linkError () const
constexpr Sample	operator[] (edm::DataFrame::size_type i) const
	get the sample More...
constexpr int	presamples () const
	for backward compatibility More...
constexpr	QIE10DataFrame ()
constexpr	QIE10DataFrame (edm::DataFrame const &df)
constexpr int	samples () const
	total number of samples in the digi More...
constexpr void	setFlags (uint16_t v)
	set the flag word More...
constexpr void	setSample (edm::DataFrame::size_type isample, int adc, int le_tdc, int te_tdc, int capid, bool soi=false, bool ok=true)
	set the sample contents More...
constexpr void	setZSInfo (bool markAndPass)
	set ZS params More...
constexpr edm::DataFrame::size_type	size () const
	more accessors More...
constexpr bool	zsMarkAndPass () const

Static Public Attributes
static const int	FLAG_WORDS = 1
static const int	HEADER_WORDS = 1
static const int	MASK_FLAVOR = 0x7
static const int	MASK_LINKERROR = 0x800
	was there a link error? More...
static const int	MASK_MARKPASS = 0x100
	was this a mark-and-pass ZS event? More...
static const int	OFFSET_FLAVOR = 12
	get the flavor of the frame More...
static const int	WORDS_PER_SAMPLE = 2

Private Attributes
edm::DataFrame	m_data

Detailed Description

Precision readout digi from QIE10 including TDC information

Definition at line 11 of file QIE10DataFrame.h.

Constructor & Destructor Documentation

QIE10DataFrame() [1/2]

constexpr QIE10DataFrame::QIE10DataFrame ( )

inline

Definition at line 17 of file QIE10DataFrame.h.

{}

QIE10DataFrame() [2/2]

constexpr QIE10DataFrame::QIE10DataFrame ( edm::DataFrame const &  df )

inline

Definition at line 18 of file QIE10DataFrame.h.

: m_data(df) {}

Member Function Documentation

begin() [1/2]

constexpr edm::DataFrame::iterator QIE10DataFrame::begin ( void  )

inline

iterators

Definition at line 81 of file QIE10DataFrame.h.

References edm::DataFrame::begin(), and m_data.

Referenced by UHTRpacker::addChannel(), and zdchelper::setZDCSaturation().

{ return m_data.begin(); }

begin() [2/2]

constexpr edm::DataFrame::const_iterator QIE10DataFrame::begin ( void  ) const

inline

Definition at line 83 of file QIE10DataFrame.h.

References edm::DataFrame::begin(), and m_data.

{ return m_data.begin(); }

copyContent()

constexpr void QIE10DataFrame::copyContent ( const QIE10DataFrame &  digi )

inline

Definition at line 68 of file QIE10DataFrame.h.

References QIE10DataFrame::Sample::adc(), QIE10DataFrame::Sample::capid(), mps_fire::i, QIE10DataFrame::Sample::le_tdc(), QIE10DataFrame::Sample::ok(), setSample(), size(), QIE10DataFrame::Sample::soi(), and QIE10DataFrame::Sample::te_tdc().

                                                         {
    for (edm::DataFrame::size_type i = 0; i < size() && i < digi.size(); i++) {
      Sample sam = digi[i];
      setSample(i, sam.adc(), sam.le_tdc(), sam.te_tdc(), sam.capid(), sam.soi(), sam.ok());
    }
  }

detid()

constexpr DetId QIE10DataFrame::detid ( ) const

inline

Get the detector id.

Definition at line 76 of file QIE10DataFrame.h.

References edm::DataFrame::id(), and m_data.

Referenced by HFRaddamTask::_process(), PedestalTask::_process(), LEDTask::_process(), DigiTask::_process(), UMNioTask::_process(), LaserTask::_process(), QIE10DigiSortedTable::add(), UHTRpacker::addChannel(), ZDCQIE10Task::analyze(), FCDTask::analyze(), CMTRawAnalyzer::analyze(), CMTRawAnalyzer::fillDigiAmplitudeHFQIE10(), CMTRawAnalyzer::fillDigiErrorsHFQIE10(), operator<<(), HcalDigiToRawuHTR::produce(), and HcalDigiSortedTableProducer::produce().

{ return DetId(m_data.id()); }

end() [1/2]

constexpr edm::DataFrame::iterator QIE10DataFrame::end ( void  )

inline

Definition at line 82 of file QIE10DataFrame.h.

References edm::DataFrame::end(), and m_data.

Referenced by UHTRpacker::addChannel(), Types.LuminosityBlockRange::cppID(), Types.EventRange::cppID(), and zdchelper::setZDCSaturation().

{ return m_data.end(); }

end() [2/2]

constexpr edm::DataFrame::const_iterator QIE10DataFrame::end ( void  ) const

inline

Definition at line 84 of file QIE10DataFrame.h.

References edm::DataFrame::end(), and m_data.

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

{ return m_data.end(); }

flags()

constexpr uint16_t QIE10DataFrame::flags ( ) const

inline

get the flag word

Definition at line 126 of file QIE10DataFrame.h.

References m_data, and size().

Referenced by QIE10DigiSortedTable::add().

{ return m_data[size() - 1]; }

flavor()

constexpr int QIE10DataFrame::flavor ( ) const

inline

Definition at line 98 of file QIE10DataFrame.h.

References m_data, MASK_FLAVOR, and OFFSET_FLAVOR.

{ return ((m_data[0] >> OFFSET_FLAVOR) & MASK_FLAVOR); }

id()

constexpr edm::DataFrame::id_type QIE10DataFrame::id ( ) const

inline

Definition at line 77 of file QIE10DataFrame.h.

References edm::DataFrame::id(), and m_data.

Referenced by LaserTask::processLaserMon(), ZdcHitReconstructor_Run3::produce(), ZdcSimpleRecAlgo_Run3::reco0(), HFPreRecAlgo::reconstruct(), HcalSimpleRecAlgo::reconstructQIE10(), and HcalTriggerPrimitiveAlgo::validChannel().

{ return m_data.id(); }

linkError()

constexpr bool QIE10DataFrame::linkError ( ) const

inline

Definition at line 101 of file QIE10DataFrame.h.

References m_data, and MASK_LINKERROR.

Referenced by QIE10DigiSortedTable::add(), operator<<(), and HcalTriggerPrimitiveAlgo::validChannel().

{ return m_data[0] & MASK_LINKERROR; }

operator[]()

constexpr Sample QIE10DataFrame::operator[] ( edm::DataFrame::size_type  i ) const

inline

get the sample

Definition at line 111 of file QIE10DataFrame.h.

References HEADER_WORDS, mps_fire::i, m_data, and WORDS_PER_SAMPLE.

                                                                    {
    return Sample(m_data, i * WORDS_PER_SAMPLE + HEADER_WORDS);
  }

presamples()

constexpr int QIE10DataFrame::presamples ( ) const

inline

for backward compatibility

Definition at line 88 of file QIE10DataFrame.h.

References mps_fire::i, and samples().

Referenced by HcalDigiToRawuHTR::produce().

                                   {
    for (int i = 0; i < samples(); i++) {
      if ((*this)[i].soi())
        return i;
    }
    return -1;
  }

samples()

constexpr int QIE10DataFrame::samples ( ) const

inline

total number of samples in the digi

Definition at line 86 of file QIE10DataFrame.h.

References FLAG_WORDS, HEADER_WORDS, size(), and WORDS_PER_SAMPLE.

Referenced by HFRaddamTask::_process(), PedestalTask::_process(), LEDTask::_process(), DigiTask::_process(), UMNioTask::_process(), LaserTask::_process(), QIE10DigiSortedTable::add(), ZDCQIE10Task::analyze(), FCDTask::analyze(), CMTRawAnalyzer::analyze(), CMTRawAnalyzer::fillDigiAmplitudeHFQIE10(), CMTRawAnalyzer::fillDigiErrorsHFQIE10(), HLTHcalLaserMisfireFilter::filter(), operator<<(), presamples(), LaserTask::processLaserMon(), ZdcSimpleRecAlgo_Run3::reco0(), HcalZSAlgoRealistic::shouldKeep(), and HcalTriggerPrimitiveAlgo::validChannel().

{ return (size() - HEADER_WORDS - FLAG_WORDS) / WORDS_PER_SAMPLE; }

setFlags()

constexpr void QIE10DataFrame::setFlags ( uint16_t  v )

inline

set the flag word

Definition at line 128 of file QIE10DataFrame.h.

References m_data, size(), and findQualityFiles::v.

{ m_data[size() - 1] = v; }

setSample()

constexpr void QIE10DataFrame::setSample ( edm::DataFrame::size_type  isample, int  adc, int  le_tdc, int  te_tdc, int  capid, bool  soi = false, bool  ok = true  )

inline

set the sample contents

Definition at line 115 of file QIE10DataFrame.h.

References gpuClustering::adc, HEADER_WORDS, m_data, QIE10DataFrame::Sample::MASK_ADC, QIE10DataFrame::Sample::MASK_CAPID, QIE10DataFrame::Sample::MASK_LE_TDC, QIE10DataFrame::Sample::MASK_OK, QIE10DataFrame::Sample::MASK_SOI, QIE10DataFrame::Sample::MASK_TE_TDC, QIE10DataFrame::Sample::OFFSET_CAPID, QIE10DataFrame::Sample::OFFSET_TE_TDC, convertSQLiteXML::ok, size(), and WORDS_PER_SAMPLE.

Referenced by copyContent(), and HcalTDC::timing().

                                                                                                                   {
    if (isample >= size())
      return;
    m_data[isample * WORDS_PER_SAMPLE + HEADER_WORDS] =
        (adc & Sample::MASK_ADC) | (soi ? (Sample::MASK_SOI) : (0)) | (ok ? (Sample::MASK_OK) : (0));
    m_data[isample * WORDS_PER_SAMPLE + HEADER_WORDS + 1] =
        (le_tdc & Sample::MASK_LE_TDC) | ((te_tdc & Sample::MASK_TE_TDC) << Sample::OFFSET_TE_TDC) |
        ((capid & Sample::MASK_CAPID) << Sample::OFFSET_CAPID) | 0x4000;  // 0x4000 marks this as second word of a pair
  }

setZSInfo()

constexpr void QIE10DataFrame::setZSInfo ( bool  markAndPass )

inline

set ZS params

Definition at line 106 of file QIE10DataFrame.h.

References m_data, DigiNZS_cff::markAndPass, and MASK_MARKPASS.

                                             {
    if (markAndPass)
      m_data[0] |= MASK_MARKPASS;
  }

size()

constexpr edm::DataFrame::size_type QIE10DataFrame::size ( void  ) const

inline

more accessors

Definition at line 79 of file QIE10DataFrame.h.

References m_data, and edm::DataFrame::size().

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), copyContent(), flags(), samples(), setFlags(), and setSample().

{ return m_data.size(); }

zsMarkAndPass()

constexpr bool QIE10DataFrame::zsMarkAndPass ( ) const

inline

Definition at line 104 of file QIE10DataFrame.h.

References m_data, and MASK_MARKPASS.

Referenced by operator<<(), and ZdcHitReconstructor_Run3::produce().

{ return m_data[0] & MASK_MARKPASS; }

Member Data Documentation

FLAG_WORDS

const int QIE10DataFrame::FLAG_WORDS = 1

static

Definition at line 15 of file QIE10DataFrame.h.

Referenced by UHTRpacker::addChannel(), and samples().

HEADER_WORDS

const int QIE10DataFrame::HEADER_WORDS = 1

static

Definition at line 14 of file QIE10DataFrame.h.

Referenced by UHTRpacker::addChannel(), operator[](), samples(), and setSample().

m_data

edm::DataFrame QIE10DataFrame::m_data

private

Definition at line 131 of file QIE10DataFrame.h.

Referenced by begin(), detid(), end(), flags(), flavor(), id(), linkError(), operator[](), setFlags(), setSample(), setZSInfo(), size(), and zsMarkAndPass().

MASK_FLAVOR

const int QIE10DataFrame::MASK_FLAVOR = 0x7

static

Definition at line 97 of file QIE10DataFrame.h.

Referenced by flavor().

MASK_LINKERROR

const int QIE10DataFrame::MASK_LINKERROR = 0x800

static

was there a link error?

Definition at line 100 of file QIE10DataFrame.h.

Referenced by linkError().

MASK_MARKPASS

const int QIE10DataFrame::MASK_MARKPASS = 0x100

static

was this a mark-and-pass ZS event?

Definition at line 103 of file QIE10DataFrame.h.

Referenced by setZSInfo(), and zsMarkAndPass().

OFFSET_FLAVOR

const int QIE10DataFrame::OFFSET_FLAVOR = 12

static

get the flavor of the frame

Definition at line 96 of file QIE10DataFrame.h.

Referenced by flavor().

WORDS_PER_SAMPLE

const int QIE10DataFrame::WORDS_PER_SAMPLE = 2

static

Definition at line 13 of file QIE10DataFrame.h.

Referenced by operator[](), QIE10DataFrame::Sample::raw(), samples(), and setSample().