Classes
struct	Line

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

void	configure (framework::config::Parameters &parameters) 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	input_file_

std::string	output_file_

double	lut_threshold_ {0.0008}

std::ifstream	infile_

std::ofstream	outfile_

std::map< std::pair< float, float >, std::vector< Line > >	groups_

int	total_lines_ {0}

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

Definition at line 21 of file PatternLUTMaker.h.

Constructor & Destructor Documentation

◆ PatternLUTMaker()

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

Definition at line 9 of file PatternLUTMaker.cxx.

11 : 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::PatternLUTMaker::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 55 of file PatternLUTMaker.cxx.

55 {

56}

◆ configure()

void tools::PatternLUTMaker::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 13 of file PatternLUTMaker.cxx.

                                                             {
  input_file_ = ps.get<std::string>("input_file");
  output_file_ = ps.get<std::string>("output_file");
  lut_threshold_ = ps.get<double>("lut_threshold");
  verbose_ = ps.get<int>("verbosity");
 
  // The LUT threshold is the minimum percentage of times that a track
  // must appear in a pool of events to be written to the LUT.
  // Example --- horizontal tracks whose pad 1-2 and pad 2-3 delta values
  //             are both 0 make up ~80% of tracks out of 10.000 events,
  //             while a track with deltas (+22,-22), meaning pad 1 cluster in
  //             e.g. bar 4, pad 2 cluster in bar 26, and pad 3 cluster in bar 4
  //             only appears once in 10.000 events (0.01%). The straight
  //             tracks are written to the LUT and the single "anomaly" is not.
  // Primary motivation here is for use in the case of an unknown TS
  // misalignment.
 
  ldmx_log(info) << "In PatternLUTMaker: configure done!" << std::endl;
  ldmx_log(info) << "Got parameters: \nInput file:   " << input_file_
                   << "\nOutput file:     " << output_file_
                   << "\nLUT threshold:     " << lut_threshold_
                   << "\nVerbosity:      " << verbose_;
 
  return;
}

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

◆ onProcessEnd()

void tools::PatternLUTMaker::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 58 of file PatternLUTMaker.cxx.

                                   {
  ldmx_log(info) << "total_lines = " << total_lines_;
  ldmx_log(info) << "groups = " << groups_.size();
  int combs = 0; //combs will be the total number of patterns written to the LUT
  int tracks = 0; //and tracks the number of tracks contained within those pattern groups
 
  if (verbose_) {
    ldmx_log(info) << "Total number of cluster combinations: " << total_lines_ << "\n"
                   << "Number of different propagation patterns: " << groups_.size()
                   << "\n" << "LUT Threshold: " << lut_threshold_ * 100 << "%\n";
  }
 
  for (auto& g : groups_) {
    int count = g.second.size();
    double frac = static_cast<double>(count) / total_lines_;
 
    if (verbose_) {
      ldmx_log(debug) << "(" << g.first.first << "," << g.first.second << ") appears "
                      << count << " times, (" << frac * 100 << " %)" << "\n";
    }
 
    if (frac > lut_threshold_) {  // write to outfile_ (LUT file) if over threshold
        combs++;
        for (auto& line : g.second) {
          tracks++;
          outfile_ << line.p1_ << " " << line.p2_ << " " << line.p3_ << "\n";
        }
    }
 
  }
 
  if (verbose_) {
    ldmx_log(info) << "\nLUT textfile written." << "\n" << combs
                   << " combinations (" << tracks << " tracks) written to LUT.\n";
  }
  return;
}

◆ onProcessStart()

void tools::PatternLUTMaker::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 39 of file PatternLUTMaker.cxx.

                                     {
  infile_.open(input_file_);
  outfile_.open(output_file_);
 
  if (total_lines_ > 0) return;
  int ev;
  float p1, p2, p3;
  while (infile_ >> ev >> p1 >> p2 >> p3) {
    float p12 = p2 - p1; //for each cluster combination, calculate vertical propagation
    float p23 = p3 - p2; //between pads 1 and 2 (p12) and between pads 2 and 3 (p23);
    groups_[{p12, p23}].push_back({ev, p1, p2, p3}); //and group by these values
    total_lines_++;                                 //(the "propagation patterns").
  }
  return;
}

Member Data Documentation

◆ groups_

std::map<std::pair<float, float>, std::vector<Line> > tools::PatternLUTMaker::groups_

private

Definition at line 57 of file PatternLUTMaker.h.

◆ infile_

std::ifstream tools::PatternLUTMaker::infile_

private

Definition at line 53 of file PatternLUTMaker.h.

◆ input_file_

std::string tools::PatternLUTMaker::input_file_

private

Definition at line 45 of file PatternLUTMaker.h.

◆ lut_threshold_

double tools::PatternLUTMaker::lut_threshold_ {0.0008}

private

Definition at line 51 of file PatternLUTMaker.h.

51{0.0008};

◆ outfile_

std::ofstream tools::PatternLUTMaker::outfile_

private

Definition at line 54 of file PatternLUTMaker.h.

◆ output_file_

std::string tools::PatternLUTMaker::output_file_

private

Definition at line 48 of file PatternLUTMaker.h.

◆ total_lines_

int tools::PatternLUTMaker::total_lines_ {0}

private

Definition at line 60 of file PatternLUTMaker.h.

60{0};

◆ verbose_

int tools::PatternLUTMaker::verbose_ {0}

private

Definition at line 42 of file PatternLUTMaker.h.

42{0};

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

Tools/include/Tools/PatternLUTMaker.h
Tools/src/Tools/PatternLUTMaker.cxx

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PatternLUTMaker()

Member Function Documentation

◆ analyze()

◆ configure()

◆ onProcessEnd()

◆ onProcessStart()

Member Data Documentation

◆ groups_

◆ infile_

◆ input_file_

◆ lut_threshold_

◆ outfile_

◆ output_file_

◆ total_lines_

◆ verbose_