dunedaq::fddetdataformats::WIBEthFrame Struct Reference

struct for accessing raw WIB eth frames, as used in ProtoDUNE-II More...

#include <WIBEthFrame.hpp>

Collaboration diagram for dunedaq::fddetdataformats::WIBEthFrame:

Classes
struct	WIBEthHeader

Public Types
using	word_t = uint64_t

Public Member Functions
uint16_t	get_adc (int i_channel, int i_sample=0) const
	Get the i_channel-th ADC value in the i_sample-th time sample.
void	set_adc (int i_channel, int i_sample, uint16_t adc_val)
	Set the i_channel-th ADC value in the i_sample-th time sample to adc_val.
uint64_t	get_timestamp () const
	Get the starting 64-bit timestamp of the frame.
void	set_timestamp (const uint64_t new_timestamp)
	Set the starting 64-bit timestamp of the frame.
uint8_t	get_channel () const
	Get the channel identifier of the frame.
void	set_channel (const uint8_t new_channel)
	Set the channel identifier of the frame.
bool	operator< (const WIBEthFrame &other) const

Public Attributes
detdataformats::DAQEthHeader	daq_header
WIBEthHeader	header
word_t	adc_words [s_time_samples_per_frame][s_num_adc_words_per_ts]

Static Public Attributes
static constexpr int	s_bits_per_adc = 14
static constexpr int	s_bits_per_word = 8 * sizeof(word_t)
static constexpr int	s_time_samples_per_frame = 64
static constexpr int	s_channels_per_half_femb = 64
static constexpr int	s_half_fembs_per_frame = 1
static constexpr int	s_num_channels = s_channels_per_half_femb * s_half_fembs_per_frame
static constexpr int	s_num_adc_words_per_ts = s_num_channels * s_bits_per_adc / s_bits_per_word
static constexpr size_t	s_expected_bytes

Detailed Description

struct for accessing raw WIB eth frames, as used in ProtoDUNE-II

The canonical definition of the WIB format is given in EDMS document 2088713: https://edms.cern.ch/document/2088713

Definition at line 39 of file WIBEthFrame.hpp.

Member Typedef Documentation

word_t

using dunedaq::fddetdataformats::WIBEthFrame::word_t = uint64_t

Definition at line 43 of file WIBEthFrame.hpp.

Member Function Documentation

get_adc()

uint16_t dunedaq::fddetdataformats::WIBEthFrame::get_adc ( int i_channel, int i_sample = 0 ) const

inline

Get the i_channel-th ADC value in the i_sample-th time sample.

The order is: 64 channels repeated for 64 time samples The ADC words are 14 bits long

Definition at line 5 of file WIBEthFrame.hxx.

{
 
  // Note the generic get_adc_2d function takes the channel and the time sample in reverse order
  return static_cast<uint16_t>(
    dunedaq::fddetdataformats::get_adc_2d<word_t, s_time_samples_per_frame, s_num_adc_words_per_ts, s_bits_per_adc>(
      i_sample, i_channel, adc_words));
}

get_channel()

uint8_t dunedaq::fddetdataformats::WIBEthFrame::get_channel ( ) const

inline

Get the channel identifier of the frame.

Definition at line 100 of file WIBEthFrame.hpp.

{ return header.channel; }

get_timestamp()

uint64_t dunedaq::fddetdataformats::WIBEthFrame::get_timestamp ( ) const

inline

Get the starting 64-bit timestamp of the frame.

Definition at line 94 of file WIBEthFrame.hpp.

{ return daq_header.get_timestamp(); }

operator<()

bool dunedaq::fddetdataformats::WIBEthFrame::operator< ( const WIBEthFrame & other ) const

inline

Definition at line 105 of file WIBEthFrame.hpp.

                                                 {
    return this->get_timestamp() < other.get_timestamp();
  }

set_adc()

void dunedaq::fddetdataformats::WIBEthFrame::set_adc ( int i_channel, int i_sample, uint16_t adc_val )

inline

Set the i_channel-th ADC value in the i_sample-th time sample to adc_val.

