HGCSample Class Reference

wrapper for a data word More...

#include <HGCSample.h>

Public Types
enum	HGCSampleMasks {   kThreshMask = 0x1, kModeMask = 0x1, kToAValidMask = 0x1, kGainMask = 0xf,   kToAMask = 0x3ff, kDataMask = 0xfff }
enum	HGCSampleShifts {   kThreshShift = 31, kModeShift = 30, kToAValidShift = 29, kToGainShift = 22,   kToAShift = 12, kDataShift = 0 }

Public Member Functions
uint16_t	data () const
uint16_t	gain () const
bool	getToAValid () const
	HGCSample ()
	CTOR. More...
	HGCSample (uint32_t value)
	HGCSample (const HGCSample &o)
bool	mode () const
uint32_t	operator() ()
HGCSample &	operator= (const HGCSample &)=default
void	print (std::ostream &out=std::cout)
uint32_t	raw () const
	getters More...
void	set (bool thr, bool mode, uint16_t gain, uint16_t toa, uint16_t data)
void	setData (uint16_t data)
void	setGain (uint16_t gain)
void	setMode (bool mode)
void	setThreshold (bool thr)
	setters More...
void	setToA (uint16_t toa)
void	setToAValid (bool toaFired)
bool	threshold () const
uint16_t	toa () const

Static Public Member Functions
static uint32_t	convertV9ToV10 (uint32_t valueOldForm, bool toaFiredOldForm)
	Data Model Evolution. More...

Private Member Functions
uint32_t	getWord (HGCSampleMasks mask, HGCSampleShifts shift) const
void	setWord (uint16_t word, HGCSampleMasks mask, HGCSampleShifts shift)
	wrapper to reset words at a given position More...

Private Attributes
uint32_t	value_

Detailed Description

wrapper for a data word

Definition at line 13 of file HGCSample.h.

Member Enumeration Documentation

HGCSampleMasks

enum HGCSample::HGCSampleMasks

Enumerator
kThreshMask
kModeMask
kToAValidMask
kGainMask
kToAMask
kDataMask

Definition at line 15 of file HGCSample.h.

                      {
    kThreshMask = 0x1,
    kModeMask = 0x1,
    kToAValidMask = 0x1,
    kGainMask = 0xf,
    kToAMask = 0x3ff,
    kDataMask = 0xfff
  };

HGCSampleShifts

enum HGCSample::HGCSampleShifts

Enumerator
kThreshShift
kModeShift
kToAValidShift
kToGainShift
kToAShift
kDataShift

Definition at line 23 of file HGCSample.h.

                       {
    kThreshShift = 31,
    kModeShift = 30,
    kToAValidShift = 29,
    kToGainShift = 22,
    kToAShift = 12,
    kDataShift = 0
  };

Constructor & Destructor Documentation

HGCSample() [1/3]

HGCSample::HGCSample ( )

inline

CTOR.

Definition at line 35 of file HGCSample.h.

: value_(0) {}

HGCSample() [2/3]

HGCSample::HGCSample ( uint32_t  value )

inline

Definition at line 36 of file HGCSample.h.

: value_(value) {}

HGCSample() [3/3]

HGCSample::HGCSample ( const HGCSample &  o )

inline

Definition at line 37 of file HGCSample.h.

: value_(o.value_) {}

Member Function Documentation

convertV9ToV10()

static uint32_t HGCSample::convertV9ToV10 ( uint32_t  valueOldForm, bool  toaFiredOldForm  )

inlinestatic

Data Model Evolution.

Definition at line 78 of file HGCSample.h.

References kToAMask, kToAShift, kToAValidMask, and kToAValidShift.

                                                                              {
    // combine value&toaFired from the dataformat V9-or-earlier
    // from persisted objects
    // to produce a value_ compatible w/ the V10 format
    // i.e.
    // 1) shift the 10 toa bits by 1 bit
    // 2) insert the toaFired into _value
    // NOTE: nothing can be done for the gain bits:
    //       info about gain was not preswent in V9-or-earlier, and will be left to 0 in V10
    // root doc: https://root.cern.ch/root/html/io/DataModelEvolution.html
    // see PR 28349 for more info

    // V9 Format: tm--------tttttttttt-dddddddddddd
    uint32_t valueNewForm(valueOldForm);

    // set to 0 the 17 bits bits (between 13 and 29 - both included)
    valueNewForm &= ~(0x3FFFF << kToAShift);

    // copy toa to start from bit 13
    valueNewForm |= ((valueOldForm >> 13) & kToAMask) << kToAShift;

    // set 1 bit toaFiredOldForm in position 30
    valueNewForm |= (toaFiredOldForm & kToAValidMask) << kToAValidShift;

    return valueNewForm;
  }

data()

uint16_t HGCSample::data ( ) const

inline

Definition at line 71 of file HGCSample.h.

References getWord(), kDataMask, and kDataShift.

Referenced by HGCalDigiValidation::analyze(), HGCalTBAnalyzer::analyze(), print(), set(), and setData().

{ return getWord(kDataMask, kDataShift); }

gain()

uint16_t HGCSample::gain ( ) const

inline

Definition at line 69 of file HGCSample.h.

References getWord(), kGainMask, and kToGainShift.

Referenced by set(), and setGain().

{ return getWord(kGainMask, kToGainShift); }

getToAValid()

