recon::RecoilFiducialityProcessor Class Reference

Flags events with a fiducial recoil electron, based on truth information. More...

#include <RecoilFiducialityProcessor.h>

Public Member Functions
	RecoilFiducialityProcessor (const std::string &name, framework::Process &process)
	Class constructor.
virtual	~RecoilFiducialityProcessor ()=default
	Class destructor.
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.
void	produce (framework::Event &event) override
	Create a FiducialFlag object to contain info about whether the recoil electron satisfies certain fiduciality conditions.
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
double	min_p_mag_
	Minimum recoil electron momentum at production.
int	min_tracker_hits_
	Minimum number of recoil electron hits in the recoil tracker.
std::string	input_pass_name_
	The pass name of the input collections.
std::string	ecal_collection_
	The name of the ecal collection.
std::string	hcal_collection_
	The name of the hcal collection.
std::string	recoil_collection_
	The name of the recoil tracker collection.
std::string	output_collection_
	The name of the output collection.
bool	inverse_skim_ {false}
	Inverse option for skimming.

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

Flags events with a fiducial recoil electron, based on truth information.

Note

Definition at line 29 of file RecoilFiducialityProcessor.h.

Constructor & Destructor Documentation

RecoilFiducialityProcessor()

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

inline

Class constructor.

Definition at line 34 of file RecoilFiducialityProcessor.h.

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

Member Function Documentation

configure()

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

overridevirtual

Configure the processor using the given user specified parameters.

Parameters

parameters

Set of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 11 of file RecoilFiducialityProcessor.cxx.

                                           {
  min_p_mag_ = parameters.getParameter<double>("min_p_mag");
  min_tracker_hits_ = parameters.getParameter<int>("min_tracker_hits");
  input_pass_name_ = parameters.getParameter<std::string>("input_pass_name");
  ecal_collection_ = parameters.getParameter<std::string>("ecal_collection");
  hcal_collection_ = parameters.getParameter<std::string>("hcal_collection");
  recoil_collection_ =
      parameters.getParameter<std::string>("recoil_collection");
  output_collection_ =
      parameters.getParameter<std::string>("output_collection");
  inverse_skim_ = parameters.getParameter<bool>("inverse_skim");
}

References ecal_collection_, hcal_collection_, input_pass_name_, inverse_skim_, min_p_mag_, min_tracker_hits_, output_collection_, and recoil_collection_.

produce()

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

overridevirtual

Create a FiducialFlag object to contain info about whether the recoil electron satisfies certain fiduciality conditions.

Parameters

event

The event to run the fiduciality check on.

Implements framework::Producer.

