The raw data file object. More...

#include <File.h>

Public Member Functions
	File (const framework::config::Parameters &params)
	General file constructor.

bool	connect (framework::Event &event)
	Connect the passed event bus to this event file.

bool	nextEvent ()
	Load the next event into our connected event bus.

void	writeRunHeader (ldmx::RunHeader &header)
	Write the run header.

void	close ()
	close this file

Private Attributes
bool	is_output_
	are we reading or writing?

std::string	ecal_object_name_
	the event bus object name of the ECal encoded data

std::string	hcal_object_name_
	the event bus object name of the HCal encoded data

std::string	tracker_object_name_
	the event bus object name of the Tracker encoded data

std::string	triggerpad_object_name_
	the event bus object name of the Trigger Pad encoded data

std::string	pass_name_
	for writing, we also should be able to specify a pass name

bool	skip_unavailable_
	for writing, do we skip subsystems if their raw object is unavailable

uint32_t	entries_ {0}
	number of entries in the file

uint32_t	i_entry_ {0}
	current entry index (may not be same as event number)

framework::Event *	event_ {nullptr}
	handle to the event bus we are reading from or writing to

uint32_t	run_
	run number corresponding to this file of raw data

utility::Reader	reader_
	utility class for reading binary data files

utility::Writer	writer_
	utility class for writing binary data files

utility::CRC	crc_
	crc calculator for output mode

Detailed Description

The raw data file object.

Definition at line 17 of file File.h.

Constructor & Destructor Documentation

◆ File()

packing::rawdatafile::File::File ( const framework::config::Parameters & params )

General file constructor.

Parameters

[in]	params	parameters use to configure this file
[in]	filename	name of the file to read/write

Definition at line 11 of file File.cxx.

                                              {
  is_output_ = ps.getParameter<bool>("is_output");
  skip_unavailable_ = ps.getParameter<bool>("skip_unavailable");
 
  std::string fn = ps.getParameter<std::string>("filename");
 
  ecal_object_name_ = ps.getParameter<std::string>("ecal_object_name");
  hcal_object_name_ = ps.getParameter<std::string>("hcal_object_name");
  tracker_object_name_ = ps.getParameter<std::string>("tracker_object_name");
  triggerpad_object_name_ =
      ps.getParameter<std::string>("triggerpad_object_name");
  pass_name_ = ps.getParameter<std::string>("pass_name");
 
  std::cerr << "creating file" << std::endl;
  if (is_output_) {
    writer_.open(fn);
    // leave entry count undefined
    entries_ = 0;
    i_entry_ = 0;
  } else {
    reader_.open(fn);
    // get entry count from file
    // get run id number from file
    uint32_t word;
    reader_ >> word;
 
    uint8_t version = word & utility::mask<4>;
    if (version != 0) {
      EXCEPTION_RAISE("RawFileVers", "Unable to handle raw file version " +
                                         std::to_string(version));
    }
 
    run_ = ((word >> 4) & utility::mask<28>);
 
    reader_.seek<uint32_t>(-2, std::ios::end);
    // save EOF in number of 32-bit-width words
    auto eof{reader_.tell<uint32_t>()};
    uint32_t crc_read_in;
    reader_ >> entries_ >> crc_read_in;
    i_entry_ = 0;
 
    reader_.seek<uint32_t>(1, std::ios::beg);
 
    if (ps.getParameter<bool>("verify_checksum")) {
      utility::CRC crc;
      for (auto ifile{reader_.tell<uint32_t>()}; ifile < eof; ifile++) {
        reader_ >> word;
        crc << word;
      }
 
      if (crc.get() != crc_read_in) {
        EXCEPTION_RAISE("CRCNotOk",
                        "Failure to verify CRC checksum of entire input file.");
      }
 
      reader_.seek<uint32_t>(1, std::ios::beg);
    }  // verify checksum of input file
  }    // input or output file
}

