tracking::TrackerVetoProcessor Class Reference

Flags events that pass the tracker veto by applying specific selection criteria. More...

#include <TrackerVetoProcessor.h>

Public Member Functions
	TrackerVetoProcessor (const std::string &name, framework::Process &process)
	Class constructor.
virtual	~TrackerVetoProcessor ()=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
	Process an event and apply tracker veto selection criteria.
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
float	max_d0_
	Maximum allowed transverse impact parameter (d0) for tracks.
float	max_z0_
	Maximum allowed longitudinal impact parameter (z0) for tracks.
float	max_chi2_per_ndf_
	Max chi2/ndf required for tracks.
float	min_tagger_momentum_
	Minimum required momentum for tagger tracks.
int	min_recoil_n_
	Minimum number of recoil tracks required.
int	max_recoil_n_
	Maximum number of recoil tracks allowed.
int	min_tagger_hits_
	Min number of hits for tagger tracks required.
int	min_recoil_hits_
	Min number of hits for recoil tracks required.
std::string	tagger_track_collection_name_
	The name of the tagger track collection.
std::string	recoil_track_collection_name_
	The name of the recoil track collection.
std::string	input_tagger_pass_name_
	The pass name of the input tagger collections.
std::string	input_recoil_pass_name_
	The pass name of the input recoil collections.
bool	inverse_skim_ {false}
	Boolean flag to invert the selection criteria for skimming purposes.
std::string	output_collection_

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 that pass the tracker veto by applying specific selection criteria.

This processor evaluates tracker events based on recoil and tagger track properties, applying configurable selection criteria to determine whether an event should be flagged.

Definition at line 26 of file TrackerVetoProcessor.h.

Constructor & Destructor Documentation

TrackerVetoProcessor()

tracking::TrackerVetoProcessor::TrackerVetoProcessor ( const std::string & name, framework::Process & process )

inline

Class constructor.

Parameters

name	Name of the processor.
process	Reference to the framework process.

Definition at line 33 of file TrackerVetoProcessor.h.

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

Member Function Documentation

configure()

void tracking::TrackerVetoProcessor::configure ( framework::config::Parameters & parameters )

overridevirtual

Configure the processor using the given user-specified parameters.

This function allows the user to set parameters such as track collection names, selection thresholds, and filtering options.

Parameters

parameters

Set of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 11 of file TrackerVetoProcessor.cxx.

                                                                  {
  tagger_track_collection_name_ =
      ps.getParameter<std::string>("tagger_track_collection", "TaggerTracks");
  recoil_track_collection_name_ =
      ps.getParameter<std::string>("recoil_track_collection", "RecoilTracks");
  input_tagger_pass_name_ =
      ps.getParameter<std::string>("input_tagger_pass_name", "");
  input_recoil_pass_name_ =
      ps.getParameter<std::string>("input_recoil_pass_name", "");
  output_collection_ = ps.getParameter<std::string>("output_collection", "");
  inverse_skim_ = ps.getParameter<bool>("inverse_skim", false);
  max_d0_ = ps.getParameter<double>("max_d0", 10.);
  max_z0_ = ps.getParameter<double>("max_z0", 40.);
  max_chi2_per_ndf_ = ps.getParameter<double>("max_chi2_per_ndf", 5.);
  min_tagger_momentum_ = ps.getParameter<double>("min_tagger_momentum", 5600.);
  min_recoil_n_ = ps.getParameter<int>("min_recoil_n", 1);
  max_recoil_n_ = ps.getParameter<int>("max_recoil_n", 1);
  min_tagger_hits_ = ps.getParameter<int>("min_tagger_hits", 4);
  min_recoil_hits_ = ps.getParameter<int>("min_recoil_hits", 4);
}

References input_recoil_pass_name_, input_tagger_pass_name_, inverse_skim_, max_chi2_per_ndf_, max_d0_, max_recoil_n_, max_z0_, min_recoil_hits_, min_recoil_n_, min_tagger_hits_, min_tagger_momentum_, recoil_track_collection_name_, and tagger_track_collection_name_.

produce()

void tracking::TrackerVetoProcessor::produce ( framework::Event & event )

overridevirtual

Process an event and apply tracker veto selection criteria.

This function checks the properties of tracks in the event and determines whether it passes or fails the tracker veto conditions.

Parameters

event

The event to run the checks on.

Implements framework::Producer.

