LDMX Software
packing::FiberTrackerRawDecoder Class Reference

Public Member Functions

 FiberTrackerRawDecoder (const std::string &name, framework::Process &process)
 
virtual void configure (framework::config::Parameters &) final override
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
virtual void onProcessStart () final override
 Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
 
virtual void produce (framework::Event &event) final override
 Process the event and put new data products into it.
 
- 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 onProcessEnd ()
 Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
 
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 Attributes

std::string input_file_
 input file
 
std::string output_name_
 output object to put onto event bus
 
bool ntuplize_
 should we ntuplize?
 
packing::utility::Reader file_reader_
 the file reader (if we are doing that)
 
FiberTrackerBinaryPacket spill_packet_
 packet being used for decoding
 
FiberTrackerEvent ft_event_
 Current Event.
 
TTree * tree_
 ntuple tree
 
TTree * spill_tree_
 

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
 
NtupleManagerntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger the_log_
 The logger for this EventProcessor.
 

Detailed Description

Definition at line 355 of file FiberTrackerRawDecoder.cxx.

Constructor & Destructor Documentation

◆ FiberTrackerRawDecoder()

packing::FiberTrackerRawDecoder::FiberTrackerRawDecoder ( const std::string & name,
framework::Process & process )
inline

Definition at line 357 of file FiberTrackerRawDecoder.cxx.

358 : framework::Producer(name, process) {}
Base class for a module which produces a data product.
virtual void process(Event &event) final
Processing an event for a Producer is calling produce.

Member Function Documentation

◆ configure()

void packing::FiberTrackerRawDecoder::configure ( framework::config::Parameters & parameters)
finaloverridevirtual

Callback for the EventProcessor to configure itself from the given set of parameters.

The parameters a processor has access to are the member variables of the python class in the sequence that has className equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters
parametersParameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 383 of file FiberTrackerRawDecoder.cxx.

383 {
384 input_file_ = ps.get<std::string>("input_file");
385 output_name_ = ps.get<std::string>("output_name");
386 ntuplize_ = ps.get<bool>("ntuplize");
387
389}
std::string output_name_
output object to put onto event bus
packing::utility::Reader file_reader_
the file reader (if we are doing that)
void open(const std::string &file_name)
Open a file with this reader.
Definition Reader.h:35

References file_reader_, framework::config::Parameters::get(), input_file_, ntuplize_, packing::utility::Reader::open(), and output_name_.

◆ onProcessStart()

void packing::FiberTrackerRawDecoder::onProcessStart ( )
finaloverridevirtual

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

Reimplemented from framework::EventProcessor.

Definition at line 391 of file FiberTrackerRawDecoder.cxx.

391 {
392 if (ntuplize_) {
394 tree_ = new TTree("raw", "Flattened and decoded raw FiberTracker data");
395 tree_->Branch("TriggerTSLSB", &ft_event_.trigger_timestamp_lsb_);
396 tree_->Branch("TriggerTSMSB", &ft_event_.trigger_timestamp_msb_);
397 tree_->Branch("EventTSLSB", &ft_event_.event_timestamp_lsb_);
398 tree_->Branch("EventTSMSB", &ft_event_.event_timestamp_msb_);
399 tree_->Branch("ChannelHits", &ft_event_.channel_hits_);
400
401 spill_tree_ = new TTree("spill", "Spill Meta-Data from FiberTrackerDAQ");
402 spill_tree_->Branch("acqMode", &spill_packet_.acq_mode_);
403 spill_tree_->Branch("acqStamp", &spill_packet_.acq_stamp_);
404 spill_tree_->Branch("acqType", &spill_packet_.acq_type_);
405 spill_tree_->Branch("acqTypeAllowed", &spill_packet_.acq_type_allowed_);
406 spill_tree_->Branch("counts", &spill_packet_.counts_);
407 spill_tree_->Branch("countsRecords", &spill_packet_.counts_records_);
408 spill_tree_->Branch("countsRecordsWithZeroEvents",
409 &spill_packet_.counts_records_with_zero_events_);
410 spill_tree_->Branch("countsTrigs", &spill_packet_.counts_trigs_);
411 spill_tree_->Branch("cycleStamp", &spill_packet_.cycle_stamp_);
412 spill_tree_->Branch("eventSelectionAcq",
413 &spill_packet_.event_selection_acq_);
414 spill_tree_->Branch("meanSNew", &spill_packet_.mean_s_new_);
415 spill_tree_->Branch("profile", &spill_packet_.profile_);
416 spill_tree_->Branch("profileStandAlone",
417 &spill_packet_.profile_stand_alone_);
418 spill_tree_->Branch("trigger", &spill_packet_.trigger_);
419 spill_tree_->Branch("triggerOffsetAcq", &spill_packet_.trigger_offset_acq_);
420 spill_tree_->Branch("triggerSelectionAcq",
421 &spill_packet_.trigger_selection_acq_);
422 }
423}
TDirectory * getHistoDirectory()
Access/create a directory in the histogram file for this event processor to create histograms and ana...
FiberTrackerEvent ft_event_
Current Event.
FiberTrackerBinaryPacket spill_packet_
packet being used for decoding

