HGCROCChannelDataFrame< D > Class Template Reference

wrapper for a 32b data word from a single channel and its detid The format is always the same: |1b|1b|10b|10b|10b| The filling depends on the operation mode (normal or characterization) and on the value of the Tc (TOT-complete) and Tp (TOT-in-progress) flags See EDMS CMS-CE-ES-0004 for details More...

#include <HGCROCChannelDataFrame.h>

Public Types
enum	HGCROCChannelDataFrameMask { kFlagMask = 0x1, kPacketMask = 0x3ff }
enum	HGCROCChannelDataFrameShift {   kFlag2Shift = 31, kFlag1Shift = 30, kPacket3Shift = 20, kPacket2Shift = 10,   kPacket1Shift = 0 }
typedef D	key_type

Public Member Functions
uint16_t	adc (bool charMode=false) const
uint16_t	adcm1 (bool charMode=false) const
uint16_t	compressToT (uint16_t totraw)
	the 12-bit TOT is compressed to a 10bit word truncating the first two bits when the value is above 0x1ff=2^8-1. The MSB is set to 1 in case truncation occurs. More...
uint16_t	decompressToT (uint16_t totraw) const
	the 10-bit TOT word is decompressed back to 12 bit word In case truncation occurred the word is shifted by 2 bit More...
void	fill (bool charMode, bool tc, bool tp, uint16_t adcm1, uint16_t adc, uint16_t tot, uint16_t toa)
	fills the 32b word characterization mode : tc|tp|adc|tot|toa normal mode: tc|tp|adcm1|*|toa with *=tot if tc==True else adc More...
void	fillFlag1 (bool flag)
void	fillFlag2 (bool flag)
	setters More...
void	fillPacket1 (int word)
void	fillPacket2 (int word)
void	fillPacket3 (int word)
void	fillRaw (bool flag2, bool flag1, uint16_t word3, uint16_t word2, uint16_t word1)
bool	flag1 () const
bool	flag2 () const
	HGCROCChannelDataFrame ()
	CTOR. More...
	HGCROCChannelDataFrame (const D &id)
	HGCROCChannelDataFrame (uint32_t value)
	HGCROCChannelDataFrame (const D &id, uint32_t value)
	HGCROCChannelDataFrame (const HGCROCChannelDataFrame &o)
const D &	id () const
	det id More...
uint32_t	operator() () const
	getters More...
HGCROCChannelDataFrame &	operator= (const HGCROCChannelDataFrame &)=default
uint16_t	packet1 () const
uint16_t	packet2 () const
uint16_t	packet3 () const
void	print (std::ostream &out=std::cout) const
uint32_t	raw () const
uint16_t	rawtot (bool charMode=false) const
bool	tc () const
uint16_t	tctp () const
uint16_t	toa () const
uint16_t	tot (bool charMode=false) const
bool	tp () const

Private Member Functions
void	fillPacket (uint16_t word, HGCROCChannelDataFrameMask mask, HGCROCChannelDataFrameShift shift)
	wrapper to reset words at a given position More...
uint32_t	readPacket (HGCROCChannelDataFrameMask mask, HGCROCChannelDataFrameShift shift) const
	wrapper to get packet at a given position More...

Private Attributes
D	id_
uint32_t	value_

Detailed Description

template<class D>
class HGCROCChannelDataFrame< D >

wrapper for a 32b data word from a single channel and its detid The format is always the same: |1b|1b|10b|10b|10b| The filling depends on the operation mode (normal or characterization) and on the value of the Tc (TOT-complete) and Tp (TOT-in-progress) flags See EDMS CMS-CE-ES-0004 for details

Definition at line 18 of file HGCROCChannelDataFrame.h.

Member Typedef Documentation

key_type

template<class D>

typedef D HGCROCChannelDataFrame< D >::key_type

Definition at line 21 of file HGCROCChannelDataFrame.h.

Member Enumeration Documentation

HGCROCChannelDataFrameMask

template<class D>

enum HGCROCChannelDataFrame::HGCROCChannelDataFrameMask

Enumerator
kFlagMask
kPacketMask

Definition at line 23 of file HGCROCChannelDataFrame.h.

{ kFlagMask = 0x1, kPacketMask = 0x3ff };