References ecal_object_name_, entries_, packing::utility::CRC::get(), framework::config::Parameters::getParameter(), hcal_object_name_, i_entry_, is_output_, packing::utility::Reader::open(), packing::utility::Writer::open(), pass_name_, reader_, run_, packing::utility::Reader::seek(), skip_unavailable_, packing::utility::Reader::tell(), tracker_object_name_, triggerpad_object_name_, and writer_.

Member Function Documentation

◆ close()

void packing::rawdatafile::File::close ( )

close this file

Definition at line 144 of file File.cxx.

                 {
  event_ = nullptr;
  if (is_output_) {
    writer_ << entries_;
    crc_ << entries_;
    writer_ << crc_.get();
  }
}

References crc_, entries_, event_, packing::utility::CRC::get(), is_output_, and writer_.

◆ connect()

bool packing::rawdatafile::File::connect ( framework::Event & event )

Connect the passed event bus to this event file.

Definition at line 71 of file File.cxx.

                                        {
  event_ = &event;
  return true;
}

References event_.

◆ nextEvent()

bool packing::rawdatafile::File::nextEvent ( )

Load the next event into our connected event bus.

Definition at line 76 of file File.cxx.

                     {
  static std::map<uint16_t, std::string> eid_to_name = {
      {ldmx::SubdetectorIDType::EID_TRACKER, tracker_object_name_},
      {ldmx::SubdetectorIDType::EID_TRIGGER_SCINT, triggerpad_object_name_},
      {ldmx::SubdetectorIDType::EID_ECAL, ecal_object_name_},
      {ldmx::SubdetectorIDType::EID_HCAL, hcal_object_name_},
  };
 
  if (is_output_) {
    // dump buffers into event packet and write out
    std::map<uint16_t, std::vector<uint32_t>> the_subsys_data;
    for (auto const &[id, name] : eid_to_name) {
      if (skip_unavailable_ and not event_->exists(name, pass_name_)) continue;
      the_subsys_data[id] = event_->getCollection<uint32_t>(name, pass_name_);
    }
 
    EventPacket write_event(event_->getEventNumber(), the_subsys_data);
    writer_ << write_event;
    crc_ << write_event;
    if (!writer_) return false;
 
    entries_++;
    i_entry_++;
  } else {
    // check for EoF
    if (i_entry_ + 1 > entries_) return false;
 
    i_entry_++;
 
    // read buffers from event packet and add to event bus
    static EventPacket read_event;
    reader_ >> read_event;
    if (!reader_) {
      // ERROR
      return false;
    }
 
    event_->getEventHeader().setEventNumber(read_event.id());
 
    for (auto &subsys : read_event.data()) {
      // construct name if not provided by default EID mappings
      if (eid_to_name.find(subsys.id()) == eid_to_name.end()) {
        std::cerr << subsys.id() << " unrecognized electronics ID."
                  << std::endl;
        eid_to_name[subsys.id()] = "EID" + std::to_string(subsys.id());
      }
 
      event_->add(eid_to_name.at(subsys.id()), subsys.data());
    }  // loop over subsystems
  }    // input or output
  return true;
}

References framework::Event::add(), crc_, ecal_object_name_, entries_, event_, framework::Event::exists(), framework::Event::getCollection(), framework::Event::getEventHeader(), framework::Event::getEventNumber(), hcal_object_name_, i_entry_, is_output_, pass_name_, reader_, ldmx::EventHeader::setEventNumber(), skip_unavailable_, tracker_object_name_, triggerpad_object_name_, and writer_.

◆ writeRunHeader()

void packing::rawdatafile::File::writeRunHeader ( ldmx::RunHeader & header )

Write the run header.

Definition at line 129 of file File.cxx.

                                               {
  if (is_output_) {
    // use passed run number
    run_ = header.getRunNumber();
    // Why cant we just take the header from above?
    uint32_t tempHeader =
        (0 & utility::mask<4>)+((run_ & utility::mask<28>) << 4);
    writer_ << tempHeader;
    crc_ << tempHeader;
  } else {
    // put our read-in run number here
    header.setIntParameter("raw_run", run_);
  }
}

