Electron counting processor. More...

#include <ElectronCounter.h>

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

	~ElectronCounter ()
	Destructor.

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

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	beforeNewRun (ldmx::RunHeader &header)
	Handle allowing producers to modify run headers before the run begins.

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

virtual	~EventProcessor ()
	Class destructor.

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	onProcessStart ()
	Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.

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	inputColl_
	The name of the input collection used for counting electrons.

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

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

int	nElectronsSim_ {-1}
	The number of electrons actually simulated in the event.

int	useSimElectronCount_ {false}
	Use the number of electrons actually simulated in the event as the electron count.

Additional Inherited Members
Static Public Member Functions inherited from framework::EventProcessor
static void	declare (const std::string &classname, int classtype, EventProcessorMaker *)
	Internal function which is part of the PluginFactory machinery.

Static Public Attributes inherited from framework::Producer
static const int	CLASSTYPE {1}
	Constant used to track EventProcessor types by the PluginFactory.

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

Electron counting processor.

This processor will use objects reconstructed in the trigger scintillators, or truth info on the number of electrons, and set the electron count in the event.

Definition at line 22 of file ElectronCounter.h.

Constructor & Destructor Documentation

◆ ElectronCounter()

recon::ElectronCounter::ElectronCounter	(	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 ElectronCounter.cxx.

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

framework::Producer

Base class for a module which produces a data product.

Definition EventProcessor.h:252

◆ ~ElectronCounter()

recon::ElectronCounter::~ElectronCounter ( )

Destructor.

Definition at line 9 of file ElectronCounter.cxx.

9{}

Member Function Documentation

◆ configure()

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

overridevirtual

Configure the processor using the given user specified parameters.

The user specified parameters that are availabed are defined in the python configuration class. Look at the my_processor.py module of the EventProc 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 ElectronCounter.cxx.

                                                                     {
  inputColl_ = parameters.getParameter<std::string>("input_collection");
  inputPassName_ = parameters.getParameter<std::string>("input_pass_name");
  outputColl_ = parameters.getParameter<std::string>("output_collection");
  nElectronsSim_ = parameters.getParameter<int>("simulated_electron_number");
  useSimElectronCount_ =
      parameters.getParameter<bool>("use_simulated_electron_number");
 
  /*  // can rehash this for cluster vs track counting
  if (mode_ == 0) {
    algoName_ = "LayerSumTrig";
  } else if (mode_ == 1) {
    algoName_ = "CenterTower";
  }
  */
  ldmx_log(debug) << "ElectronCounter is using parameters: "
                  << " \n\tinput_collection = " << inputColl_
                  << " \n\tinput_pass_name = " << inputPassName_
                  << " \n\toutput_collection = " << outputColl_
                  << " \n\tsimulated_electron_number = " << nElectronsSim_
                  << " \n\tuse_simulated_electron_number = "
                  << useSimElectronCount_;
}

References framework::config::Parameters::getParameter(), inputColl_, inputPassName_, nElectronsSim_, outputColl_, and useSimElectronCount_.

◆ produce()

void recon::ElectronCounter::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 35 of file ElectronCounter.cxx.

                                                   {
  int nElectrons = -1;
 
  if (useSimElectronCount_) {
    if (nElectronsSim_ < 0) {
      ldmx_log(fatal)
          << "Can't use unset number of simulated electrons as electron count! "
             "Set with 'simulated_electron_number' ";
      return;
    }
    // then we just set it equal to simulated number and we're done
    nElectrons = nElectronsSim_;
  }
  // Check if the collection of trig scint tracks exist.  If not,
  // don't bother processing the event.
  else {
    if (!event.exists(inputColl_, inputPassName_)) {
      ldmx_log(fatal) << "Attemping to use non-existing input collection "
                      << inputColl_ << "_" << inputPassName_
                      << " to count electrons! Exiting.";
      return;
    }
    // TODO, if cluster counting is needed: have two functions, one with tracks,
    // one with clusters, and just call one or the other.
 
    // Get the collection of TS tracks
    const std::vector<ldmx::TrigScintTrack> tracks =
        event.getCollection<ldmx::TrigScintTrack>(inputColl_, inputPassName_);
 
    nElectrons = tracks.size();
    ldmx_log(debug) << "Found " << tracks.size()
                    << " electrons (tracks) using input collection "
                    << inputColl_ << "_" << inputPassName_;
  }
  // add number of electrons to event header. allow for it to be unset (-1)
  event.getEventHeader().setIntParameter("nElectrons", nElectrons);
  event.setElectronCount(nElectrons);
}

References framework::Event::exists(), inputColl_, inputPassName_, nElectronsSim_, and useSimElectronCount_.

Member Data Documentation

◆ inputColl_

std::string recon::ElectronCounter::inputColl_

private

The name of the input collection used for counting electrons.

Definition at line 58 of file ElectronCounter.h.

Referenced by configure(), and produce().

◆ inputPassName_

std::string recon::ElectronCounter::inputPassName_

private

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

Definition at line 63 of file ElectronCounter.h.

Referenced by configure(), and produce().

◆ nElectronsSim_

int recon::ElectronCounter::nElectronsSim_ {-1}

private

The number of electrons actually simulated in the event.

Definition at line 74 of file ElectronCounter.h.

74{-1};

Referenced by configure(), and produce().

◆ outputColl_

std::string recon::ElectronCounter::outputColl_

private

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

Definition at line 69 of file ElectronCounter.h.

Referenced by configure().

◆ useSimElectronCount_

int recon::ElectronCounter::useSimElectronCount_ {false}

private

Use the number of electrons actually simulated in the event as the electron count.

Definition at line 80 of file ElectronCounter.h.

80{false};

Referenced by configure(), and produce().

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

Recon/include/Recon/ElectronCounter.h
Recon/src/Recon/ElectronCounter.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ElectronCounter()

◆ ~ElectronCounter()

Member Function Documentation

◆ configure()

◆ produce()

Member Data Documentation

◆ inputColl_

◆ inputPassName_

◆ nElectronsSim_

◆ outputColl_

◆ useSimElectronCount_