Definition at line 15 of file WIBEthFrame.hxx.

{
 
  // Note the generic set_adc_2d function takes the channel and the time sample in reverse order
  dunedaq::fddetdataformats::set_adc_2d<word_t, s_time_samples_per_frame, s_num_adc_words_per_ts, s_bits_per_adc>(
    i_sample, i_channel, adc_val, adc_words);
}

set_channel()

void dunedaq::fddetdataformats::WIBEthFrame::set_channel ( const uint8_t new_channel )

inline

Set the channel identifier of the frame.

Definition at line 103 of file WIBEthFrame.hpp.

{ header.channel = new_channel; }

set_timestamp()

void dunedaq::fddetdataformats::WIBEthFrame::set_timestamp ( const uint64_t new_timestamp )

inline

Set the starting 64-bit timestamp of the frame.

Definition at line 97 of file WIBEthFrame.hpp.

{ daq_header.timestamp = new_timestamp; }

Member Data Documentation

adc_words

word_t dunedaq::fddetdataformats::WIBEthFrame::adc_words[s_time_samples_per_frame][s_num_adc_words_per_ts]

Definition at line 111 of file WIBEthFrame.hpp.

daq_header

detdataformats::DAQEthHeader dunedaq::fddetdataformats::WIBEthFrame::daq_header

Definition at line 109 of file WIBEthFrame.hpp.

header

WIBEthHeader dunedaq::fddetdataformats::WIBEthFrame::header

Definition at line 110 of file WIBEthFrame.hpp.

s_bits_per_adc

int dunedaq::fddetdataformats::WIBEthFrame::s_bits_per_adc = 14

staticconstexpr

Definition at line 45 of file WIBEthFrame.hpp.

s_bits_per_word

int dunedaq::fddetdataformats::WIBEthFrame::s_bits_per_word = 8 * sizeof(word_t)

staticconstexpr

Definition at line 46 of file WIBEthFrame.hpp.

s_channels_per_half_femb

int dunedaq::fddetdataformats::WIBEthFrame::s_channels_per_half_femb = 64

staticconstexpr

Definition at line 48 of file WIBEthFrame.hpp.

s_expected_bytes

size_t dunedaq::fddetdataformats::WIBEthFrame::s_expected_bytes

staticconstexpr

Initial value:

{ sizeof(detdataformats::DAQEthHeader) +
    WIBEthHeader::s_expected_bytes +
    s_time_samples_per_frame * s_num_adc_words_per_ts * sizeof(word_t) }

Definition at line 77 of file WIBEthFrame.hpp.

                                           { sizeof(detdataformats::DAQEthHeader) +
    WIBEthHeader::s_expected_bytes +
    s_time_samples_per_frame * s_num_adc_words_per_ts * sizeof(word_t) };

s_half_fembs_per_frame

int dunedaq::fddetdataformats::WIBEthFrame::s_half_fembs_per_frame = 1

staticconstexpr

Definition at line 49 of file WIBEthFrame.hpp.

s_num_adc_words_per_ts

int dunedaq::fddetdataformats::WIBEthFrame::s_num_adc_words_per_ts = s_num_channels * s_bits_per_adc / s_bits_per_word

staticconstexpr

Definition at line 51 of file WIBEthFrame.hpp.

s_num_channels

int dunedaq::fddetdataformats::WIBEthFrame::s_num_channels = s_channels_per_half_femb * s_half_fembs_per_frame

staticconstexpr

Definition at line 50 of file WIBEthFrame.hpp.

s_time_samples_per_frame

int dunedaq::fddetdataformats::WIBEthFrame::s_time_samples_per_frame = 64

staticconstexpr

Definition at line 47 of file WIBEthFrame.hpp.

---

The documentation for this struct was generated from the following files:

• /github/workspace/dunedaq/sourcecode/fddetdataformats/include/fddetdataformats/WIBEthFrame.hpp
• /github/workspace/dunedaq/sourcecode/fddetdataformats/include/fddetdataformats/detail/WIBEthFrame.hxx