Definition at line 25 of file RecoilFiducialityProcessor.cxx.

                                                              {
  // Get the collection of simulated particles from the event
  auto particleMap{
      event.getMap<int, ldmx::SimParticle>("SimParticles", input_pass_name_)};
 
  // Search for the recoil electron
  auto [recoil_track_id, recoil_electron] = Analysis::getRecoil(particleMap);
 
  // Get the collection of simulated Ecal hits from the event.
  const std::vector<ldmx::SimCalorimeterHit> ecal_sim_hits =
      event.getCollection<ldmx::SimCalorimeterHit>(ecal_collection_,
                                                   input_pass_name_);
 
  // Get the collection of simulated Ecal hits from the event.
  const std::vector<ldmx::SimCalorimeterHit> hcal_sim_hits =
      event.getCollection<ldmx::SimCalorimeterHit>(hcal_collection_,
                                                   input_pass_name_);
 
  // Get the collection of simulated tracker hits from the event.
  const std::vector<ldmx::SimTrackerHit> recoil_sim_hits =
      event.getCollection<ldmx::SimTrackerHit>(recoil_collection_,
                                               input_pass_name_);
 
  // Loop through the Ecal hits and check if the recoil electron is
  // associated with any of them.
  bool has_ecal_hit = false;
  int ecal_hit_id = -1;
  for (const ldmx::SimCalorimeterHit &sim_hit : ecal_sim_hits) {
    for (int iContrib = 0; iContrib < sim_hit.getNumberOfContribs();
         ++iContrib) {
      ldmx::SimCalorimeterHit::Contrib contrib = sim_hit.getContrib(iContrib);
 
      if (contrib.trackID == recoil_track_id) {
        has_ecal_hit = true;
        ecal_hit_id = sim_hit.getID();
      }
    }
  }
 
  // Loop through the Hcal hits and check if the recoil electron is
  // associated with any of them.
  bool has_hcal_hit = false;
  int hcal_hit_id = -1;
  for (const ldmx::SimCalorimeterHit &sim_hit : hcal_sim_hits) {
    for (int iContrib = 0; iContrib < sim_hit.getNumberOfContribs();
         ++iContrib) {
      ldmx::SimCalorimeterHit::Contrib contrib = sim_hit.getContrib(iContrib);
 
      if (contrib.trackID == recoil_track_id) {
        has_hcal_hit = true;
        hcal_hit_id = sim_hit.getID();
      }
    }
  }
 
  // Loop through the recoil tracker hits and count how many
  // the recoil electron is associated with
  std::set<int> layers_hit;
  for (const ldmx::SimTrackerHit &sim_hit : recoil_sim_hits) {
    if (sim_hit.getTrackID() == recoil_track_id) {
      // int sensorID = tracking::sim::utils::getSensorID(sim_hit);
      if ((sim_hit.getTime() < 0.8) && (sim_hit.getMomentum()[2] > 0)) {
        layers_hit.insert(sim_hit.getLayerID());
      }
    }
  }
  bool has_min_tracker_hits = false;
  if (layers_hit.size() >= min_tracker_hits_) {
    has_min_tracker_hits = true;
  }
 
  // Checking if the recoil electron energy is > min energy
  bool has_min_energy = false;
  if (recoil_electron->getEnergy() >= min_p_mag_) {
    has_min_energy = true;
  }
 
  // Configure outputs
  bool is_fiducial = has_min_energy && has_min_tracker_hits && has_ecal_hit;
 
  int mask_tracker_E = has_min_energy << 0;
  int mask_tracker_hits = has_min_tracker_hits << 1;
  int mask_ecal = has_ecal_hit << 2;
  int mask_hcal = has_hcal_hit << 3;
  int fiducial_flag =
      mask_tracker_E | mask_tracker_hits | mask_ecal | mask_hcal;
 
  ldmx::FiducialFlag flag;
  flag.setFiducialFlag(fiducial_flag, 6);
  flag.setAlgoVar(0, recoil_electron->getEnergy());
  flag.setAlgoVar(1, min_p_mag_);
  flag.setAlgoVar(2, layers_hit.size());
  flag.setAlgoVar(3, min_tracker_hits_);
  flag.setAlgoVar(4, ecal_hit_id);
  flag.setAlgoVar(5, hcal_hit_id);
 
  flag.setIsFiducial(is_fiducial);
  flag.setHasMinEnergy(has_min_energy);
  flag.setHasMinTrackerHits(has_min_tracker_hits);
  flag.setHasEcalHit(has_ecal_hit);
  flag.setHasHcalHit(has_hcal_hit);
 
  event.add(output_collection_, flag);
 
  // Tell the skimmer to keep or drop the event based on whether there
  // were recoil electron was fiducial.
 
  if (!inverse_skim_) {
    if (is_fiducial) {
      setStorageHint(framework::hint_shouldKeep);
    } else {
      setStorageHint(framework::hint_shouldDrop);
    }
  } else {
    if (is_fiducial) {
      setStorageHint(framework::hint_shouldDrop);
    } else {
      setStorageHint(framework::hint_shouldKeep);
    }
  }
}

References ecal_collection_, hcal_collection_, framework::hint_shouldDrop, framework::hint_shouldKeep, input_pass_name_, inverse_skim_, min_p_mag_, min_tracker_hits_, output_collection_, recoil_collection_, ldmx::FiducialFlag::setAlgoVar(), ldmx::FiducialFlag::setFiducialFlag(), ldmx::FiducialFlag::setHasEcalHit(), ldmx::FiducialFlag::setHasHcalHit(), ldmx::FiducialFlag::setHasMinEnergy(), ldmx::FiducialFlag::setHasMinTrackerHits(), ldmx::FiducialFlag::setIsFiducial(), framework::EventProcessor::setStorageHint(), and ldmx::SimCalorimeterHit::Contrib::trackID.

Member Data Documentation

ecal_collection_

std::string recon::RecoilFiducialityProcessor::ecal_collection_

private

The name of the ecal collection.

Definition at line 69 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

hcal_collection_

std::string recon::RecoilFiducialityProcessor::hcal_collection_

private

The name of the hcal collection.

Definition at line 72 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

input_pass_name_

std::string recon::RecoilFiducialityProcessor::input_pass_name_

private

The pass name of the input collections.

Definition at line 66 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

inverse_skim_

bool recon::RecoilFiducialityProcessor::inverse_skim_ {false}

private

Inverse option for skimming.

Definition at line 81 of file RecoilFiducialityProcessor.h.

{false};

Referenced by configure(), and produce().

min_p_mag_

double recon::RecoilFiducialityProcessor::min_p_mag_

private

Minimum recoil electron momentum at production.

Definition at line 60 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

min_tracker_hits_

int recon::RecoilFiducialityProcessor::min_tracker_hits_

private

Minimum number of recoil electron hits in the recoil tracker.

Definition at line 63 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

output_collection_

std::string recon::RecoilFiducialityProcessor::output_collection_

private

The name of the output collection.

Definition at line 78 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

recoil_collection_

std::string recon::RecoilFiducialityProcessor::recoil_collection_

private

The name of the recoil tracker collection.

Definition at line 75 of file RecoilFiducialityProcessor.h.

Referenced by configure(), and produce().

---

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

• Recon/include/Recon/Skims/RecoilFiducialityProcessor.h
• Recon/src/Recon/Skims/RecoilFiducialityProcessor.cxx