bool HGCSample::getToAValid ( ) const

inline

Definition at line 72 of file HGCSample.h.

References getWord(), kToAValidMask, and kToAValidShift.

{ return getWord(kToAValidMask, kToAValidShift); }

getWord()

uint32_t HGCSample::getWord ( HGCSampleMasks  mask, HGCSampleShifts  shift  ) const

inlineprivate

Definition at line 120 of file HGCSample.h.

References ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, edm::shift, and value_.

Referenced by data(), gain(), getToAValid(), mode(), threshold(), and toa().

{ return ((value_ >> shift) & mask); }

mode()

bool HGCSample::mode ( ) const

inline

Definition at line 68 of file HGCSample.h.

References getWord(), kModeMask, and kModeShift.

Referenced by HGCalDigiValidation::analyze(), print(), set(), and setMode().

{ return getWord(kModeMask, kModeShift); }

operator()()

uint32_t HGCSample::operator() ( )

inline

Definition at line 73 of file HGCSample.h.

References value_.

{ return value_; }

operator=()

HGCSample& HGCSample::operator= ( const HGCSample &  )

default

print()

void HGCSample::print ( std::ostream &  out = std::cout )

inline

Definition at line 58 of file HGCSample.h.

References data(), TauDecayModes::dec, mode(), MillePedeFileConverter_cfg::out, raw(), threshold(), and toa().

                                        {
    out << "THR: " << threshold() << " Mode: " << mode() << " ToA: " << toa() << " Data: " << data() << " Raw=0x"
        << std::hex << raw() << std::dec << std::endl;
  }

raw()

uint32_t HGCSample::raw ( ) const

inline

getters

Definition at line 66 of file HGCSample.h.

References value_.

Referenced by print().

{ return value_; }

set()

void HGCSample::set ( bool  thr, bool  mode, uint16_t  gain, uint16_t  toa, uint16_t  data  )

inline

Definition at line 50 of file HGCSample.h.

References data(), gain(), mode(), setData(), setGain(), setMode(), setThreshold(), setToA(), and toa().

Referenced by HGCFEElectronics< DFr >::runShaperWithToT(), HGCFEElectronics< DFr >::runSimpleShaper(), and HGCFEElectronics< DFr >::runTrivialShaper().

                                                                            {
    setThreshold(thr);
    setMode(mode);
    setGain(gain);
    setToA(toa);
    setData(data);
  }

setData()

void HGCSample::setData ( uint16_t  data )

inline

Definition at line 47 of file HGCSample.h.

References data(), kDataMask, kDataShift, and setWord().

Referenced by set().

{ setWord(data, kDataMask, kDataShift); }

setGain()

void HGCSample::setGain ( uint16_t  gain )

inline

Definition at line 45 of file HGCSample.h.

References gain(), kGainMask, kToGainShift, and setWord().

Referenced by set().

{ setWord(gain, kGainMask, kToGainShift); }

setMode()

void HGCSample::setMode ( bool  mode )

inline

Definition at line 44 of file HGCSample.h.

References kModeMask, kModeShift, mode(), and setWord().

Referenced by set().

{ setWord(mode, kModeMask, kModeShift); }

setThreshold()

void HGCSample::setThreshold ( bool  thr )

inline

setters

Definition at line 43 of file HGCSample.h.

References kThreshMask, kThreshShift, and setWord().

Referenced by set().

{ setWord(thr, kThreshMask, kThreshShift); }

setToA()

void HGCSample::setToA ( uint16_t  toa )

inline

Definition at line 46 of file HGCSample.h.

References kToAMask, kToAShift, setWord(), and toa().

Referenced by set().

{ setWord(toa, kToAMask, kToAShift); }

setToAValid()

void HGCSample::setToAValid ( bool  toaFired )

inline

Definition at line 48 of file HGCSample.h.

References kToAValidMask, kToAValidShift, and setWord().

Referenced by HGCFEElectronics< DFr >::runShaperWithToT().

{ setWord(toaFired, kToAValidMask, kToAValidShift); }

setWord()

void HGCSample::setWord ( uint16_t  word, HGCSampleMasks  mask, HGCSampleShifts  shift  )

inlineprivate

wrapper to reset words at a given position

Definition at line 109 of file HGCSample.h.

References ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, edm::shift, and value_.

Referenced by setData(), setGain(), setMode(), setThreshold(), setToA(), and setToAValid().

                                                                          {
    // mask and shift bits
    const uint32_t masked_word = (word & mask) << shift;

    //clear to 0  bits which will be set by word
    value_ &= ~(mask << shift);

    //now set bits
    value_ |= (masked_word);
  }

threshold()

bool HGCSample::threshold ( ) const

inline

Definition at line 67 of file HGCSample.h.

References getWord(), kThreshMask, and kThreshShift.

Referenced by HGCalDigiValidation::analyze(), and print().

{ return getWord(kThreshMask, kThreshShift); }

toa()

uint16_t HGCSample::toa ( ) const

inline

Definition at line 70 of file HGCSample.h.

References getWord(), kToAMask, and kToAShift.

Referenced by HGCalDigiValidation::analyze(), print(), set(), and setToA().

{ return getWord(kToAMask, kToAShift); }

Member Data Documentation

value_

uint32_t HGCSample::value_

private

Definition at line 124 of file HGCSample.h.

Referenced by getWord(), operator()(), raw(), and setWord().