QIE11DataFrame Class Reference

#include <QIE11DataFrame.h>

Classes
class	Sample

Public Member Functions
constexpr edm::DataFrame::iterator	begin ()
	iterators More...
constexpr edm::DataFrame::const_iterator	begin () const
constexpr bool	capidError () const
constexpr void	copyContent (const QIE11DataFrame &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
	get the flavor of the frame More...
constexpr edm::DataFrame::id_type	id () const
constexpr bool	linkError () const
	was there a link error? More...
constexpr Sample	operator[] (edm::DataFrame::size_type i) const
	get the sample More...
constexpr int	presamples () const
	for backward compatibility More...
constexpr	QIE11DataFrame ()
constexpr	QIE11DataFrame (edm::DataFrame const &df)
constexpr int	samples () const
	total number of samples in the digi More...
constexpr void	setCapid0 (int cap0)
constexpr void	setFlags (uint16_t v)
	set the flag word More...
constexpr void	setFlavor (int flavor)
constexpr void	setSample (edm::DataFrame::size_type isample, int adc, int tdc, bool soi=false)
	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
	was this a mark-and-pass ZS event? More...

Static Public Attributes
static const int	FLAG_WORDS = 1
static const int	FLAVOR_HB = 3
static const int	HEADER_WORDS = 1
static const int	MASK_CAPIDERROR = 0x400
	was there a capid rotation error? More...
static const int	MASK_FLAVOR = 0x7
static const int	MASK_LINKERROR = 0x800
static const int	OFFSET_FLAVOR = 12
static const int	WORDS_PER_SAMPLE = 1

Private Attributes
edm::DataFrame	m_data

Detailed Description

Precision readout digi from QIE11 including TDC information

Definition at line 11 of file QIE11DataFrame.h.

Constructor & Destructor Documentation

QIE11DataFrame() [1/2]

constexpr QIE11DataFrame::QIE11DataFrame ( )

inline

Definition at line 22 of file QIE11DataFrame.h.

{}

QIE11DataFrame() [2/2]

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

inline

Definition at line 23 of file QIE11DataFrame.h.

: m_data(df) {}

Member Function Documentation

begin() [1/2]

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

inline

iterators

Definition at line 72 of file QIE11DataFrame.h.

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

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

{ return m_data.begin(); }

begin() [2/2]

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

inline

Definition at line 74 of file QIE11DataFrame.h.

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

{ return m_data.begin(); }

capidError()

constexpr bool QIE11DataFrame::capidError ( ) const

inline

Definition at line 92 of file QIE11DataFrame.h.

References m_data, and MASK_CAPIDERROR.

Referenced by QIE11DigiSortedTable::add(), and operator<<().

{ return m_data[0] & MASK_CAPIDERROR; }

copyContent()

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

inline

Definition at line 59 of file QIE11DataFrame.h.

References QIE11DataFrame::Sample::adc(), mps_fire::i, setSample(), size(), QIE11DataFrame::Sample::soi(), and QIE11DataFrame::Sample::tdc().

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

detid()

constexpr DetId QIE11DataFrame::detid ( ) const

inline

Get the detector id.

Definition at line 67 of file QIE11DataFrame.h.

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

Referenced by PedestalTask::_process(), LEDTask::_process(), DigiTask::_process(), UMNioTask::_process(), LaserTask::_process(), HcalMLTask::_process(), QIE11DigiSortedTable::add(), UHTRpacker::addChannel(), CMTRawAnalyzer::analyze(), convertHB(), CMTRawAnalyzer::fillDigiAmplitudeQIE11(), CMTRawAnalyzer::fillDigiErrorsQIE11(), operator<<(), HcalDigiToRawuHTR::produce(), and HcalDigiSortedTableProducer::produce().

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

end() [1/2]

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

inline

Definition at line 73 of file QIE11DataFrame.h.

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

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

{ return m_data.end(); }

end() [2/2]

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

inline

Definition at line 75 of file QIE11DataFrame.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 QIE11DataFrame::flags ( ) const

inline

get the flag word

Definition at line 133 of file QIE11DataFrame.h.

References m_data, and size().

Referenced by QIE11DigiSortedTable::add().

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

flavor()

constexpr int QIE11DataFrame::flavor ( ) const

inline

get the flavor of the frame

Definition at line 87 of file QIE11DataFrame.h.

References m_data, MASK_FLAVOR, and OFFSET_FLAVOR.

Referenced by operator<<(), UHTRpacker::packQIE11header(), setCapid0(), setFlavor(), setSample(), and zsMarkAndPass().

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

id()

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

inline

Definition at line 68 of file QIE11DataFrame.h.

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

Referenced by HcalZSAlgoRealistic::shouldKeep().

{ return m_data.id(); }

linkError()

constexpr bool QIE11DataFrame::linkError ( ) const

inline

was there a link error?

Definition at line 89 of file QIE11DataFrame.h.

References m_data, and MASK_LINKERROR.

Referenced by QIE11DigiSortedTable::add(), and operator<<().

{ return m_data[0] & MASK_LINKERROR; }

operator[]()

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

inline

get the sample

Definition at line 101 of file QIE11DataFrame.h.

References HEADER_WORDS, mps_fire::i, and m_data.

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

presamples()

constexpr int QIE11DataFrame::presamples ( ) const

inline

for backward compatibility

Definition at line 79 of file QIE11DataFrame.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 QIE11DataFrame::samples ( ) const

inline

total number of samples in the digi

Definition at line 77 of file QIE11DataFrame.h.

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

Referenced by PedestalTask::_process(), LEDTask::_process(), DigiTask::_process(), UMNioTask::_process(), LaserTask::_process(), QIE11DigiSortedTable::add(), CMTRawAnalyzer::analyze(), CMTRawAnalyzer::fillDigiAmplitudeQIE11(), CMTRawAnalyzer::fillDigiErrorsQIE11(), operator<<(), presamples(), ALPAKA_ACCELERATOR_NAMESPACE::HcalDigisSoAProducer::produce(), setCapid0(), and HcalZSAlgoRealistic::shouldKeep().

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

setCapid0()

constexpr void QIE11DataFrame::setCapid0 ( int  cap0 )

inline

Definition at line 109 of file QIE11DataFrame.h.

References flavor(), FLAVOR_HB, mps_fire::i, m_data, QIE11DataFrame::Sample::MASK_CAPID, QIE11DataFrame::Sample::MASK_CAPID_INV_HB, QIE11DataFrame::Sample::OFFSET_CAPID_HB, QIE11DataFrame::Sample::OFFSET_CAPID_HE, and samples().

Referenced by convertHB().

                                     {
    if (flavor() == FLAVOR_HB) {
      for (int i = 0; i < samples(); i++) {
        m_data[i + 1] &= Sample::MASK_CAPID_INV_HB;
        m_data[i + 1] |= ((cap0 + i) & Sample::MASK_CAPID) << Sample::OFFSET_CAPID_HB;
      }
    } else {
      m_data[0] &= 0xFCFF;  // inversion of the capid0 mask
      m_data[0] |= ((cap0 & Sample::MASK_CAPID) << Sample::OFFSET_CAPID_HE);
    }
  }

setFlags()

constexpr void QIE11DataFrame::setFlags ( uint16_t  v )

inline

set the flag word

Definition at line 135 of file QIE11DataFrame.h.

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

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

setFlavor()

constexpr void QIE11DataFrame::setFlavor ( int  flavor )

inline

Definition at line 104 of file QIE11DataFrame.h.

References flavor(), m_data, MASK_FLAVOR, and OFFSET_FLAVOR.

Referenced by convertHB().

                                       {
    m_data[0] &= 0x9FFF;  // inversion of flavor mask
    m_data[0] |= ((flavor & MASK_FLAVOR) << OFFSET_FLAVOR);
  }

setSample()

constexpr void QIE11DataFrame::setSample ( edm::DataFrame::size_type  isample, int  adc, int  tdc, bool  soi = false  )

inline

set the sample contents

Definition at line 121 of file QIE11DataFrame.h.

References gpuClustering::adc, flavor(), FLAVOR_HB, m_data, QIE11DataFrame::Sample::MASK_ADC, QIE11DataFrame::Sample::MASK_CAPID_KEEP_HB, QIE11DataFrame::Sample::MASK_SOI, QIE11DataFrame::Sample::MASK_TDC_HB, QIE11DataFrame::Sample::MASK_TDC_HE, QIE11DataFrame::Sample::OFFSET_TDC, and size().

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

                                                                                              {
    if (isample >= size())
      return;
    if (flavor() == FLAVOR_HB)
      m_data[isample + 1] = (adc & Sample::MASK_ADC) | (soi ? (Sample::MASK_SOI) : (0)) |
                            ((tdc & Sample::MASK_TDC_HB) << Sample::OFFSET_TDC) |
                            (m_data[isample + 1] & Sample::MASK_CAPID_KEEP_HB);
    else
      m_data[isample + 1] = (adc & Sample::MASK_ADC) | (soi ? (Sample::MASK_SOI) : (0)) |
                            ((tdc & Sample::MASK_TDC_HE) << Sample::OFFSET_TDC);
  }

setZSInfo()

constexpr void QIE11DataFrame::setZSInfo ( bool  markAndPass )

inline

set ZS params

Definition at line 96 of file QIE11DataFrame.h.

References m_data, DigiNZS_cff::markAndPass, MASK_FLAVOR, and OFFSET_FLAVOR.

                                             {
    if (markAndPass)
      m_data[0] |= (markAndPass & MASK_FLAVOR) << OFFSET_FLAVOR;
  }

size()

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

inline

more accessors

Definition at line 70 of file QIE11DataFrame.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 QIE11DataFrame::zsMarkAndPass ( ) const

inline

was this a mark-and-pass ZS event?

Definition at line 94 of file QIE11DataFrame.h.

References flavor().

Referenced by operator<<().

{ return (flavor() == 1); }

Member Data Documentation

FLAG_WORDS

const int QIE11DataFrame::FLAG_WORDS = 1

static

Definition at line 15 of file QIE11DataFrame.h.

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

FLAVOR_HB

const int QIE11DataFrame::FLAVOR_HB = 3

static

Definition at line 19 of file QIE11DataFrame.h.

Referenced by QIE11DataFrame::Sample::capid(), QIE11DataFrame::Sample::linkError(), setCapid0(), setSample(), and QIE11DataFrame::Sample::tdc().

HEADER_WORDS

const int QIE11DataFrame::HEADER_WORDS = 1

static

Definition at line 14 of file QIE11DataFrame.h.

Referenced by UHTRpacker::addChannel(), QIE11DataFrame::Sample::capid(), operator[](), ALPAKA_ACCELERATOR_NAMESPACE::HcalDigisSoAProducer::produce(), and samples().

m_data

edm::DataFrame QIE11DataFrame::m_data

private

Definition at line 138 of file QIE11DataFrame.h.

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

MASK_CAPIDERROR

const int QIE11DataFrame::MASK_CAPIDERROR = 0x400

static

was there a capid rotation error?

Definition at line 91 of file QIE11DataFrame.h.

Referenced by capidError().

MASK_FLAVOR

const int QIE11DataFrame::MASK_FLAVOR = 0x7

static

Definition at line 18 of file QIE11DataFrame.h.

Referenced by QIE11DataFrame::Sample::flavor(), flavor(), setFlavor(), and setZSInfo().

MASK_LINKERROR

const int QIE11DataFrame::MASK_LINKERROR = 0x800

static

Definition at line 20 of file QIE11DataFrame.h.

Referenced by QIE11DataFrame::Sample::linkError(), and linkError().

OFFSET_FLAVOR

const int QIE11DataFrame::OFFSET_FLAVOR = 12

static

Definition at line 17 of file QIE11DataFrame.h.

Referenced by QIE11DataFrame::Sample::flavor(), flavor(), setFlavor(), and setZSInfo().

WORDS_PER_SAMPLE

const int QIE11DataFrame::WORDS_PER_SAMPLE = 1

static

Definition at line 13 of file QIE11DataFrame.h.

Referenced by ALPAKA_ACCELERATOR_NAMESPACE::HcalDigisSoAProducer::produce(), and samples().