decode event packets built by ECON-D chips More...

#include <ECONDDecoder.h>

Public Member Functions
	ECONDDecoder (const std::string &name, framework::Process &p)
	normal constructor

virtual	~ECONDDecoder ()=default
	empty destructor

void	configure (framework::config::Parameters &ps) override
	configure the decoder

void	produce (framework::Event &event) override
	decode the raw binary data into HgcrocDigiCollection that can be used later for reconstruction or analysis

void	onProcessEnd () override
	print a summary of the decoding

Public Member Functions inherited from framework::Producer
	Producer (const std::string &name, Process &process)
	Class constructor.

virtual void	process (Event &event) final
	Processing an event for a Producer is calling produce.

Public Member Functions inherited from framework::EventProcessor
	DECLARE_FACTORY (EventProcessor, EventProcessor *, const std::string &, Process &)
	declare that we have a factory for this class

	EventProcessor (const std::string &name, Process &process)
	Class constructor.

virtual	~EventProcessor ()=default
	Class destructor.

virtual void	beforeNewRun (ldmx::RunHeader &run_header)
	Callback for Producers to add parameters to the run header before conditions are initialized.

virtual void	onNewRun (const ldmx::RunHeader &run_header)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.

virtual void	onFileOpen (EventFile &event_file)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.

virtual void	onFileClose (EventFile &event_file)
	Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.

virtual void	onProcessStart ()
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.

template<class T >
const T &	getCondition (const std::string &condition_name)
	Access a conditions object for the current event.

TDirectory *	getHistoDirectory ()
	Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.

void	setStorageHint (framework::StorageControl::Hint hint)
	Mark the current event as having the given storage control hint from this module_.

void	setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
	Mark the current event as having the given storage control hint from this module and the given purpose string.

int	getLogFrequency () const
	Get the current logging frequency from the process.

int	getRunNumber () const
	Get the run number from the process.

std::string	getName () const
	Get the processor name.

void	createHistograms (const std::vector< framework::config::Parameters > &histos)
	Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.

Private Member Functions
unsigned int	channelID (int i_link, int i_ch) const
	get the channel ID for the input link and channel

Private Attributes
std::string	raw_data_name_
	name of event object of raw binary data

std::string	raw_data_pass_
	name of pass to get raw binary data from

std::string	digi_output_name_
	output name of digi collection

std::string	info_output_name_
	output name of supporting data object

bool	is_ecal_ {false}
	which calorimeter subsystem we are decoding (true == Ecal, false == Hcal)

int	n_links_ {2}
	number of enabled eRx on the ECON-D

int	fiber_ {0}
	optical fiber index used in the electronics ID

bool	translate_eid_ {false}
	translate electronics IDs into detector IDs

int	roc_version_ {3}
	ROC version for the digi collection.

std::unique_ptr< MultiSampleECONDEventPacket >	packet_
	decoding buffer

long	n_frames_ {0}
	number of frames seen

long	n_no_frame_ {0}
	number of events without an input frame

long	n_frames_filled_ {0}
	number of frames whose digis were filled

long	n_bad_frame_size_ {0}
	number of frames with a size that is not a multiple of 4 bytes

std::array< long, MultiSampleECONDEventPacket::N_CORRUPTION >	n_frame_flags_ {}
	number of frames with each frame-level flag

long	n_packets_ {0}
	number of packets seen

long	n_packets_decoded_ {0}
	number of packets decoded without corruption and not empty

long	n_packets_empty_ {0}
	number of empty packets (payload length 0)

long	n_packets_corrupt_ {0}
	number of corrupted packets (skipped)

std::array< long, ECONDEventPacket::N_CORRUPTION >	n_packet_flags_ {}
	number of packets with each corruption flag

long	n_links_bad_stat_ {0}
	number of decoded link sub-packets with bad Stat bits

long	n_l1a_jumps_ {0}
	number of L1A jumps between consecutive samples

Additional Inherited Members
Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.

Protected Attributes inherited from framework::EventProcessor
HistogramPool	histograms_
	helper object for making and filling histograms

NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.

logging::logger	the_log_
	The logger for this EventProcessor.

Detailed Description

decode event packets built by ECON-D chips

The ECON-D chip is used to construct the event packets for both the Ecal and Hcal subsystems, so both will share this decoder.

Each event on the bus is one frame from SingleSubsystemUnpacker holding all of the samples from a single ECON-D. The channel samples are put into an HgcrocDigiCollection and the rest of the packet data into an ldmx::ECONDEventInfo. Corrupted packets are flagged and skipped, the digis are only filled if all samples in the event are good.

