Electron counting processor. More...

#include <BeamElectronLocator.h>

Public Member Functions
	BeamElectronLocator (const std::string &name, framework::Process &process)
	Constructor.

virtual	~BeamElectronLocator ()
	Destructor.

void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.

void	onProcessStart () override
	Prints the configuration to log in debug mode.

void	produce (framework::Event &event) 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 Member Functions
int	bin (float coordinate, double binWidth, double min, double max)
	Bins coordinates according to some given granularity (passed as argument).

Private Attributes
std::string	input_coll_
	The name of the input collection used for counting electrons.

std::string	input_pass_name_
	The pass name of the input collection used for counting electrons.

std::string	output_coll_
	The name of the output collection used to save some electron counting variables.

double	min_xmm_
	The min value measured by the system (edge) in X, in mm.

double	max_xmm_
	The max value measured by the system (edge) in X, in mm.

double	min_ymm_
	The min value measured by the system (edge) in Y, in mm.

double	max_ymm_
	The max value measured by the system (edge) in Y, in mm.

double	granularity_xmm_
	The granularity of the detector (e.g.

double	granularity_ymm_
	The granularity of the detector (e.g.

double	tolerance_
	The tolerance within which simhits are considered to belong to the same electron.

bool	verbose_ {false}
	Indicate verbose printout to log according to log level.

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

Electron counting processor.

This processor uses calo simhits in e.g. the target to get truth info about beam electrons. The hits associated with beam electrons can already be isolated by the truth hit collection producer. However, the simhits have approximately infinite resolution. This processor's raison d'être is to run some sort of grouping, to ensure we have at most one reconstructed truth information object per electron.

Definition at line 26 of file BeamElectronLocator.h.

Constructor & Destructor Documentation

◆ BeamElectronLocator()

recon::BeamElectronLocator::BeamElectronLocator	(	const std::string &	name,
		framework::Process &	process )

Constructor.

Parameters

name	Name for this instance of the class.
process	The Process class associated with EventProcessor, provided by the framework.

Definition at line 5 of file BeamElectronLocator.cxx.

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

framework::Producer

Base class for a module which produces a data product.

Definition EventProcessor.h:257

framework::Producer::process

virtual void process(Event &event) final

Processing an event for a Producer is calling produce.

Definition EventProcessor.h:278

◆ ~BeamElectronLocator()

recon::BeamElectronLocator::~BeamElectronLocator ( )

virtual

Destructor.

Definition at line 9 of file BeamElectronLocator.cxx.

9{}

Member Function Documentation

◆ bin()

int recon::BeamElectronLocator::bin	(	float	coordinate,
		double	binWidth,
		double	min,
		double	max )

private

Bins coordinates according to some given granularity (passed as argument).

Returns the lower bin edge. -1 for underflow (coordinate < min_in_mm); with a system of N bins, returns n = N if coordinate > max_in_mm.

TODO also implement a function that returns the grid of non-empty hit coordinates, which accounts for that we don't know the multiplicity at a location

Definition at line 103 of file BeamElectronLocator.cxx.

                                         {
  int n = 0;
  while (coordinate > min + n * binWidth) {
    n++;
    if (min + n * binWidth > max) {
      // don't go out of bounds, but, still indicate overflow by increasing n
      // before breaking
      break;
    }
  }
  // the n we have now is the first bin beyond our coordinate.
  // better aligned with conventions to return the lower edge.
  return n - 1;
}

Referenced by produce().

◆ configure()

void recon::BeamElectronLocator::configure ( framework::config::Parameters & parameters )

overridevirtual

Configure the processor using the given user specified parameters.

The user specified parameters that are available are defined in the python configuration class. Look at the beamElecronLocator.py in Recon/python for the python structure.

Parameters

parameters Set of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 11 of file BeamElectronLocator.cxx.

                                                                         {
  input_coll_ = parameters.get<std::string>("input_collection");
  input_pass_name_ = parameters.get<std::string>("input_pass_name");
  output_coll_ = parameters.get<std::string>("output_collection");
  granularity_xmm_ = parameters.get<double>("granularity_X_mm");
  granularity_ymm_ = parameters.get<double>("granularity_Y_mm");
  tolerance_ = parameters.get<double>("min_granularity_mm");
  min_xmm_ = parameters.get<double>("min_X_mm");
  max_xmm_ = parameters.get<double>("max_X_mm");
  min_ymm_ = parameters.get<double>("min_Y_mm");
  max_ymm_ = parameters.get<double>("max_Y_mm");
  verbose_ = parameters.get<bool>("verbose");
}

References framework::config::Parameters::get(), granularity_xmm_, granularity_ymm_, input_coll_, input_pass_name_, max_xmm_, max_ymm_, min_xmm_, min_ymm_, output_coll_, tolerance_, and verbose_.

◆ onProcessStart()

void recon::BeamElectronLocator::onProcessStart ( )

overridevirtual

Prints the configuration to log in debug mode.

Reimplemented from framework::EventProcessor.

Definition at line 24 of file BeamElectronLocator.cxx.

                                         {
  ldmx_log(debug) << "BeamElectronLocator is using parameters: "
                  << " \n\tinput_collection = " << input_coll_
                  << " \n\tinput_pass_name = " << input_pass_name_
                  << " \n\toutput_collection = " << output_coll_
                  << " \n\tgranularity_X_mm = " << granularity_xmm_
                  << " \n\tgranularity_Y_mm = " << granularity_ymm_
                  << " \n\tmin_granularity_mm = " << tolerance_
                  << " \n\tmin_X_mm = " << min_xmm_
                  << " \n\tmax_X_mm = " << max_xmm_
                  << " \n\tmin_Y_mm = " << min_ymm_
                  << " \n\tmax_Y_mm = " << max_ymm_
                  << " \n\tverbose = " << verbose_;
}

References granularity_xmm_, granularity_ymm_, input_coll_, input_pass_name_, max_xmm_, max_ymm_, min_xmm_, min_ymm_, output_coll_, tolerance_, and verbose_.

◆ produce()

void recon::BeamElectronLocator::produce ( framework::Event & event )

overridevirtual

Process the event and put new data products into it.

Parameters

event The event to process.

Implements framework::Producer.

Definition at line 39 of file BeamElectronLocator.cxx.

                                                       {
  // Check if the input collection exists. If not,
  // don't bother processing the event.
  if (!event.exists(input_coll_, input_pass_name_)) {
    ldmx_log(fatal) << "Attemping to use non-existing input collection "
                    << input_coll_ << "_" << input_pass_name_
                    << " to locate electrons! Exiting.";
    return;
  }
 
  std::vector<ldmx::BeamElectronTruth> beam_electron_info;
  const auto sim_hits{event.getCollection<ldmx::SimCalorimeterHit>(
      input_coll_, input_pass_name_)};
 
  if (verbose_) {
    ldmx_log(info) << "Looping through simhits in event "
                   << event.getEventNumber() << ".";
  }
 
  for (const auto &sim_hit : sim_hits) {
    // check if we already caught this position, else, add it
    bool is_matched = false;
    std::vector<float> pos = sim_hit.getPosition();
    for (auto found_electrons : beam_electron_info) {
      // this check makes it square rather than a dR circle
      if (fabs(pos[0] - found_electrons.getX()) < tolerance_ &&
          fabs(pos[1] - found_electrons.getY()) < tolerance_) {
        if (verbose_) {
          ldmx_log(debug) << "\tHit at (x_ = " << pos[0] << ", y_ = " << pos[1]
                          << " matches electron found at (x_ = "
                          << found_electrons.getX()
                          << ", y_ = " << found_electrons.getY()
                          << "); skip this simhit";
        }
        is_matched = true;
        break;  // finding a match means Move on
      }  // if coordinates match something we already found
    }  // over found electrons
    if (!is_matched) {
      if (verbose_) {
        ldmx_log(info) << "\tHit at (x_ = " << pos[0] << ", y_ = " << pos[1]
                       << " not formerly matched. Adding to collection.";
      }
      ldmx::BeamElectronTruth electron_info;
      electron_info.setXYZ(pos[0], pos[1], pos[2]);
      // find a way to do this later
      // electronInfo.setThreeMomentum(simHit.getPx(), simHit.getPy(),
      // simHit.getPz());
 
      electron_info.setBarX(bin(pos[0], granularity_xmm_, min_xmm_, max_xmm_));
      electron_info.setBarY(bin(pos[1], granularity_ymm_, min_ymm_, max_ymm_));
      // set coordinates to bin center
      electron_info.setBinnedX(min_xmm_ + (electron_info.getBarX() + 0.5) *
                                              granularity_xmm_);
      electron_info.setBinnedY(min_ymm_ + (electron_info.getBarY() + 0.5) *
                                              granularity_ymm_);
 
      beam_electron_info.push_back(electron_info);
    }
  }  // over simhits in the collection
 
  event.add(output_coll_, beam_electron_info);
}

References bin(), framework::Event::exists(), ldmx::BeamElectronTruth::getBarX(), ldmx::BeamElectronTruth::getBarY(), granularity_xmm_, granularity_ymm_, input_coll_, input_pass_name_, max_xmm_, max_ymm_, min_xmm_, min_ymm_, output_coll_, ldmx::BeamElectronTruth::setBarX(), ldmx::BeamElectronTruth::setBarY(), ldmx::BeamElectronTruth::setBinnedX(), ldmx::BeamElectronTruth::setBinnedY(), ldmx::BeamElectronTruth::setXYZ(), tolerance_, and verbose_.

Member Data Documentation

◆ granularity_xmm_

double recon::BeamElectronLocator::granularity_xmm_

private

The granularity of the detector (e.g.

TS) in X, in mm

Definition at line 101 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ granularity_ymm_

double recon::BeamElectronLocator::granularity_ymm_

private

The granularity of the detector (e.g.

TS) in Y, in mm

Definition at line 105 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ input_coll_

std::string recon::BeamElectronLocator::input_coll_

private

The name of the input collection used for counting electrons.

Definition at line 67 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ input_pass_name_

std::string recon::BeamElectronLocator::input_pass_name_

private

The pass name of the input collection used for counting electrons.

Definition at line 72 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ max_xmm_

double recon::BeamElectronLocator::max_xmm_

private

The max value measured by the system (edge) in X, in mm.

Definition at line 87 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ max_ymm_

double recon::BeamElectronLocator::max_ymm_

private

The max value measured by the system (edge) in Y, in mm.

Definition at line 96 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ min_xmm_

double recon::BeamElectronLocator::min_xmm_

private

The min value measured by the system (edge) in X, in mm.

Definition at line 83 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ min_ymm_

double recon::BeamElectronLocator::min_ymm_

private

The min value measured by the system (edge) in Y, in mm.

Definition at line 92 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ output_coll_

std::string recon::BeamElectronLocator::output_coll_

private

The name of the output collection used to save some electron counting variables.

Definition at line 78 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ tolerance_

double recon::BeamElectronLocator::tolerance_

private

The tolerance within which simhits are considered to belong to the same electron.

Definition at line 111 of file BeamElectronLocator.h.

Referenced by configure(), onProcessStart(), and produce().

◆ verbose_

bool recon::BeamElectronLocator::verbose_ {false}

private

Indicate verbose printout to log according to log level.

Definition at line 116 of file BeamElectronLocator.h.

116{false};

Referenced by configure(), onProcessStart(), and produce().

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

Recon/include/Recon/BeamElectronLocator.h
Recon/src/Recon/BeamElectronLocator.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BeamElectronLocator()

◆ ~BeamElectronLocator()

Member Function Documentation

◆ bin()

◆ configure()

◆ onProcessStart()

◆ produce()

Member Data Documentation

◆ granularity_xmm_

◆ granularity_ymm_

◆ input_coll_

◆ input_pass_name_

◆ max_xmm_

◆ max_ymm_

◆ min_xmm_

◆ min_ymm_

◆ output_coll_

◆ tolerance_

◆ verbose_