HGCROCChannelDataFrameShift

template<class D>

enum HGCROCChannelDataFrame::HGCROCChannelDataFrameShift

Enumerator
kFlag2Shift
kFlag1Shift
kPacket3Shift
kPacket2Shift
kPacket1Shift

Definition at line 25 of file HGCROCChannelDataFrame.h.

                                   {
    kFlag2Shift = 31,
    kFlag1Shift = 30,
    kPacket3Shift = 20,
    kPacket2Shift = 10,
    kPacket1Shift = 0
  };

Constructor & Destructor Documentation

HGCROCChannelDataFrame() [1/5]

template<class D>

HGCROCChannelDataFrame< D >::HGCROCChannelDataFrame ( )

inline

CTOR.

Definition at line 36 of file HGCROCChannelDataFrame.h.

: id_(0), value_(0) {}

HGCROCChannelDataFrame() [2/5]

template<class D>

HGCROCChannelDataFrame< D >::HGCROCChannelDataFrame ( const D &  id )

inline

Definition at line 37 of file HGCROCChannelDataFrame.h.

: id_(id), value_(0) {}

HGCROCChannelDataFrame() [3/5]

template<class D>

HGCROCChannelDataFrame< D >::HGCROCChannelDataFrame ( uint32_t  value )

inline

Definition at line 38 of file HGCROCChannelDataFrame.h.

: id_(0), value_(value) {}

HGCROCChannelDataFrame() [4/5]

template<class D>

HGCROCChannelDataFrame< D >::HGCROCChannelDataFrame ( const D &  id, uint32_t  value  )

inline

Definition at line 39 of file HGCROCChannelDataFrame.h.

: id_(id), value_(value) {}

HGCROCChannelDataFrame() [5/5]

template<class D>

HGCROCChannelDataFrame< D >::HGCROCChannelDataFrame ( const HGCROCChannelDataFrame< D > &  o )

inline

Definition at line 40 of file HGCROCChannelDataFrame.h.

: id_(o.id_), value_(o.value_) {}

Member Function Documentation

adc()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::adc ( bool  charMode = false ) const

inline

Definition at line 106 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::packet2(), HGCROCChannelDataFrame< D >::packet3(), and HGCROCChannelDataFrame< D >::tc().

Referenced by HGCROCChannelDataFrame< D >::fill(), and HGCROCChannelDataFrame< D >::print().

{ return charMode ? packet3() : (tc() ? 0 : packet2()); }

adcm1()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::adcm1 ( bool  charMode = false ) const

inline

Definition at line 107 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::packet3().

Referenced by HGCROCChannelDataFrame< D >::fill(), and HGCROCChannelDataFrame< D >::print().

{ return charMode ? 0 : packet3(); }

compressToT()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::compressToT ( uint16_t  totraw )

inline

the 12-bit TOT is compressed to a 10bit word truncating the first two bits when the value is above 0x1ff=2^8-1. The MSB is set to 1 in case truncation occurs.

Definition at line 79 of file HGCROCChannelDataFrame.h.

Referenced by HGCROCChannelDataFrame< D >::fill().

                                        {
    if (totraw > 0x1ff)
      return (0x200 | (totraw >> 3));
    return (totraw & 0x1ff);
  }

decompressToT()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::decompressToT ( uint16_t  totraw ) const

inline

the 10-bit TOT word is decompressed back to 12 bit word In case truncation occurred the word is shifted by 2 bit

Definition at line 89 of file HGCROCChannelDataFrame.h.

Referenced by HGCROCChannelDataFrame< D >::tot().

                                                {
    uint16_t totout(totraw & 0x1ff);
    if (totraw & 0x200) {
      totout = ((totraw & 0x1ff) << 3);
      totout += (1 << 2);
    }
    return totout;
  }

fill()

template<class D>

void HGCROCChannelDataFrame< D >::fill ( bool  charMode, bool  tc, bool  tp, uint16_t  adcm1, uint16_t  adc, uint16_t  tot, uint16_t  toa  )

inline

fills the 32b word characterization mode : tc|tp|adc|tot|toa normal mode: tc|tp|adcm1|*|toa with *=tot if tc==True else adc