The input can also be the subsystem buffer from the EventBuilder. Events without the input buffer get empty outputs flagged with ldmx::ECONDEventInfo::NO_FRAME.

Definition at line 30 of file ECONDDecoder.h.

Constructor & Destructor Documentation

◆ ECONDDecoder()

packing::ECONDDecoder::ECONDDecoder	(	const std::string &	name,
		framework::Process &	p )

inline

normal constructor

Definition at line 33 of file ECONDDecoder.h.

34 : framework::Producer(name, p) {}

framework::Producer

Base class for a module which produces a data product.

Definition EventProcessor.h:255

Member Function Documentation

◆ channelID()

unsigned int packing::ECONDDecoder::channelID	(	int	i_link,
		int	i_ch ) const

private

get the channel ID for the input link and channel

Definition at line 60 of file ECONDDecoder.cxx.

                                                               {
  if (is_ecal_) {
    return ldmx::EcalElectronicsID(fiber_, i_link, i_ch).raw();
  }
  return ldmx::HcalElectronicsID(fiber_, i_link, i_ch).raw();
}

References fiber_, is_ecal_, and ldmx::DetectorID::raw().

Referenced by produce().

◆ configure()

void packing::ECONDDecoder::configure ( framework::config::Parameters & ps )

overridevirtual

configure the decoder

mostly focused on telling it which subsystem we are decoding (to know how to pack the ID numbers correctly), the input and output event objects.

Reimplemented from framework::EventProcessor.

Definition at line 47 of file ECONDDecoder.cxx.

                                                          {
  raw_data_name_ = ps.get<std::string>("raw_data_name");
  raw_data_pass_ = ps.get<std::string>("raw_data_pass");
  digi_output_name_ = ps.get<std::string>("digi_output_name");
  info_output_name_ = ps.get<std::string>("info_output_name");
  is_ecal_ = ps.get<bool>("is_ecal");
  n_links_ = ps.get<int>("n_links");
  fiber_ = ps.get<int>("fiber");
  translate_eid_ = ps.get<bool>("translate_eid");
  roc_version_ = ps.get<int>("roc_version");
  packet_ = std::make_unique<MultiSampleECONDEventPacket>(n_links_);
}

References digi_output_name_, fiber_, framework::config::Parameters::get(), info_output_name_, is_ecal_, n_links_, packet_, raw_data_name_, raw_data_pass_, roc_version_, and translate_eid_.

◆ onProcessEnd()

void packing::ECONDDecoder::onProcessEnd ( )

overridevirtual

print a summary of the decoding

Reimplemented from framework::EventProcessor.

Definition at line 196 of file ECONDDecoder.cxx.

                                {
  ldmx_log(info) << "ECON-D decoding summary for " << raw_data_name_;
  ldmx_log(info) << "  frames seen: " << n_frames_
                 << ", digis filled: " << n_frames_filled_;
  if (n_no_frame_ > 0) {
    ldmx_log(info) << "  events without a frame: " << n_no_frame_;
  }
  if (n_bad_frame_size_ > 0) {
    ldmx_log(info) << "  frames with size not a multiple of 4 bytes: "
                   << n_bad_frame_size_;
  }
  for (std::size_t i{0}; i < n_frame_flags_.size(); i++) {
    if (n_frame_flags_[i] > 0) {
      ldmx_log(info) << "  frames with " << FRAME_FLAG_NAMES[i] << ": "
                     << n_frame_flags_[i];
    }
  }
  ldmx_log(info) << "  packets seen: " << n_packets_
                 << ", decoded: " << n_packets_decoded_
                 << ", empty: " << n_packets_empty_
                 << ", corrupt (skipped): " << n_packets_corrupt_;
  for (std::size_t i{0}; i < n_packet_flags_.size(); i++) {
    if (n_packet_flags_[i] > 0) {
      ldmx_log(info) << "  packets with " << PACKET_FLAG_NAMES[i] << ": "
                     << n_packet_flags_[i];
    }
  }
  if (n_links_bad_stat_ > 0) {
    ldmx_log(info) << "  decoded links with bad Stat bits: "
                   << n_links_bad_stat_;
  }
  ldmx_log(info) << "  L1A jumps between samples: " << n_l1a_jumps_;
}

References n_bad_frame_size_, n_frame_flags_, n_frames_, n_frames_filled_, n_l1a_jumps_, n_links_bad_stat_, n_no_frame_, n_packet_flags_, n_packets_, n_packets_corrupt_, n_packets_decoded_, n_packets_empty_, and raw_data_name_.

