hcal::HcalVetoProcessor Class Reference

Public Member Functions
	HcalVetoProcessor (const std::string &name, framework::Process &process)
	Constructor.
virtual	~HcalVetoProcessor ()=default
	Destructor.
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified parameters.
void	produce (framework::Event &event) override
	Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.
std::vector< float >	trackProp (const ldmx::Tracks &tracks, ldmx::TrackStateType ts_type, const std::string &ts_title)
	Return a vector of parameters for a propagated recoil track.
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	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	total_pe_threshold_ {5}
	Total PE threshold.
float	max_time_ {50}
	Maximum hit time that should be considered by the veto.
float	back_min_pe_ {1}
	The minimum number of PE in both bars needed for a hit to be considered in double ended readout mode.
ldmx::HcalHit	default_max_hit_
std::string	output_coll_name_
std::string	input_hit_coll_name_
std::string	input_hit_pass_name_
std::string	track_pass_name_
bool	exclude_recoil_ele_
std::string	track_collection_
float	dr_from_recoil_max_
bool	inverse_skim_ {false}

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 26 of file HcalVetoProcessor.h.

Constructor & Destructor Documentation

HcalVetoProcessor()

hcal::HcalVetoProcessor::HcalVetoProcessor	(	const std::string &	name,
		framework::Process &	process )

Constructor.

Definition at line 17 of file HcalVetoProcessor.cxx.

    : Producer(name, process) {}

Member Function Documentation

configure()

void hcal::HcalVetoProcessor::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 21 of file HcalVetoProcessor.cxx.

                                                                       {
  total_pe_threshold_ = parameters.get<double>("pe_threshold");
  max_time_ = parameters.get<double>("max_time");
  output_coll_name_ = parameters.get<std::string>("output_coll_name");
  input_hit_coll_name_ = parameters.get<std::string>("input_hit_coll_name");
  input_hit_pass_name_ = parameters.get<std::string>("input_hit_pass_name");
  track_pass_name_ = parameters.get<std::string>("track_pass_name");
 
  // A fake-hit that gets added for the rare case where no hit actually reaches
  // the maxPE < pe check to avoid producing uninitialized memory
  //
  // Default constructed hits have nonsense-but predictable values and are
  // harder to mistake for real hits
  default_max_hit_.clear();
  default_max_hit_.setPE(-9999);
  default_max_hit_.setMinPE(-9999);
  default_max_hit_.setSection(-9999);
  default_max_hit_.setLayer(-9999);
  default_max_hit_.setStrip(-9999);
  default_max_hit_.setEnd(-999);
  default_max_hit_.setTimeDiff(-9999);
  default_max_hit_.setToaPos(-9999);
  default_max_hit_.setToaNeg(-9999);
  default_max_hit_.setAmplitudePos(-9999);
  default_max_hit_.setAmplitudeNeg(-9999);
 
  double max_depth = parameters.get<double>("max_depth", 0.);
  if (max_depth != 0.) {
    EXCEPTION_RAISE(
        "InvalidParam",
        "Earlier versions of the Hcal veto defined a max depth for "
        "positions which is no longer implemented. Remove the "
        "parameter (max_depth) from your configuration. See "
        "https://github.com/LDMX-Software/Hcal/issues/61 for details");
  }
  back_min_pe_ = parameters.get<double>("back_min_pe");
  exclude_recoil_ele_ = parameters.get<bool>("exclude_recoil_ele", false);
  track_collection_ =
      parameters.get<std::string>("track_collection", "RecoilTracks");
  dr_from_recoil_max_ = parameters.get<double>("dr_from_recoil_max", 100);
  inverse_skim_ = parameters.get<bool>("inverse_skim");
}

References back_min_pe_, ldmx::HcalHit::clear(), framework::config::Parameters::get(), max_time_, ldmx::HcalHit::setAmplitudeNeg(), ldmx::HcalHit::setAmplitudePos(), ldmx::HcalHit::setEnd(), ldmx::HcalHit::setLayer(), ldmx::HcalHit::setMinPE(), ldmx::HcalHit::setPE(), ldmx::HcalHit::setSection(), ldmx::HcalHit::setStrip(), ldmx::HcalHit::setTimeDiff(), ldmx::HcalHit::setToaNeg(), ldmx::HcalHit::setToaPos(), and total_pe_threshold_.

produce()

void hcal::HcalVetoProcessor::produce ( framework::Event & event )

overridevirtual

Run the processor and create a collection of results which indicate if the event passes/fails the Hcal veto.

Parameters

event

The event to process.

Implements framework::Producer.

