Write trigger scintillator cluster triplets to a text file. More...

#include <ClusterTripletMaker.h>

Public Member Functions
	ClusterTripletMaker (const std::string &name, framework::Process &process)

void	configure (framework::config::Parameters &ps) override
	Callback for the EventProcessor to configure itself from the given set of parameters.

void	analyze (const framework::Event &event) override
	Process the event and make histograms or summaries.

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

void	onProcessEnd () override
	Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

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

virtual void	process (Event &event) final
	Processing an event for an Analyzer is calling analyze.

virtual void	beforeNewRun (ldmx::RunHeader &run_header) final
	Don't allow Analyzers to add parameters to the run header.

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	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.

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
int	verbose_ {0}

std::string	pass_name_ {""}

std::vector< std::string >	cluster_input_collections_

std::string	output_file_ {"clusters.txt"}

std::ofstream	output_stream_

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

Write trigger scintillator cluster triplets to a text file.

Definition at line 28 of file ClusterTripletMaker.h.

Constructor & Destructor Documentation

◆ ClusterTripletMaker()

tools::ClusterTripletMaker::ClusterTripletMaker	(	const std::string &	name,
		framework::Process &	process )

Definition at line 7 of file ClusterTripletMaker.cxx.

9 : Analyzer(name, process) {}

framework::Analyzer::process

virtual void process(Event &event) final

Processing an event for an Analyzer is calling analyze.

Definition EventProcessor.h:316

framework::Analyzer::Analyzer

Analyzer(const std::string &name, Process &process)

Class constructor.

Definition EventProcessor.cxx:57

Member Function Documentation

◆ analyze()

void tools::ClusterTripletMaker::analyze ( const framework::Event & event )

overridevirtual

Process the event and make histograms or summaries.

Parameters

event The Event to analyze

Implements framework::Analyzer.

Definition at line 42 of file ClusterTripletMaker.cxx.

                                                             {
  const auto clusters_pad1{event.getCollection<ldmx::TrigScintCluster>(
      cluster_input_collections_.at(0), pass_name_)};
  const auto clusters_pad2{event.getCollection<ldmx::TrigScintCluster>(
      cluster_input_collections_.at(1), pass_name_)};
  const auto clusters_pad3{event.getCollection<ldmx::TrigScintCluster>(
      cluster_input_collections_.at(2), pass_name_)};
 
  const size_t num_clusters = std::min( //in the event of multiple clusters in 
      {clusters_pad1.size(),   //one pad in one event, select that with the lowest
      clusters_pad2.size(),   //centroid value for simplicity (not always accurate
      clusters_pad3.size()}); //unfortunately)
 
  ldmx_log(debug) << "Event " << event.getEventNumber() << " has " << clusters_pad1.size() 
                  << ", " << clusters_pad2.size() << ", " << clusters_pad3.size()
                  << " clusters in pads 1, 2, and 3.";
  
  for (size_t cluster_index = 0; cluster_index < num_clusters; ++cluster_index) {
    const int event_number = event.getEventNumber();
    const float pad1_centroid = clusters_pad1.at(cluster_index).getCentroid();
    const float pad2_centroid = clusters_pad2.at(cluster_index).getCentroid();
    const float pad3_centroid = clusters_pad3.at(cluster_index).getCentroid();
    
    //write to output file 
    output_stream_ << event_number << " " << pad1_centroid << " "
                   << pad2_centroid << " " << pad3_centroid << " " << "\n";
  }
 
  if (verbose_) {
    for (size_t cluster_index = 1; cluster_index < clusters_pad1.size();
         ++cluster_index) {
      ldmx_log(info) << "Event " << event.getEventNumber()
                     << ", extra cluster in pad 1: "
                     << clusters_pad1.at(cluster_index).getCentroid();
    }
 
    for (size_t cluster_index = 1; cluster_index < clusters_pad2.size();
         ++cluster_index) {
      ldmx_log(info) << "Event " << event.getEventNumber()
                     << ", extra cluster in pad 2: "
                     << clusters_pad2.at(cluster_index).getCentroid();
    }
 
    for (size_t cluster_index = 1; cluster_index < clusters_pad3.size();
         ++cluster_index) {
      ldmx_log(info) << "Event " << event.getEventNumber()
                     << ", extra cluster in pad 3: "
                     << clusters_pad3.at(cluster_index).getCentroid();
    }
  }
  return;
}

◆ configure()

void tools::ClusterTripletMaker::configure ( framework::config::Parameters & parameters )

overridevirtual

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 class_name equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 11 of file ClusterTripletMaker.cxx.

                                                                 {
  pass_name_ = ps.get<std::string>("pass_name");
  cluster_input_collections_ =
      ps.get<std::vector<std::string>>("cluster_input_collections");
  output_file_ = ps.get<std::string>("output_file");
  verbose_ = ps.get<int>("verbosity");
 
  if (verbose_) {
    ldmx_log(info) << "In ClusterTripletMaker: configure done!"
                   << "\nInput collection 1: "
                   << cluster_input_collections_.at(0)
                   << "\nInput collection 2: "
                   << cluster_input_collections_.at(1)
                   << "\nInput collection 3: "
                   << cluster_input_collections_.at(2)
                   << "\nPass name: " << pass_name_
                   << "\nOutput file: " << output_file_
                   << "\nVerbosity: " << verbose_;
  }
  return;
}

References framework::config::Parameters::get().

◆ onProcessEnd()

void tools::ClusterTripletMaker::onProcessEnd ( )

overridevirtual

Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.

Reimplemented from framework::EventProcessor.

Definition at line 95 of file ClusterTripletMaker.cxx.

                                       {
  if (output_stream_.is_open()) {
    output_stream_.close();
  }
 
  if (verbose_) {
    ldmx_log(info) << "Closed output file " << output_file_;
  }
  return;
}

◆ onProcessStart()

void tools::ClusterTripletMaker::onProcessStart ( )

overridevirtual

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 33 of file ClusterTripletMaker.cxx.

                                         {
  output_stream_.open(output_file_);
 
  if (verbose_) {
    ldmx_log(info) << "Opened output file " << output_file_;
  }
  return;
}

Member Data Documentation

◆ cluster_input_collections_

std::vector<std::string> tools::ClusterTripletMaker::cluster_input_collections_

private

Definition at line 50 of file ClusterTripletMaker.h.

◆ output_file_

std::string tools::ClusterTripletMaker::output_file_ {"clusters.txt"}

private

Definition at line 53 of file ClusterTripletMaker.h.

53{"clusters.txt"};

◆ output_stream_

std::ofstream tools::ClusterTripletMaker::output_stream_

private

Definition at line 56 of file ClusterTripletMaker.h.

◆ pass_name_

std::string tools::ClusterTripletMaker::pass_name_ {""}

private

Definition at line 47 of file ClusterTripletMaker.h.

47{""};

◆ verbose_

int tools::ClusterTripletMaker::verbose_ {0}

private

Definition at line 44 of file ClusterTripletMaker.h.

44{0};

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

Tools/include/Tools/ClusterTripletMaker.h
Tools/src/Tools/ClusterTripletMaker.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClusterTripletMaker()

Member Function Documentation

◆ analyze()

◆ configure()

◆ onProcessEnd()

◆ onProcessStart()

Member Data Documentation

◆ cluster_input_collections_

◆ output_file_

◆ output_stream_

◆ pass_name_

◆ verbose_