◆ produce()

void packing::ECONDDecoder::produce ( framework::Event & event )

overridevirtual

decode the raw binary data into HgcrocDigiCollection that can be used later for reconstruction or analysis

Implements framework::Producer.

Definition at line 67 of file ECONDDecoder.cxx.

                                                {
  ldmx::ECONDEventInfo info;
  ldmx::HgcrocDigiCollection digis;
  digis.setVersion(roc_version_);
  digis.setNumSamplesPerDigi(0);
  digis.setSampleOfInterestIndex(0);
 
  // e.g. an EventBuilder event without a fragment from this subsystem
  if (not event.exists(raw_data_name_, raw_data_pass_)) {
    n_no_frame_++;
    info.setFrame(1 << ldmx::ECONDEventInfo::NO_FRAME, -1, 0, 0);
    event.add(digi_output_name_, digis);
    event.add(info_output_name_, info);
    return;
  }
 
  const auto& raw_binary{
      event.getCollection<uint8_t>(raw_data_name_, raw_data_pass_)};
  n_frames_++;
 
  int frame_corruption{0};
  if (raw_binary.size() % 4 != 0) {
    ldmx_log(debug) << raw_data_name_ << " has " << raw_binary.size()
                    << " bytes which is not a multiple of 4, ignoring the "
                    << raw_binary.size() % 4 << " trailing bytes";
    frame_corruption |= (1 << ldmx::ECONDEventInfo::BAD_FRAME_SIZE);
    n_bad_frame_size_++;
  }
  // copy into 32-bit words, the data is little endian
  std::vector<uint32_t> words(raw_binary.size() / 4);
  std::memcpy(words.data(), raw_binary.data(), words.size() * 4);
 
  packet_->from(words);
  const auto& pkt{*packet_};
  frame_corruption |= toMask(pkt.corruption_);
  for (std::size_t i{0}; i < pkt.corruption_.size(); i++) {
    if (pkt.corruption_[i]) n_frame_flags_[i]++;
  }
 
  bool all_good = (frame_corruption == 0) and not pkt.samples_.empty();
  for (std::size_t i_sample{0}; i_sample < pkt.samples_.size(); i_sample++) {
    const auto& header{pkt.headers_[i_sample]};
    const auto& sample{pkt.samples_[i_sample]};
    n_packets_++;
 
    ldmx::ECONDSampleInfo sample_info;
    sample_info.setCaptureHeader(header.econd_id_, header.i_l1a_,
                                 header.is_soi_, header.econd_len_);
    int flags = (sample.passthrough_ ? 1 : 0) | (sample.expected_ ? 2 : 0) |
                (sample.match_ ? 4 : 0) | (sample.truncated_ ? 8 : 0) |
                (sample.subpacket_error_ ? 16 : 0);
    sample_info.setHeader(sample.payload_length_, flags, sample.ht_,
                          sample.ebo_, sample.bx_, sample.l1a_, sample.orbit_,
                          sample.reset_request_);
    sample_info.setCorruption(toMask(sample.corruption_));
 
    for (std::size_t i{0}; i < sample.corruption_.size(); i++) {
      if (sample.corruption_[i]) n_packet_flags_[i]++;
    }
 
    if (sample.isCorrupt()) {
      n_packets_corrupt_++;
      all_good = false;
    } else if (sample.isEmpty()) {
      n_packets_empty_++;
      all_good = false;
    } else {
      n_packets_decoded_++;
      for (const auto& link : sample.links_) {
        if (link.badStat()) n_links_bad_stat_++;
        ldmx::ECONDLinkInfo link_info;
        link_info.set(link.stat_, link.is_empty_, link.adc_cm0_, link.adc_cm1_,
                      link.calib_);
        sample_info.addLink(link_info);
      }
    }
 
    // L1A numbers are 6 bits
    if (i_sample > 0 and not sample.isCorrupt() and
        not pkt.samples_[i_sample - 1].isCorrupt() and
        sample.l1a_ != ((pkt.samples_[i_sample - 1].l1a_ + 1) & 0x3f)) {
      n_l1a_jumps_++;
    }
 
    info.addSample(sample_info);
  }
 
  info.setFrame(frame_corruption, pkt.trailer_n_samples_, pkt.i_soi_,
                pkt.n_skipped_words_);
 
  if (all_good) {
    std::size_t n_samples{pkt.samples_.size()};
    digis.setNumSamplesPerDigi(n_samples);
    digis.setSampleOfInterestIndex(pkt.i_soi_);
    // resort from (sample, link, channel) to (link, channel, sample)
    std::vector<uint32_t> digi(n_samples);
    for (int i_link{0}; i_link < n_links_; i_link++) {
      for (int i_ch{0}; i_ch < 36; i_ch++) {
        for (std::size_t i_sample{0}; i_sample < n_samples; i_sample++) {
          digi[i_sample] =
              pkt.samples_[i_sample].links_[i_link].channels_[i_ch];
        }
        unsigned int id{channelID(i_link, i_ch)};
        if (translate_eid_) {
          if (is_ecal_) {
            const auto& detmap{getCondition<ecal::EcalDetectorMap>(
                ecal::EcalDetectorMap::CONDITIONS_OBJECT_NAME)};
            ldmx::EcalElectronicsID eid(id);
            if (not detmap.exists(eid)) continue;
            id = detmap.get(eid).raw();
          } else {
            const auto& detmap{getCondition<hcal::HcalDetectorMap>(
                hcal::HcalDetectorMap::CONDITIONS_OBJECT_NAME)};
            ldmx::HcalElectronicsID eid(id);
            if (not detmap.exists(eid)) continue;
            id = detmap.get(eid).raw();
          }
        }
        digis.addDigi(id, digi);
      }
    }
    n_frames_filled_++;
  }
  info.setDigisFilled(all_good);
 
  event.add(digi_output_name_, digis);
  event.add(info_output_name_, info);
}