Definition at line 64 of file HcalVetoProcessor.cxx.

                                                     {
  // Get the collection of sim particles from the event
  const std::vector<ldmx::HcalHit> hcal_rec_hits =
      event.getCollection<ldmx::HcalHit>(input_hit_coll_name_,
                                         input_hit_pass_name_);
 
  // Where deos the recoil electron end up in the HCAL?
  float recoil_pos_x{0.0};
  float recoil_pos_y{0.0};
  float recoil_pos_z{-9999.0};
  float recoil_mom_x{-9999.0};
  float recoil_mom_y{-9999.0};
  float recoil_mom_z{-9999.0};
 
  if (exclude_recoil_ele_) {
    std::vector<float> recoil_track_states;
    // Get the recoil track collection
    auto recoil_tracks{
        event.getCollection<ldmx::Track>(track_collection_, track_pass_name_)};
 
    // Use ACTS to propagate the recoil track to the end of the magnetic field
    // This happens to be at the ECAL face
    ldmx::TrackStateType ts_type = ldmx::AtECAL;
    recoil_track_states = trackProp(recoil_tracks, ts_type, "ecal");
    if (!recoil_track_states.empty()) {
      recoil_pos_x = recoil_track_states[0];
      recoil_pos_y = recoil_track_states[1];
      recoil_pos_z = recoil_track_states[2];
      recoil_mom_x = recoil_track_states[3];
      recoil_mom_y = recoil_track_states[4];
      recoil_mom_z = recoil_track_states[5];
    }
  }
 
  // Loop over all of the Hcal hits and calculate to total photoelectrons
  // in the event.
  float total_pe{0.0};
  float max_pe{-1000};
  int num_total_hits{0};
  int num_valid_hits{0};
  int num_non_recoil_hits{0};
 
  const ldmx::HcalHit* max_pe_hit{&default_max_hit_};
  for (const ldmx::HcalHit& hcal_hit : hcal_rec_hits) {
    num_total_hits++;
    // If the hit time is outside the readout window, don't consider it.
    if (hcal_hit.getTime() >= max_time_) {
      continue;
    }
 
    // Get the total PE in the bar
    float pe = hcal_hit.getPE();
    // Keep track of the total PE
    total_pe += pe;
 
    // Check that both sides of the bar have a PE value above threshold.
    // If not, don't consider the hit.  Double sided readout is only
    // being used for the back HCal bars.  For the side HCal, just
    // use the maximum PE as before.
    ldmx::HcalID id(hcal_hit.getID());
    if ((id.section() == ldmx::HcalID::BACK) &&
        (hcal_hit.getMinPE() < back_min_pe_))
      continue;
 
    num_valid_hits++;
 
    // Max PE should not be caused by the recoil ele
    if (exclude_recoil_ele_) {
      // Get the position of this hit
      auto hit_pos_x = hcal_hit.getXPos();
      auto hit_pos_y = hcal_hit.getYPos();
      auto hit_pos_z = hcal_hit.getZPos();
      auto d_z = recoil_pos_z - hit_pos_z;
 
      auto drift_recoil_x =
          (d_z * (recoil_mom_x / recoil_mom_z)) + recoil_pos_x;
      auto drift_recoil_y =
          (d_z * (recoil_mom_y / recoil_mom_z)) + recoil_pos_y;
      auto dx = drift_recoil_x - hit_pos_x;
      auto dy = drift_recoil_y - hit_pos_y;
      auto d_r_squared = dx * dx + dy * dy + d_z * d_z;
      auto d_r = sqrt(d_r_squared);
      ldmx_log(debug) << "    This hit is at " << hit_pos_x << " / "
                      << hit_pos_y << " /  " << hit_pos_z << " mm";
      ldmx_log(debug) << "    Ele is projected at " << drift_recoil_x << " / "
                      << drift_recoil_y << " /  " << recoil_pos_z - d_z;
      ldmx_log(debug) << "    from " << recoil_pos_x << " / " << recoil_pos_y
                      << " / " << recoil_pos_z << " / " << " mm";
 
      ldmx_log(debug) << "       Ele had momentum of  " << recoil_mom_x << " / "
                      << recoil_mom_y << " /  " << recoil_mom_z << " MeV";
      ldmx_log(debug) << "    This hit has PE = " << pe
                      << " and dR from ele = " << "is " << d_r << " mm";
 
      // Dont consider this hit for max PE hit if it's too close to the recoil
      // electron trajectory
      if (d_r < dr_from_recoil_max_) {
        continue;
      }
    }
    num_non_recoil_hits++;
 
    // Find the maximum PE in the list
    if (max_pe < pe) {
      max_pe = pe;
      max_pe_hit = &hcal_hit;
    }
  }
 
  ldmx_log(info) << "There are " << num_valid_hits << " / " << num_total_hits
                 << " HCal hits read out. " << num_non_recoil_hits
                 << " are not associated with the recoil ele. Total PE of "
                 << total_pe;
  // If the maximum PE found is below threshold, it passes the veto.
  bool passes_veto = (max_pe < total_pe_threshold_);
  ldmx_log(info) << "HCAL veto passed? " << passes_veto;
 
  ldmx::HcalVetoResult result;
  result.setVetoResult(passes_veto);
  result.setMaxPEHit(*max_pe_hit);
  result.setTotalPE(total_pe);
  result.setNumValidHits(num_valid_hits);
 
  // Skimming rules
  if (!inverse_skim_) {
    if (passes_veto) {
      setStorageHint(framework::HINT_SHOULD_KEEP);
    } else {
      setStorageHint(framework::HINT_SHOULD_DROP);
    }
  } else {
    // Inverse skimming rules
    if (passes_veto) {
      setStorageHint(framework::HINT_SHOULD_DROP);
    } else {
      setStorageHint(framework::HINT_SHOULD_KEEP);
    }
  }
 
  event.add(output_coll_name_, result);
}