Definition at line 53 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::adc(), HGCROCChannelDataFrame< D >::adcm1(), HGCROCChannelDataFrame< D >::compressToT(), HGCROCChannelDataFrame< D >::fillRaw(), HGCROCChannelDataFrame< D >::tc(), HGCROCChannelDataFrame< D >::toa(), HGCROCChannelDataFrame< D >::tot(), and HGCROCChannelDataFrame< D >::tp().

                                                                                                       {
    uint16_t word3(charMode ? adc : adcm1);
    uint16_t word2((charMode || tc) ? compressToT(tot) : adc);
    fillRaw(tc, tp, word3, word2, toa);
  }

fillFlag1()

template<class D>

void HGCROCChannelDataFrame< D >::fillFlag1 ( bool  flag )

inline

Definition at line 63 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillPacket(), RemoveAddSevLevel::flag, HGCROCChannelDataFrame< D >::kFlag1Shift, and HGCROCChannelDataFrame< D >::kFlagMask.

Referenced by HGCROCChannelDataFrame< D >::fillRaw().

{ fillPacket(flag, kFlagMask, kFlag1Shift); }

fillFlag2()

template<class D>

void HGCROCChannelDataFrame< D >::fillFlag2 ( bool  flag )

inline

setters

Definition at line 62 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillPacket(), RemoveAddSevLevel::flag, HGCROCChannelDataFrame< D >::kFlag2Shift, and HGCROCChannelDataFrame< D >::kFlagMask.

Referenced by HGCROCChannelDataFrame< D >::fillRaw().

{ fillPacket(flag, kFlagMask, kFlag2Shift); }

fillPacket()

template<class D>

void HGCROCChannelDataFrame< D >::fillPacket ( uint16_t  word, HGCROCChannelDataFrameMask  mask, HGCROCChannelDataFrameShift  shift  )

inlineprivate

wrapper to reset words at a given position

Definition at line 134 of file HGCROCChannelDataFrame.h.

References ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, edm::shift, and HGCROCChannelDataFrame< D >::value_.

Referenced by HGCROCChannelDataFrame< D >::fillFlag1(), HGCROCChannelDataFrame< D >::fillFlag2(), HGCROCChannelDataFrame< D >::fillPacket1(), HGCROCChannelDataFrame< D >::fillPacket2(), and HGCROCChannelDataFrame< D >::fillPacket3().

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

fillPacket1()

template<class D>

void HGCROCChannelDataFrame< D >::fillPacket1 ( int  word )

inline

Definition at line 66 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillPacket(), HGCROCChannelDataFrame< D >::kPacket1Shift, and HGCROCChannelDataFrame< D >::kPacketMask.

Referenced by HGCROCChannelDataFrame< D >::fillRaw().

{ fillPacket(word, kPacketMask, kPacket1Shift); }

fillPacket2()

template<class D>

void HGCROCChannelDataFrame< D >::fillPacket2 ( int  word )

inline

Definition at line 65 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillPacket(), HGCROCChannelDataFrame< D >::kPacket2Shift, and HGCROCChannelDataFrame< D >::kPacketMask.

Referenced by HGCROCChannelDataFrame< D >::fillRaw().

{ fillPacket(word, kPacketMask, kPacket2Shift); }

fillPacket3()

template<class D>

void HGCROCChannelDataFrame< D >::fillPacket3 ( int  word )

inline

Definition at line 64 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillPacket(), HGCROCChannelDataFrame< D >::kPacket3Shift, and HGCROCChannelDataFrame< D >::kPacketMask.

Referenced by HGCROCChannelDataFrame< D >::fillRaw().

{ fillPacket(word, kPacketMask, kPacket3Shift); }

fillRaw()

template<class D>

void HGCROCChannelDataFrame< D >::fillRaw ( bool  flag2, bool  flag1, uint16_t  word3, uint16_t  word2, uint16_t  word1  )

inline

Definition at line 67 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::fillFlag1(), HGCROCChannelDataFrame< D >::fillFlag2(), HGCROCChannelDataFrame< D >::fillPacket1(), HGCROCChannelDataFrame< D >::fillPacket2(), HGCROCChannelDataFrame< D >::fillPacket3(), HGCROCChannelDataFrame< D >::flag1(), and HGCROCChannelDataFrame< D >::flag2().