References ldmx::HgcrocDigiCollection::addDigi(), ldmx::ECONDSampleInfo::addLink(), channelID(), ecal::EcalDetectorMap::CONDITIONS_OBJECT_NAME, hcal::HcalDetectorMap::CONDITIONS_OBJECT_NAME, digi_output_name_, framework::Event::exists(), framework::EventProcessor::getCondition(), info_output_name_, is_ecal_, n_bad_frame_size_, n_frame_flags_, n_frames_, n_frames_filled_, n_l1a_jumps_, n_links_, n_links_bad_stat_, n_no_frame_, n_packet_flags_, n_packets_, n_packets_corrupt_, n_packets_decoded_, n_packets_empty_, packet_, raw_data_name_, raw_data_pass_, roc_version_, ldmx::ECONDLinkInfo::set(), ldmx::ECONDSampleInfo::setCaptureHeader(), ldmx::ECONDSampleInfo::setCorruption(), ldmx::ECONDSampleInfo::setHeader(), ldmx::HgcrocDigiCollection::setNumSamplesPerDigi(), ldmx::HgcrocDigiCollection::setSampleOfInterestIndex(), ldmx::HgcrocDigiCollection::setVersion(), and translate_eid_.

Member Data Documentation

◆ digi_output_name_

std::string packing::ECONDDecoder::digi_output_name_

private

output name of digi collection

Definition at line 65 of file ECONDDecoder.h.

Referenced by configure(), and produce().

◆ fiber_

int packing::ECONDDecoder::fiber_ {0}

private

optical fiber index used in the electronics ID

Definition at line 76 of file ECONDDecoder.h.

76{0};

Referenced by channelID(), and configure().

◆ info_output_name_

std::string packing::ECONDDecoder::info_output_name_

private

output name of supporting data object

Definition at line 67 of file ECONDDecoder.h.

Referenced by configure(), and produce().

◆ is_ecal_

bool packing::ECONDDecoder::is_ecal_ {false}

private

which calorimeter subsystem we are decoding (true == Ecal, false == Hcal)

Definition at line 72 of file ECONDDecoder.h.

72{false};

Referenced by channelID(), configure(), and produce().

◆ n_bad_frame_size_

long packing::ECONDDecoder::n_bad_frame_size_ {0}

private

number of frames with a size that is not a multiple of 4 bytes

Definition at line 92 of file ECONDDecoder.h.

92{0};

Referenced by onProcessEnd(), and produce().

◆ n_frame_flags_

std::array<long, MultiSampleECONDEventPacket::N_CORRUPTION> packing::ECONDDecoder::n_frame_flags_ {}

private

number of frames with each frame-level flag

Definition at line 94 of file ECONDDecoder.h.

94{};

Referenced by onProcessEnd(), and produce().

◆ n_frames_

long packing::ECONDDecoder::n_frames_ {0}

private

number of frames seen

Definition at line 86 of file ECONDDecoder.h.

86{0};

Referenced by onProcessEnd(), and produce().

◆ n_frames_filled_