References ft_event_, framework::EventProcessor::getHistoDirectory(), ntuplize_, spill_packet_, and tree_.

◆ produce()

void packing::FiberTrackerRawDecoder::produce ( framework::Event & event)
finaloverridevirtual

Process the event and put new data products into it.

Parameters
eventThe Event to process.

Implements framework::Producer.

Definition at line 425 of file FiberTrackerRawDecoder.cxx.

425 {
426 // only add and fill when file able to readout packet
427 if (not spill_packet_.next(ft_event_)) {
428 // no more events in this spill
430 spill_tree_->Fill();
431 // next spill loaded, pop its first event
433 } else {
434#ifdef DEBUG
435 std::cout << "no more events" << std::endl;
436#endif
437 return;
438 }
439 }
440 tree_->Fill();
441
442 event.add(output_name_ + "TriggerTSLSB", ft_event_.trigger_timestamp_lsb_);
443 event.add(output_name_ + "TriggerTSMSB", ft_event_.trigger_timestamp_msb_);
444 event.add(output_name_ + "EventTSLSB", ft_event_.event_timestamp_lsb_);
445 event.add(output_name_ + "EventTSMSB", ft_event_.event_timestamp_msb_);
446 event.add(output_name_ + "Hits", ft_event_.channel_hits_);
447 return;
448} // produce

References file_reader_, ft_event_, output_name_, spill_packet_, and tree_.

Member Data Documentation

◆ file_reader_

packing::utility::Reader packing::FiberTrackerRawDecoder::file_reader_
private

the file reader (if we are doing that)

Definition at line 374 of file FiberTrackerRawDecoder.cxx.

Referenced by configure(), and produce().

◆ ft_event_

FiberTrackerEvent packing::FiberTrackerRawDecoder::ft_event_
private

Current Event.

Definition at line 378 of file FiberTrackerRawDecoder.cxx.

Referenced by onProcessStart(), and produce().

◆ input_file_

std::string packing::FiberTrackerRawDecoder::input_file_
private

input file

Definition at line 366 of file FiberTrackerRawDecoder.cxx.

Referenced by configure().

◆ ntuplize_

bool packing::FiberTrackerRawDecoder::ntuplize_
private

should we ntuplize?

Definition at line 370 of file FiberTrackerRawDecoder.cxx.

Referenced by configure(), and onProcessStart().

◆ output_name_

std::string packing::FiberTrackerRawDecoder::output_name_
private

output object to put onto event bus

Definition at line 368 of file FiberTrackerRawDecoder.cxx.

Referenced by configure(), and produce().

◆ spill_packet_

FiberTrackerBinaryPacket packing::FiberTrackerRawDecoder::spill_packet_
private

packet being used for decoding

Definition at line 376 of file FiberTrackerRawDecoder.cxx.

Referenced by onProcessStart(), and produce().

◆ spill_tree_

TTree * packing::FiberTrackerRawDecoder::spill_tree_
private

Definition at line 380 of file FiberTrackerRawDecoder.cxx.

◆ tree_

TTree* packing::FiberTrackerRawDecoder::tree_
private

ntuple tree

Definition at line 380 of file FiberTrackerRawDecoder.cxx.

Referenced by onProcessStart(), and produce().


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