Referenced by HGCROCChannelDataFrame< D >::fill().

                                                                                       {
    fillFlag2(flag2);
    fillFlag1(flag1);
    fillPacket3(word3);
    fillPacket2(word2);
    fillPacket1(word1);
  }

flag1()

template<class D>

bool HGCROCChannelDataFrame< D >::flag1 ( ) const

inline

Definition at line 115 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::kFlag1Shift, HGCROCChannelDataFrame< D >::kFlagMask, and HGCROCChannelDataFrame< D >::readPacket().

Referenced by HGCROCChannelDataFrame< D >::fillRaw(), HGCROCChannelDataFrame< D >::print(), and HGCROCChannelDataFrame< D >::tp().

{ return readPacket(kFlagMask, kFlag1Shift); }

flag2()

template<class D>

bool HGCROCChannelDataFrame< D >::flag2 ( ) const

inline

Definition at line 114 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::kFlag2Shift, HGCROCChannelDataFrame< D >::kFlagMask, and HGCROCChannelDataFrame< D >::readPacket().

Referenced by HGCROCChannelDataFrame< D >::fillRaw(), HGCROCChannelDataFrame< D >::print(), and HGCROCChannelDataFrame< D >::tc().

{ return readPacket(kFlagMask, kFlag2Shift); }

id()

template<class D>

const D& HGCROCChannelDataFrame< D >::id ( ) const

inline

det id

Definition at line 46 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::id_.

{ return id_; }

operator()()

template<class D>

uint32_t HGCROCChannelDataFrame< D >::operator() ( ) const

inline

getters

Definition at line 101 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::value_.

{ return value_; }

operator=()

template<class D>

HGCROCChannelDataFrame& HGCROCChannelDataFrame< D >::operator= ( const HGCROCChannelDataFrame< D > &  )

default

packet1()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::packet1 ( ) const

inline

Definition at line 118 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::kPacket1Shift, HGCROCChannelDataFrame< D >::kPacketMask, and HGCROCChannelDataFrame< D >::readPacket().

Referenced by HGCROCChannelDataFrame< D >::print(), and HGCROCChannelDataFrame< D >::toa().

{ return readPacket(kPacketMask, kPacket1Shift); }

packet2()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::packet2 ( ) const

inline

Definition at line 117 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::kPacket2Shift, HGCROCChannelDataFrame< D >::kPacketMask, and HGCROCChannelDataFrame< D >::readPacket().

Referenced by HGCROCChannelDataFrame< D >::adc(), HGCROCChannelDataFrame< D >::print(), HGCROCChannelDataFrame< D >::rawtot(), and HGCROCChannelDataFrame< D >::tot().

{ return readPacket(kPacketMask, kPacket2Shift); }

packet3()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::packet3 ( ) const

inline

Definition at line 116 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::kPacket3Shift, HGCROCChannelDataFrame< D >::kPacketMask, and HGCROCChannelDataFrame< D >::readPacket().

Referenced by HGCROCChannelDataFrame< D >::adc(), HGCROCChannelDataFrame< D >::adcm1(), and HGCROCChannelDataFrame< D >::print().

{ return readPacket(kPacketMask, kPacket3Shift); }

print()

template<class D>

void HGCROCChannelDataFrame< D >::print ( std::ostream &  out = std::cout ) const

inline

Definition at line 120 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::adc(), HGCROCChannelDataFrame< D >::adcm1(), TauDecayModes::dec, HGCROCChannelDataFrame< D >::flag1(), HGCROCChannelDataFrame< D >::flag2(), MillePedeFileConverter_cfg::out, HGCROCChannelDataFrame< D >::packet1(), HGCROCChannelDataFrame< D >::packet2(), HGCROCChannelDataFrame< D >::packet3(), HGCROCChannelDataFrame< D >::raw(), HGCROCChannelDataFrame< D >::tc(), HGCROCChannelDataFrame< D >::toa(), HGCROCChannelDataFrame< D >::tot(), and HGCROCChannelDataFrame< D >::tp().

                                              {
    out << "Raw=0x" << std::hex << raw() << std::dec << std::endl
        << "\tf2: " << flag2() << " f1: " << flag1() << " p3: " << packet3() << " p2: " << packet2()
        << " p1: " << packet1() << std::endl
        << "\ttc: " << tc() << " tp: " << tp() << " adcm1: " << adcm1() << " (" << adcm1(false) << ") "
        << " adc: " << adc() << " (" << adc(false) << ") "
        << " tot: " << tot() << " (" << tot(false) << ") "
        << " toa: " << toa() << std::endl;
  }

