dunedaq::fddetdataformats::DAPHNEFrame Struct Reference

#include <DAPHNEFrame.hpp>

Collaboration diagram for dunedaq::fddetdataformats::DAPHNEFrame:

Classes
struct	Header
struct	PeakDescriptorData

Public Types
using	word_t = uint32_t

Public Member Functions
uint16_t	get_adc (int i) const
	Get the ith ADC value in the frame.
void	set_adc (int i, uint16_t val)
	Set the ith ADC value in the frame to val.
uint8_t	get_channel () const
void	set_channel (uint8_t val)
uint64_t	get_timestamp () const
	Get the 64-bit timestamp of the frame.
void	set_timestamp (uint64_t ts)
bool	operator< (const DAPHNEFrame &other) const

Public Attributes
detdataformats::DAQHeader	daq_header
Header	header
word_t	adc_words [s_num_adc_words]
PeakDescriptorData	peaks_data

Static Public Attributes
static constexpr uint8_t	version = 2
static constexpr int	s_bits_per_adc = 14
static constexpr int	s_bits_per_word = 8 * sizeof(word_t)
static constexpr int	s_num_adcs = 1024
static constexpr int	s_num_adc_words = s_num_adcs * s_bits_per_adc / s_bits_per_word
static constexpr std::size_t	s_expected_bytes

Detailed Description

Definition at line 33 of file DAPHNEFrame.hpp.

Member Typedef Documentation

word_t

using dunedaq::fddetdataformats::DAPHNEFrame::word_t = uint32_t

Definition at line 36 of file DAPHNEFrame.hpp.

Member Function Documentation

get_adc()

uint16_t dunedaq::fddetdataformats::DAPHNEFrame::get_adc ( int i ) const

inline

Get the ith ADC value in the frame.

The ADC words are 14 bits long, stored packed in the data structure. The order is:

• 1024 adc values from one daphne channel

Definition at line 5 of file DAPHNEFrame.hxx.

{
  // We can safely case from word_t to uint16_t as the ADC value can always be represented in 16 bits
  return static_cast<uint16_t>(
    dunedaq::fddetdataformats::get_adc_1d<word_t, s_num_adc_words, s_bits_per_adc>(i, adc_words));
}

get_channel()

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

inline

Definition at line 258 of file DAPHNEFrame.hpp.

{ return header.channel; }

get_timestamp()

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

inline

Get the 64-bit timestamp of the frame.

Definition at line 262 of file DAPHNEFrame.hpp.

{ return daq_header.get_timestamp(); }

operator<()

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

inline

Definition at line 269 of file DAPHNEFrame.hpp.

                                                 {
 
    if (this->get_timestamp() != other.get_timestamp()) {
      return this->get_timestamp() < other.get_timestamp();
    } else {
      return this->get_channel() < other.get_channel();
    }
  }

set_adc()

void dunedaq::fddetdataformats::DAPHNEFrame::set_adc ( int i, uint16_t val )

inline

Set the ith ADC value in the frame to val.

Definition at line 13 of file DAPHNEFrame.hxx.

{
  dunedaq::fddetdataformats::set_adc_1d<word_t, s_num_adc_words, s_bits_per_adc>(i, val, adc_words);
}

set_channel()

void dunedaq::fddetdataformats::DAPHNEFrame::set_channel ( uint8_t val )

inline

Definition at line 259 of file DAPHNEFrame.hpp.

{ header.channel = val & 0x3Fu; }

set_timestamp()

void dunedaq::fddetdataformats::DAPHNEFrame::set_timestamp ( uint64_t ts )

inline

Definition at line 264 of file DAPHNEFrame.hpp.

                                  {
    daq_header.timestamp_1 = ts;
    daq_header.timestamp_2 = ts >> 32;
  }

Member Data Documentation

adc_words

word_t dunedaq::fddetdataformats::DAPHNEFrame::adc_words[s_num_adc_words]

Definition at line 280 of file DAPHNEFrame.hpp.

daq_header

detdataformats::DAQHeader dunedaq::fddetdataformats::DAPHNEFrame::daq_header

Definition at line 278 of file DAPHNEFrame.hpp.

header

Header dunedaq::fddetdataformats::DAPHNEFrame::header

Definition at line 279 of file DAPHNEFrame.hpp.

peaks_data

PeakDescriptorData dunedaq::fddetdataformats::DAPHNEFrame::peaks_data

Definition at line 281 of file DAPHNEFrame.hpp.

s_bits_per_adc

int dunedaq::fddetdataformats::DAPHNEFrame::s_bits_per_adc = 14

staticconstexpr

Definition at line 41 of file DAPHNEFrame.hpp.

s_bits_per_word

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

staticconstexpr

Definition at line 42 of file DAPHNEFrame.hpp.

s_expected_bytes

std::size_t dunedaq::fddetdataformats::DAPHNEFrame::s_expected_bytes

staticconstexpr

Initial value:

{ sizeof(detdataformats::DAQHeader) + sizeof(Header) +
    s_num_adc_words * sizeof(word_t) + PeakDescriptorData::s_expected_bytes }

Definition at line 243 of file DAPHNEFrame.hpp.

                                              { sizeof(detdataformats::DAQHeader) + sizeof(Header) +
    s_num_adc_words * sizeof(word_t) + PeakDescriptorData::s_expected_bytes };

s_num_adc_words

int dunedaq::fddetdataformats::DAPHNEFrame::s_num_adc_words = s_num_adcs * s_bits_per_adc / s_bits_per_word

staticconstexpr

Definition at line 44 of file DAPHNEFrame.hpp.

s_num_adcs

int dunedaq::fddetdataformats::DAPHNEFrame::s_num_adcs = 1024

staticconstexpr

Definition at line 43 of file DAPHNEFrame.hpp.

version

uint8_t dunedaq::fddetdataformats::DAPHNEFrame::version = 2

staticconstexpr

Definition at line 39 of file DAPHNEFrame.hpp.

---

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

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