long packing::ECONDDecoder::n_frames_filled_ {0}

private

number of frames whose digis were filled

Definition at line 90 of file ECONDDecoder.h.

90{0};

Referenced by onProcessEnd(), and produce().

◆ n_l1a_jumps_

long packing::ECONDDecoder::n_l1a_jumps_ {0}

private

number of L1A jumps between consecutive samples

Definition at line 108 of file ECONDDecoder.h.

108{0};

Referenced by onProcessEnd(), and produce().

◆ n_links_

int packing::ECONDDecoder::n_links_ {2}

private

number of enabled eRx on the ECON-D

Definition at line 74 of file ECONDDecoder.h.

74{2};

Referenced by configure(), and produce().

◆ n_links_bad_stat_

long packing::ECONDDecoder::n_links_bad_stat_ {0}

private

number of decoded link sub-packets with bad Stat bits

Definition at line 106 of file ECONDDecoder.h.

106{0};

Referenced by onProcessEnd(), and produce().

◆ n_no_frame_

long packing::ECONDDecoder::n_no_frame_ {0}

private

number of events without an input frame

Definition at line 88 of file ECONDDecoder.h.

88{0};

Referenced by onProcessEnd(), and produce().

◆ n_packet_flags_

std::array<long, ECONDEventPacket::N_CORRUPTION> packing::ECONDDecoder::n_packet_flags_ {}

private

number of packets with each corruption flag

Definition at line 104 of file ECONDDecoder.h.

104{};

Referenced by onProcessEnd(), and produce().

◆ n_packets_

long packing::ECONDDecoder::n_packets_ {0}

private

number of packets seen

Definition at line 96 of file ECONDDecoder.h.

96{0};

Referenced by onProcessEnd(), and produce().

◆ n_packets_corrupt_

long packing::ECONDDecoder::n_packets_corrupt_ {0}

private

number of corrupted packets (skipped)

Definition at line 102 of file ECONDDecoder.h.

102{0};

Referenced by onProcessEnd(), and produce().

◆ n_packets_decoded_

long packing::ECONDDecoder::n_packets_decoded_ {0}

private

number of packets decoded without corruption and not empty

Definition at line 98 of file ECONDDecoder.h.

98{0};

Referenced by onProcessEnd(), and produce().

◆ n_packets_empty_

long packing::ECONDDecoder::n_packets_empty_ {0}

private

number of empty packets (payload length 0)

Definition at line 100 of file ECONDDecoder.h.

100{0};

Referenced by onProcessEnd(), and produce().

◆ packet_

std::unique_ptr<MultiSampleECONDEventPacket> packing::ECONDDecoder::packet_

private

decoding buffer

Definition at line 83 of file ECONDDecoder.h.

Referenced by configure(), and produce().

◆ raw_data_name_

std::string packing::ECONDDecoder::raw_data_name_

private

name of event object of raw binary data

Definition at line 61 of file ECONDDecoder.h.

Referenced by configure(), onProcessEnd(), and produce().

◆ raw_data_pass_

std::string packing::ECONDDecoder::raw_data_pass_

private

name of pass to get raw binary data from

Definition at line 63 of file ECONDDecoder.h.

Referenced by configure(), and produce().

◆ roc_version_

int packing::ECONDDecoder::roc_version_ {3}

private

ROC version for the digi collection.

Definition at line 80 of file ECONDDecoder.h.

80{3};

Referenced by configure(), and produce().

◆ translate_eid_

bool packing::ECONDDecoder::translate_eid_ {false}

private

translate electronics IDs into detector IDs

Definition at line 78 of file ECONDDecoder.h.

78{false};

Referenced by configure(), and produce().

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

Packing/include/Packing/ECONDDecoder.h
Packing/src/Packing/ECONDDecoder.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ECONDDecoder()

Member Function Documentation

◆ channelID()

◆ configure()

◆ onProcessEnd()

◆ produce()

Member Data Documentation

◆ digi_output_name_

◆ fiber_

◆ info_output_name_

◆ is_ecal_

◆ n_bad_frame_size_

◆ n_frame_flags_

◆ n_frames_

◆ n_frames_filled_

◆ n_l1a_jumps_

◆ n_links_

◆ n_links_bad_stat_

◆ n_no_frame_

◆ n_packet_flags_

◆ n_packets_

◆ n_packets_corrupt_

◆ n_packets_decoded_

◆ n_packets_empty_

◆ packet_

◆ raw_data_name_

◆ raw_data_pass_

◆ roc_version_

◆ translate_eid_