Definition at line 32 of file TrackerVetoProcessor.cxx.

                                                        {
  auto tagger_track_collection{event.getCollection<ldmx::Track>(
      tagger_track_collection_name_, input_recoil_pass_name_)};
  auto recoil_track_collection{event.getCollection<ldmx::Track>(
      recoil_track_collection_name_, input_recoil_pass_name_)};
 
  bool passes_veto{false}, passes_tagger_veto{false}, passes_recoil_veto{false};
 
  // Start with tagger tracks
  int tagger_n{0};
  for (const auto& trk : tagger_track_collection) {
    if ((std::abs(trk.getD0()) < max_d0_) &&
        (std::abs(trk.getZ0()) < max_z0_)) {
      auto charge_over_momentum = trk.getQoP();
      auto tagger_momentum = 1000. / std::abs(charge_over_momentum);
      float chi2_per_ndf = trk.getChi2() / trk.getNdf();
      if ((tagger_momentum > min_tagger_momentum_) &&
          (chi2_per_ndf < max_chi2_per_ndf_) &&
          (trk.getNhits() > min_tagger_hits_)) {
        tagger_n++;
        passes_tagger_veto = true;
      }
    }
  }
 
  ldmx_log(info) << "Tagger requirements passed for " << tagger_n << " tracks";
 
  // Recoil tracks now
  int recoil_n{0};
  for (const auto& trk : recoil_track_collection) {
    float chi2_per_ndf = trk.getChi2() / trk.getNdf();
    if ((std::abs(trk.getD0()) < max_d0_) &&
        (std::abs(trk.getZ0()) < max_z0_) &&
        (chi2_per_ndf < max_chi2_per_ndf_) &&
        (trk.getNhits() > min_recoil_hits_)) {
      // we may wanna use these in the future, keeping them commented
      // auto charge_over_momentum = trk.getQoP();
      // recoil_momentum = 1000. / abs(charge_over_momentum);
      recoil_n++;
    };
  }
 
  ldmx_log(info) << "Recoil requirements passed for " << recoil_n << " tracks";
 
  if ((min_recoil_n_ <= recoil_n) && (recoil_n <= max_recoil_n_)) {
    passes_recoil_veto = true;
  }
 
  passes_veto = passes_tagger_veto && passes_recoil_veto;
 
  ldmx::TrackerVetoResult result;
  result.setVetoResult(passes_veto);
  result.setTaggerVetoResult(passes_tagger_veto);
  result.setRecoilVetoResult(passes_recoil_veto);
 
  event.add(output_collection_, result);
 
  if (!inverse_skim_) {
    if (passes_veto) {
      ldmx_log(info) << "Tracker veto passed, skim will keep the event";
      setStorageHint(framework::hint_shouldKeep);
    } else {
      ldmx_log(info) << "Tracker veto failed";
      setStorageHint(framework::hint_shouldDrop);
    }
  } else {
    if (passes_veto) {
      ldmx_log(info) << "Inverse tracker veto passed";
      setStorageHint(framework::hint_shouldDrop);
    } else {
      ldmx_log(info) << "Inverse tracker veto failed, skim will keep the event";
      setStorageHint(framework::hint_shouldKeep);
    }
  }
}  // produce

References framework::hint_shouldDrop, framework::hint_shouldKeep, input_recoil_pass_name_, inverse_skim_, max_chi2_per_ndf_, max_d0_, max_recoil_n_, max_z0_, min_recoil_hits_, min_recoil_n_, min_tagger_hits_, min_tagger_momentum_, recoil_track_collection_name_, ldmx::TrackerVetoResult::setRecoilVetoResult(), framework::EventProcessor::setStorageHint(), ldmx::TrackerVetoResult::setTaggerVetoResult(), ldmx::TrackerVetoResult::setVetoResult(), and tagger_track_collection_name_.

Member Data Documentation

input_recoil_pass_name_

std::string tracking::TrackerVetoProcessor::input_recoil_pass_name_

private

The pass name of the input recoil collections.

Definition at line 96 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

input_tagger_pass_name_

std::string tracking::TrackerVetoProcessor::input_tagger_pass_name_

private

The pass name of the input tagger collections.

Definition at line 93 of file TrackerVetoProcessor.h.

Referenced by configure().

inverse_skim_

bool tracking::TrackerVetoProcessor::inverse_skim_ {false}

private

Boolean flag to invert the selection criteria for skimming purposes.

Definition at line 99 of file TrackerVetoProcessor.h.

{false};

Referenced by configure(), and produce().

max_chi2_per_ndf_

float tracking::TrackerVetoProcessor::max_chi2_per_ndf_

private

Max chi2/ndf required for tracks.

Definition at line 69 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

max_d0_

float tracking::TrackerVetoProcessor::max_d0_

private

Maximum allowed transverse impact parameter (d0) for tracks.

Definition at line 63 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

max_recoil_n_

int tracking::TrackerVetoProcessor::max_recoil_n_

private

Maximum number of recoil tracks allowed.

Definition at line 78 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

max_z0_

float tracking::TrackerVetoProcessor::max_z0_

private

Maximum allowed longitudinal impact parameter (z0) for tracks.

Definition at line 66 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

min_recoil_hits_

int tracking::TrackerVetoProcessor::min_recoil_hits_

private

Min number of hits for recoil tracks required.

Definition at line 84 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

min_recoil_n_

int tracking::TrackerVetoProcessor::min_recoil_n_

private

Minimum number of recoil tracks required.

Definition at line 75 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

min_tagger_hits_

int tracking::TrackerVetoProcessor::min_tagger_hits_

private

Min number of hits for tagger tracks required.

Definition at line 81 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

min_tagger_momentum_

float tracking::TrackerVetoProcessor::min_tagger_momentum_

private

Minimum required momentum for tagger tracks.

Definition at line 72 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

output_collection_

std::string tracking::TrackerVetoProcessor::output_collection_

private

Definition at line 102 of file TrackerVetoProcessor.h.

recoil_track_collection_name_

std::string tracking::TrackerVetoProcessor::recoil_track_collection_name_

private

The name of the recoil track collection.

Definition at line 90 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

tagger_track_collection_name_

std::string tracking::TrackerVetoProcessor::tagger_track_collection_name_

private

The name of the tagger track collection.

Definition at line 87 of file TrackerVetoProcessor.h.

Referenced by configure(), and produce().

---

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

• Tracking/include/Tracking/TrackerVetoProcessor.h
• Tracking/src/Tracking/TrackerVetoProcessor.cxx