raw()

template<class D>

uint32_t HGCROCChannelDataFrame< D >::raw ( ) const

inline

Definition at line 102 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::value_.

Referenced by HGCROCChannelDataFrame< D >::print().

{ return value_; }

rawtot()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::rawtot ( bool  charMode = false ) const

inline

Definition at line 112 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::packet2(), and HGCROCChannelDataFrame< D >::tc().

{ return charMode || tc() ? packet2() : 0; }

readPacket()

template<class D>

uint32_t HGCROCChannelDataFrame< D >::readPacket ( HGCROCChannelDataFrameMask  mask, HGCROCChannelDataFrameShift  shift  ) const

inlineprivate

wrapper to get packet at a given position

Definition at line 148 of file HGCROCChannelDataFrame.h.

References ALPAKA_ACCELERATOR_NAMESPACE::pixelClustering::pixelStatus::mask, edm::shift, and HGCROCChannelDataFrame< D >::value_.

Referenced by HGCROCChannelDataFrame< D >::flag1(), HGCROCChannelDataFrame< D >::flag2(), HGCROCChannelDataFrame< D >::packet1(), HGCROCChannelDataFrame< D >::packet2(), and HGCROCChannelDataFrame< D >::packet3().

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

tc()

template<class D>

bool HGCROCChannelDataFrame< D >::tc ( ) const

inline

Definition at line 103 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::flag2().

Referenced by HGCROCChannelDataFrame< D >::adc(), HGCROCChannelDataFrame< D >::fill(), HGCROCChannelDataFrame< D >::print(), HGCROCChannelDataFrame< D >::rawtot(), HGCROCChannelDataFrame< D >::tctp(), and HGCROCChannelDataFrame< D >::tot().

{ return flag2(); }

tctp()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::tctp ( ) const

inline

Definition at line 105 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::tc(), and HGCROCChannelDataFrame< D >::tp().

{ return (tc() << 1) | tp(); }

toa()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::toa ( ) const

inline

Definition at line 113 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::packet1().

Referenced by HGCROCChannelDataFrame< D >::fill(), and HGCROCChannelDataFrame< D >::print().

{ return packet1(); }

tot()

template<class D>

uint16_t HGCROCChannelDataFrame< D >::tot ( bool  charMode = false ) const

inline

Definition at line 108 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::decompressToT(), HGCROCChannelDataFrame< D >::packet2(), and HGCROCChannelDataFrame< D >::tc().

Referenced by HGCROCChannelDataFrame< D >::fill(), and HGCROCChannelDataFrame< D >::print().

                                            {
    uint16_t tot12b(decompressToT(packet2()));
    return charMode || tc() ? tot12b : 0;
  }

tp()

template<class D>

bool HGCROCChannelDataFrame< D >::tp ( ) const

inline

Definition at line 104 of file HGCROCChannelDataFrame.h.

References HGCROCChannelDataFrame< D >::flag1().

Referenced by HGCROCChannelDataFrame< D >::fill(), HGCROCChannelDataFrame< D >::print(), and HGCROCChannelDataFrame< D >::tctp().

{ return flag1(); }

Member Data Documentation

id_

template<class D>

D HGCROCChannelDataFrame< D >::id_

private

Definition at line 153 of file HGCROCChannelDataFrame.h.

Referenced by HGCROCChannelDataFrame< D >::id().

value_

template<class D>

uint32_t HGCROCChannelDataFrame< D >::value_

private

Definition at line 156 of file HGCROCChannelDataFrame.h.

Referenced by HGCROCChannelDataFrame< D >::fillPacket(), HGCROCChannelDataFrame< D >::operator()(), HGCROCChannelDataFrame< D >::raw(), and HGCROCChannelDataFrame< D >::readPacket().