References back_min_pe_, framework::HINT_SHOULD_DROP, framework::HINT_SHOULD_KEEP, max_time_, ldmx::HcalVetoResult::setMaxPEHit(), ldmx::HcalVetoResult::setNumValidHits(), framework::EventProcessor::setStorageHint(), ldmx::HcalVetoResult::setTotalPE(), ldmx::HcalVetoResult::setVetoResult(), total_pe_threshold_, and trackProp().

trackProp()

std::vector< float > hcal::HcalVetoProcessor::trackProp	(	const ldmx::Tracks &	tracks,
		ldmx::TrackStateType	ts_type,
		const std::string &	ts_title )

Return a vector of parameters for a propagated recoil track.

Parameters

[in]	tracks	The track collection
[in]	ts_type	The track state type, i.e. tracks state at the mid-HCAL
[in]	ts_title	The track state title, most likely "hcal"

Returns

Vector of parameters for a propagated recoil track

Definition at line 206 of file HcalVetoProcessor.cxx.

                                                                           {
  // Vector to hold the new track state variables
  std::vector<float> new_track_states;
 
  // Return if no tracks
  if (tracks.empty()) return new_track_states;
 
  // Otherwise loop on the tracks
  for (auto& track : tracks) {
    // Get track state for ts_type
    auto trk_ts = track.getTrackState(ts_type);
    // Continue if there's no value
    if (!trk_ts.has_value()) continue;
    ldmx::Track::TrackState hcal_track_state = trk_ts.value();
 
    // Check that the track state is filled
    if (hcal_track_state.pos_.size() < 3 || hcal_track_state.mom_.size() < 3)
      continue;
 
    // pos_ is (x, y, z) in mm (LDMX global); mom_ is (px, py, pz) in MeV
    new_track_states.push_back(static_cast<float>(hcal_track_state.pos_[0]));
    new_track_states.push_back(static_cast<float>(hcal_track_state.pos_[1]));
    new_track_states.push_back(static_cast<float>(hcal_track_state.pos_[2]));
    new_track_states.push_back(static_cast<float>(hcal_track_state.mom_[0]));
    new_track_states.push_back(static_cast<float>(hcal_track_state.mom_[1]));
    new_track_states.push_back(static_cast<float>(hcal_track_state.mom_[2]));
    break;
  }
 
  return new_track_states;
}

Referenced by produce().

Member Data Documentation

back_min_pe_

float hcal::HcalVetoProcessor::back_min_pe_ {1}

private

The minimum number of PE in both bars needed for a hit to be considered in double ended readout mode.

Definition at line 69 of file HcalVetoProcessor.h.

{1};

Referenced by configure(), and produce().

default_max_hit_

ldmx::HcalHit hcal::HcalVetoProcessor::default_max_hit_

private

Definition at line 86 of file HcalVetoProcessor.h.

dr_from_recoil_max_

float hcal::HcalVetoProcessor::dr_from_recoil_max_

private

Definition at line 94 of file HcalVetoProcessor.h.

exclude_recoil_ele_

bool hcal::HcalVetoProcessor::exclude_recoil_ele_

private

Definition at line 92 of file HcalVetoProcessor.h.

input_hit_coll_name_

std::string hcal::HcalVetoProcessor::input_hit_coll_name_

private

Definition at line 89 of file HcalVetoProcessor.h.

input_hit_pass_name_

std::string hcal::HcalVetoProcessor::input_hit_pass_name_

private

Definition at line 90 of file HcalVetoProcessor.h.

inverse_skim_

bool hcal::HcalVetoProcessor::inverse_skim_ {false}

private

Definition at line 95 of file HcalVetoProcessor.h.

{false};

max_time_

float hcal::HcalVetoProcessor::max_time_ {50}

private

Maximum hit time that should be considered by the veto.

Definition at line 65 of file HcalVetoProcessor.h.

{50};  // ns

Referenced by configure(), and produce().

output_coll_name_

std::string hcal::HcalVetoProcessor::output_coll_name_

private

Definition at line 88 of file HcalVetoProcessor.h.

total_pe_threshold_

double hcal::HcalVetoProcessor::total_pe_threshold_ {5}

private

Total PE threshold.

Definition at line 62 of file HcalVetoProcessor.h.

{5};

Referenced by configure(), and produce().

track_collection_

std::string hcal::HcalVetoProcessor::track_collection_

private

Definition at line 93 of file HcalVetoProcessor.h.

track_pass_name_

std::string hcal::HcalVetoProcessor::track_pass_name_

private

Definition at line 91 of file HcalVetoProcessor.h.

---

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

• Hcal/include/Hcal/HcalVetoProcessor.h
• Hcal/src/Hcal/HcalVetoProcessor.cxx