References crc_, ldmx::RunHeader::getRunNumber(), is_output_, run_, ldmx::RunHeader::setIntParameter(), and writer_.

Member Data Documentation

◆ crc_

utility::CRC packing::rawdatafile::File::crc_

private

crc calculator for output mode

Definition at line 75 of file File.h.

Referenced by close(), nextEvent(), and writeRunHeader().

◆ ecal_object_name_

std::string packing::rawdatafile::File::ecal_object_name_

private

the event bus object name of the ECal encoded data

Definition at line 49 of file File.h.

Referenced by File(), and nextEvent().

◆ entries_

uint32_t packing::rawdatafile::File::entries_ {0}

private

number of entries in the file

Definition at line 63 of file File.h.

63{0};

Referenced by close(), File(), and nextEvent().

◆ event_

framework::Event* packing::rawdatafile::File::event_ {nullptr}

private

handle to the event bus we are reading from or writing to

Definition at line 67 of file File.h.

67{nullptr};

Referenced by close(), connect(), and nextEvent().

◆ hcal_object_name_

std::string packing::rawdatafile::File::hcal_object_name_

private

the event bus object name of the HCal encoded data

Definition at line 51 of file File.h.

Referenced by File(), and nextEvent().

◆ i_entry_

uint32_t packing::rawdatafile::File::i_entry_ {0}

private

current entry index (may not be same as event number)

Definition at line 65 of file File.h.

65{0};

Referenced by File(), and nextEvent().

◆ is_output_

bool packing::rawdatafile::File::is_output_

private

are we reading or writing?

Definition at line 47 of file File.h.

Referenced by close(), File(), nextEvent(), and writeRunHeader().

◆ pass_name_

std::string packing::rawdatafile::File::pass_name_

private

for writing, we also should be able to specify a pass name

Definition at line 57 of file File.h.

Referenced by File(), and nextEvent().

◆ reader_

utility::Reader packing::rawdatafile::File::reader_

private

utility class for reading binary data files

Definition at line 71 of file File.h.

Referenced by File(), and nextEvent().

◆ run_

uint32_t packing::rawdatafile::File::run_

private

run number corresponding to this file of raw data

Definition at line 69 of file File.h.

Referenced by File(), and writeRunHeader().

◆ skip_unavailable_

bool packing::rawdatafile::File::skip_unavailable_

private

for writing, do we skip subsystems if their raw object is unavailable

Definition at line 59 of file File.h.

Referenced by File(), and nextEvent().

◆ tracker_object_name_

std::string packing::rawdatafile::File::tracker_object_name_

private

the event bus object name of the Tracker encoded data

Definition at line 53 of file File.h.

Referenced by File(), and nextEvent().

◆ triggerpad_object_name_

std::string packing::rawdatafile::File::triggerpad_object_name_

private

the event bus object name of the Trigger Pad encoded data

Definition at line 55 of file File.h.

Referenced by File(), and nextEvent().

◆ writer_

utility::Writer packing::rawdatafile::File::writer_

private

utility class for writing binary data files

Definition at line 73 of file File.h.

Referenced by close(), File(), nextEvent(), and writeRunHeader().

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

Packing/include/Packing/RawDataFile/File.h
Packing/src/Packing/RawDataFile/File.cxx

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ File()

Member Function Documentation

◆ close()

◆ connect()

◆ nextEvent()

◆ writeRunHeader()

Member Data Documentation

◆ crc_

◆ ecal_object_name_

◆ entries_

◆ event_

◆ hcal_object_name_

◆ i_entry_

◆ is_output_

◆ pass_name_

◆ reader_

◆ run_

◆ skip_unavailable_

◆ tracker_object_name_

◆ triggerpad_object_name_

◆ writer_