packing::WRRawDecoder Class Reference

Public Member Functions
	WRRawDecoder (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 &runHeader)
	Callback for Producers to add parameters to the run header before conditions are initialized.
virtual void	onNewRun (const ldmx::RunHeader &runHeader)
	Callback for the EventProcessor to take any necessary action when the run being processed changes.
virtual void	onFileOpen (EventFile &eventFile)
	Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
virtual void	onFileClose (EventFile &eventFile)
	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)
WRBinaryPacket	p
	packet being used for decoding
TTree *	tree_
	ntuple tree

Additional Inherited Members
Protected Member Functions inherited from framework::EventProcessor
void	abortEvent ()
	Abort the event immediately.
Protected Attributes inherited from framework::EventProcessor
HistogramHelper	histograms_
	Interface class for making and filling histograms.
NtupleManager &	ntuple_ {NtupleManager::getInstance()}
	Manager for any ntuples.
logging::logger	theLog_
	The logger for this EventProcessor.

Detailed Description

Definition at line 48 of file WRRawDecoder.cxx.

Constructor & Destructor Documentation

WRRawDecoder()

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

inline

Definition at line 50 of file WRRawDecoder.cxx.

      : framework::Producer(name, process) {}

Member Function Documentation

configure()

void packing::WRRawDecoder::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

parameters

Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 74 of file WRRawDecoder.cxx.

                                                          {
  input_file_ = ps.getParameter<std::string>("input_file");
  output_name_ = ps.getParameter<std::string>("output_name");
  ntuplize_ = ps.getParameter<bool>("ntuplize");
 
  file_reader_.open(input_file_);
}

References file_reader_, input_file_, ntuplize_, packing::utility::Reader::open(), and output_name_.

onProcessStart()

void packing::WRRawDecoder::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 82 of file WRRawDecoder.cxx.

                                  {
  if (ntuplize_) {
    getHistoDirectory();
    tree_ = new TTree("wrraw", "Flattened and decoded raw WR data");
    tree_->Branch("run", &p.runNumber);
    tree_->Branch("counter", &p.WRCounter);
    tree_->Branch("channel", &p.channel);
    tree_->Branch("seq_id", &p.seq_id);
    tree_->Branch("sec", &p.sec);
    tree_->Branch("coarse", &p.coarse);
    tree_->Branch("frac", &p.frac);
  }
}

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

produce()

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

finaloverridevirtual

Process the event and put new data products into it.

Parameters

event

The Event to process.

Implements framework::Producer.

Definition at line 96 of file WRRawDecoder.cxx.

                                                {
  // only add and fill when file able to readout packet
  if (file_reader_ >> p) {
    p.add(event, output_name_);
    tree_->Fill();
#ifdef DEBUG
    std::cout << p << std::endl;
#endif
  }
#ifdef DEBUG
  else {
    std::cout << "no more events" << std::endl;
  }
#endif
  return;
}  // produce

References file_reader_, output_name_, p, and tree_.

Member Data Documentation

file_reader_

packing::utility::Reader packing::WRRawDecoder::file_reader_

private

the file reader (if we are doing that)

Definition at line 67 of file WRRawDecoder.cxx.

Referenced by configure(), and produce().

input_file_

std::string packing::WRRawDecoder::input_file_

private

input file

Definition at line 59 of file WRRawDecoder.cxx.

Referenced by configure().

ntuplize_

bool packing::WRRawDecoder::ntuplize_

private

should we ntuplize?

Definition at line 63 of file WRRawDecoder.cxx.

Referenced by configure(), and onProcessStart().

output_name_

std::string packing::WRRawDecoder::output_name_

private

output object to put onto event bus

Definition at line 61 of file WRRawDecoder.cxx.

Referenced by configure(), and produce().

p

WRBinaryPacket packing::WRRawDecoder::p

private

packet being used for decoding

Definition at line 69 of file WRRawDecoder.cxx.

Referenced by onProcessStart(), and produce().

tree_

TTree* packing::WRRawDecoder::tree_

private

ntuple tree

Definition at line 71 of file WRRawDecoder.cxx.

Referenced by onProcessStart(), and produce().

---

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

• Packing/src/Packing/WRRawDecoder.cxx