Determines if event is vetoable using ECAL hit information w/ a deep neural network. More...

#include <EcalPnetVetoProcessor.h>

Public Member Functions
	EcalPnetVetoProcessor (const std::string &name, framework::Process &process)

void	configure (framework::config::Parameters &parameters) override
	Callback for the EventProcessor to configure itself from the given set of 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	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 Member Functions
void	makeInputs (const ldmx::EcalGeometry &geom, const std::vector< ldmx::EcalHit > &ecalRecHits, std::array< double, 3 > etraj, std::array< double, 3 > enorm)
	Make inputs to the DNN from ECAL RecHits.

std::vector< float >	logSoftmax (const std::vector< float > &logits)
	Transform logits to a probability.

Private Attributes
double	disc_cut_logit_ {0}
	disc_cut as a logit difference, the probability saturates in float

std::vector< std::vector< float > >	data_

std::unique_ptr< ldmx::ort::ONNXRuntime >	rt_

std::string	collection_name_ {"EcalPnetVeto"}
	Name of the collection which will containt the results.

std::string	rec_coll_name_

std::string	ecal_rec_hits_passname_

std::string	ecal_sp_coll_name_

std::string	ecal_sp_hits_passname_

std::string	track_pass_name_

std::string	track_collection_

bool	recoil_from_tracking_

Static Private Attributes
static constexpr unsigned int	MAX_NUM_HITS = 300
	Maximum number of hits allowed in ECAL.

static constexpr unsigned int	N_COORDINATE_DIM = 3

static constexpr unsigned int	COORDINATE_X_OFFSET = 0

static constexpr unsigned int	COORDINATE_Y_OFFSET = MAX_NUM_HITS

static constexpr unsigned int	COORDINATE_Z_OFFSET = 2 * MAX_NUM_HITS

static constexpr unsigned int	N_FEATURE_DIM = 5

static constexpr unsigned int	FEATURE_X_OFFSET = 0

static constexpr unsigned int	FEATURE_Y_OFFSET = MAX_NUM_HITS

static constexpr unsigned int	FEATURE_Z_OFFSET = 2 * MAX_NUM_HITS

static constexpr unsigned int	FEATURE_ENERGY_OFFSET = 3 * MAX_NUM_HITS

static constexpr unsigned int	FEATURE_LAYER_ID_OFFSET = 4 * MAX_NUM_HITS

static const std::vector< std::string >	INPUT_NAMES

static const std::vector< unsigned int >	INPUT_SIZES

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

Determines if event is vetoable using ECAL hit information w/ a deep neural network.

Definition at line 25 of file EcalPnetVetoProcessor.h.

Constructor & Destructor Documentation

◆ EcalPnetVetoProcessor()

ecal::EcalPnetVetoProcessor::EcalPnetVetoProcessor	(	const std::string &	name,
		framework::Process &	process )

Definition at line 19 of file EcalPnetVetoProcessor.cxx.

    : Producer(name, process) {
  for (const auto& s : INPUT_SIZES) {
    data_.emplace_back(s, 0);
  }
}

Member Function Documentation

◆ configure()

void ecal::EcalPnetVetoProcessor::configure ( framework::config::Parameters & parameters )

overridevirtual

Callback for the EventProcessor to configure itself from the given set of parameters.

The parameters a processor has access to are the member variables of the python class in the sequence that has class_name equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 27 of file EcalPnetVetoProcessor.cxx.

                                           {
  auto disc_cut = parameters.get<double>("disc_cut");
  disc_cut_logit_ = disc_cut <= 0 ? -std::numeric_limits<double>::infinity()
                                  : std::log(disc_cut / (1. - disc_cut));
  rt_ = std::make_unique<ldmx::ort::ONNXRuntime>(
      parameters.get<std::string>("model_path"));
 
  // Set the collection name as defined in the configuration
  collection_name_ = parameters.get<std::string>("collection_name");
 
  rec_coll_name_ = parameters.get<std::string>("rec_coll_name");
  ecal_rec_hits_passname_ =
      parameters.get<std::string>("ecal_rec_hits_passname");
  ecal_sp_coll_name_ = parameters.get<std::string>("ecal_sp_coll_name");
  ecal_sp_hits_passname_ = parameters.get<std::string>("ecal_sp_hits_passname");
  track_pass_name_ = parameters.get<std::string>("track_pass_name", "");
  track_collection_ = parameters.get<std::string>("track_collection");
  recoil_from_tracking_ = parameters.get<bool>("recoil_from_tracking");
}

References framework::config::Parameters::get().

◆ logSoftmax()

std::vector< float > ecal::EcalPnetVetoProcessor::logSoftmax ( const std::vector< float > & logits )

private

Transform logits to a probability.

Parameters

logits Vector of logits

Returns: Vector of log softmax probabilities

Definition at line 218 of file EcalPnetVetoProcessor.cxx.

                                    {
  // Find max for numerical stability
  auto max_val = *std::max_element(logits.begin(), logits.end());
 
  // Compute shifted exponentials and their sum
  std::vector<float> exp_vals(logits.size());
  for (size_t i = 0; i < logits.size(); ++i) {
    exp_vals[i] = std::exp(logits[i] - max_val);
  }
 
  float sum_exp = std::accumulate(exp_vals.begin(), exp_vals.end(), 0.0);
  float log_sum_exp = max_val + std::log(sum_exp);
 
  // Compute log_softmax
  std::vector<float> result(logits.size());
  for (size_t i = 0; i < logits.size(); ++i) {
    result[i] = logits[i] - log_sum_exp;
  }
 
  return result;
}

◆ makeInputs()

void ecal::EcalPnetVetoProcessor::makeInputs	(	const ldmx::EcalGeometry &	geom,
		const std::vector< ldmx::EcalHit > &	ecalRecHits,
		std::array< double, 3 >	etraj,
		std::array< double, 3 >	enorm )

private

Make inputs to the DNN from ECAL RecHits.

Parameters

ecalRecHits The EcalHit collection.

Definition at line 169 of file EcalPnetVetoProcessor.cxx.

                                                          {
  // clear data
  for (auto& v : data_) {
    std::fill(v.begin(), v.end(), 0);
  }
 
  // Loop on the rechits
  unsigned idx = 0;
  for (const auto& hit : ecal_rec_hits) {
    if (hit.getEnergy() <= 0) {
      ldmx_log(warn)
          << "Hit with zero energy found, should not happen, skipping it.";
      continue;
    }
    ldmx::EcalID id(hit.getID());
    auto [hit_x, hit_y, hit_z] = geom.getPosition(id);
 
    double delta_z = hit_z - etraj[2];
    double etraj_x = etraj[0] + enorm[0] * delta_z;
    double etraj_y = etraj[1] + enorm[1] * delta_z;
    data_[0].at(COORDINATE_X_OFFSET + idx) = hit_x - etraj_x;
    data_[0].at(COORDINATE_Y_OFFSET + idx) = hit_y - etraj_y;
    data_[0].at(COORDINATE_Z_OFFSET + idx) = hit_z;
 
    data_[1].at(FEATURE_X_OFFSET + idx) = hit_x - etraj_x;
    data_[1].at(FEATURE_Y_OFFSET + idx) = hit_y - etraj_y;
    data_[1].at(FEATURE_Z_OFFSET + idx) = hit_z;
    data_[1].at(FEATURE_LAYER_ID_OFFSET + idx) = id.layer();
    data_[1].at(FEATURE_ENERGY_OFFSET + idx) = std::log(hit.getEnergy());
 
    ++idx;
  }
 
  std::stringstream ss;
  for (unsigned iname = 0; iname < INPUT_NAMES.size(); ++iname) {
    ss << "=== " << INPUT_NAMES[iname] << " ===";
    for (unsigned i = 0; i < INPUT_SIZES[iname]; ++i) {
      ss << data_[iname].at(i) << ", ";
      if ((i + 1) % MAX_NUM_HITS == 0) {
        ss << "\n\n";
      }
    }
  }
  ldmx_log(trace) << ss.str();
}  // end of make inputs

References ldmx::EcalGeometry::getPosition().

◆ produce()

void ecal::EcalPnetVetoProcessor::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 48 of file EcalPnetVetoProcessor.cxx.

                                                         {
  ldmx::EcalVetoResult result;
  //  Get the Ecal Geometry
  const auto& ecal_geometry = getCondition<ldmx::EcalGeometry>(
      ldmx::EcalGeometry::CONDITIONS_OBJECT_NAME);
 
  // Get the collection of digitized Ecal hits_ from the event.
  const auto ecal_rec_hits = event.getCollection<ldmx::EcalHit>(
      rec_coll_name_, ecal_rec_hits_passname_);
  auto nhits = std::count_if(
      ecal_rec_hits.begin(), ecal_rec_hits.end(),
      [](const ldmx::EcalHit& hit) { return hit.getEnergy() > 0; });
 
  // check number of hits_
  ldmx_log(debug) << "nhits = " << nhits << " MAX_NUM_HITS = " << MAX_NUM_HITS;
  if (nhits < MAX_NUM_HITS) {
    std::array<double, 3> etraj = {-999., -999., -999.};
    std::array<double, 3> enorm = {-999., -999., -999.};
    // Compute electron trajectory}
    const ldmx::SimTrackerHit* electron_hit = nullptr;
    // Use Scoring Plane or Tracking
    if (!recoil_from_tracking_ &&
        event.exists(ecal_sp_coll_name_, ecal_sp_hits_passname_)) {
      auto const& ecal_sp_hits = event.getCollection<ldmx::SimTrackerHit>(
          ecal_sp_coll_name_, ecal_sp_hits_passname_);
      double electron_pz_max = -1.0;
      for (auto const& hit : ecal_sp_hits) {
        // Look at the electron only
        if (hit.getPdgID() != 11) continue;
        double electron_z = hit.getPosition()[2];
        // Look at the SP in front of the ECAL
        if (electron_z <= 239.0 || electron_z >= 240.0) continue;
        double electron_pz = hit.getMomentum()[2];
        // Find the highest pz electron
        if (electron_pz > electron_pz_max) {
          electron_pz_max = electron_pz;
          electron_hit = &hit;
        }
      }
      // If we found an electron hit at the scoring plane
      if (electron_hit) {
        // Get electron hit position/momentum at Ecal surface
        ldmx_log(debug) << "Electron Found in the Ecal SP!";
        auto pos = electron_hit->getPosition();
        auto mom = electron_hit->getMomentum();
        ldmx_log(debug) << "ECAL SP pos_=(" << pos[0] << "," << pos[1] << ","
                        << pos[2] << ")";
        ldmx_log(debug) << "ECAL SP mom=(" << mom[0] << "," << mom[1] << ","
                        << mom[2] << ")";
        etraj = {pos[0], pos[1], pos[2]};
        double pz = mom[2];
        if (pz != 0) {
          // z_-normalized momentum
          enorm = {mom[0] / pz, mom[1] / pz, 1.0};
        }
      }
    } else if (recoil_from_tracking_) {
      // Use tracking to get electron hit position/momentum at Ecal surface
      auto recoil_tracks{event.getCollection<ldmx::Track>(track_collection_,
                                                          track_pass_name_)};
      ldmx::TrackStateType ts_at_ecal = ldmx::AtECAL;
      auto recoil_track_states_ecal =
          ecal::trackProp(recoil_tracks, ts_at_ecal, "ecal");
      if (!recoil_track_states_ecal.empty()) {
        std::array<double, 3> pos = {recoil_track_states_ecal[0],
                                     recoil_track_states_ecal[1],
                                     recoil_track_states_ecal[2]};
        std::array<double, 3> mom = {(recoil_track_states_ecal[3]),
                                     (recoil_track_states_ecal[4]),
                                     (recoil_track_states_ecal[5])};
        ldmx_log(debug) << "Electron track pos_=(" << pos[0] << "," << pos[1]
                        << "," << pos[2] << ")";
        ldmx_log(debug) << "Electron track mom=(" << mom[0] << "," << mom[1]
                        << "," << mom[2] << ")";
        etraj = pos;
        double pz = mom[2];
        if (pz != 0) {
          enorm = {mom[0] / pz, mom[1] / pz, 1.0};
        }
      } else {
        ldmx_log(info) << "  No recoil track at ECAL";
      }
    } else {
      ldmx_log(fatal) << "  No electron hit at scoring plane or no tracking";
    }
 
    if (etraj[0] == -999.) {
      // no trajectory, the model was trained on tracked events only
      result.setDiscValue(-99);
      result.setVetoResult(false);
    } else {
      // make inputs
      makeInputs(ecal_geometry, ecal_rec_hits, etraj, enorm);
      // run the DNN
      auto logits = rt_->run(INPUT_NAMES, data_)[0];
      // make a log softmax of the logits then transform back
      // to a probability with an exponential
      auto prob = std::exp((logSoftmax(logits)[1]));
      result.setDiscValue(prob);
      // cut on the logit difference, prob is 1 in float above ~17
      double logit_diff = logits[1] - logits[0];
      ldmx_log(debug) << "ParticleNet logit difference = " << logit_diff;
      result.setVetoResult(logit_diff > disc_cut_logit_);
    }
  } else {
    result.setDiscValue(-99);
    result.setVetoResult(false);
  }
 
  ldmx_log(debug) << "ParticleNet disc value = " << result.getDisc();
 
  // If the event passes the veto, keep it. Otherwise, drop the event.
  if (result.passesVeto()) {
    setStorageHint(framework::HINT_SHOULD_KEEP);
  } else {
    setStorageHint(framework::HINT_SHOULD_DROP);
  }
 
  event.add(collection_name_, result);
}

References framework::Event::exists(), ldmx::SimTrackerHit::getMomentum(), ldmx::SimTrackerHit::getPosition(), framework::HINT_SHOULD_DROP, framework::HINT_SHOULD_KEEP, ldmx::EcalVetoResult::passesVeto(), and ecal::trackProp().

Member Data Documentation

◆ collection_name_

std::string ecal::EcalPnetVetoProcessor::collection_name_ {"EcalPnetVeto"}

private

Name of the collection which will containt the results.

Definition at line 74 of file EcalPnetVetoProcessor.h.

74{"EcalPnetVeto"};

◆ COORDINATE_X_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::COORDINATE_X_OFFSET = 0

staticconstexprprivate

Definition at line 54 of file EcalPnetVetoProcessor.h.

◆ COORDINATE_Y_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::COORDINATE_Y_OFFSET = MAX_NUM_HITS

staticconstexprprivate

Definition at line 55 of file EcalPnetVetoProcessor.h.

◆ COORDINATE_Z_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::COORDINATE_Z_OFFSET = 2 * MAX_NUM_HITS

staticconstexprprivate

Definition at line 56 of file EcalPnetVetoProcessor.h.

◆ data_

std::vector<std::vector<float> > ecal::EcalPnetVetoProcessor::data_

private

Definition at line 70 of file EcalPnetVetoProcessor.h.

◆ disc_cut_logit_

double ecal::EcalPnetVetoProcessor::disc_cut_logit_ {0}

private

disc_cut as a logit difference, the probability saturates in float

Definition at line 69 of file EcalPnetVetoProcessor.h.

69{0};

◆ ecal_rec_hits_passname_

std::string ecal::EcalPnetVetoProcessor::ecal_rec_hits_passname_

private

Definition at line 77 of file EcalPnetVetoProcessor.h.

◆ ecal_sp_coll_name_

std::string ecal::EcalPnetVetoProcessor::ecal_sp_coll_name_

private

Definition at line 78 of file EcalPnetVetoProcessor.h.

◆ ecal_sp_hits_passname_

std::string ecal::EcalPnetVetoProcessor::ecal_sp_hits_passname_

private

Definition at line 79 of file EcalPnetVetoProcessor.h.

◆ FEATURE_ENERGY_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::FEATURE_ENERGY_OFFSET = 3 * MAX_NUM_HITS

staticconstexprprivate

Definition at line 62 of file EcalPnetVetoProcessor.h.

◆ FEATURE_LAYER_ID_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::FEATURE_LAYER_ID_OFFSET = 4 * MAX_NUM_HITS

staticconstexprprivate

Definition at line 63 of file EcalPnetVetoProcessor.h.

◆ FEATURE_X_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::FEATURE_X_OFFSET = 0

staticconstexprprivate

Definition at line 59 of file EcalPnetVetoProcessor.h.

◆ FEATURE_Y_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::FEATURE_Y_OFFSET = MAX_NUM_HITS

staticconstexprprivate

Definition at line 60 of file EcalPnetVetoProcessor.h.

◆ FEATURE_Z_OFFSET

unsigned int ecal::EcalPnetVetoProcessor::FEATURE_Z_OFFSET = 2 * MAX_NUM_HITS

staticconstexprprivate

Definition at line 61 of file EcalPnetVetoProcessor.h.

◆ INPUT_NAMES

const std::vector< std::string > ecal::EcalPnetVetoProcessor::INPUT_NAMES

staticprivate

Initial value:

{"points",

"features"}

Definition at line 65 of file EcalPnetVetoProcessor.h.

◆ INPUT_SIZES

const std::vector< unsigned int > ecal::EcalPnetVetoProcessor::INPUT_SIZES

staticprivate

Initial value:

{

N_COORDINATE_DIM * MAX_NUM_HITS, N_FEATURE_DIM* MAX_NUM_HITS}

Definition at line 66 of file EcalPnetVetoProcessor.h.

◆ MAX_NUM_HITS

unsigned int ecal::EcalPnetVetoProcessor::MAX_NUM_HITS = 300

staticconstexprprivate

Maximum number of hits allowed in ECAL.

Events with more hits will be marked as BKG directly without running ParticleNet.

Definition at line 51 of file EcalPnetVetoProcessor.h.

◆ N_COORDINATE_DIM

unsigned int ecal::EcalPnetVetoProcessor::N_COORDINATE_DIM = 3

staticconstexprprivate

Definition at line 53 of file EcalPnetVetoProcessor.h.

◆ N_FEATURE_DIM

unsigned int ecal::EcalPnetVetoProcessor::N_FEATURE_DIM = 5

staticconstexprprivate

Definition at line 58 of file EcalPnetVetoProcessor.h.

◆ rec_coll_name_

std::string ecal::EcalPnetVetoProcessor::rec_coll_name_

private

Definition at line 76 of file EcalPnetVetoProcessor.h.

◆ recoil_from_tracking_

bool ecal::EcalPnetVetoProcessor::recoil_from_tracking_

private

Definition at line 82 of file EcalPnetVetoProcessor.h.

◆ rt_

std::unique_ptr<ldmx::ort::ONNXRuntime> ecal::EcalPnetVetoProcessor::rt_

private

Definition at line 71 of file EcalPnetVetoProcessor.h.

◆ track_collection_

std::string ecal::EcalPnetVetoProcessor::track_collection_

private

Definition at line 81 of file EcalPnetVetoProcessor.h.

◆ track_pass_name_

std::string ecal::EcalPnetVetoProcessor::track_pass_name_

private

Definition at line 80 of file EcalPnetVetoProcessor.h.

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

Ecal/include/Ecal/EcalPnetVetoProcessor.h
Ecal/src/Ecal/EcalPnetVetoProcessor.cxx

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EcalPnetVetoProcessor()

Member Function Documentation

◆ configure()

◆ logSoftmax()

◆ makeInputs()

◆ produce()

Member Data Documentation

◆ collection_name_

◆ COORDINATE_X_OFFSET

◆ COORDINATE_Y_OFFSET

◆ COORDINATE_Z_OFFSET

◆ data_

◆ disc_cut_logit_

◆ ecal_rec_hits_passname_

◆ ecal_sp_coll_name_

◆ ecal_sp_hits_passname_

◆ FEATURE_ENERGY_OFFSET

◆ FEATURE_LAYER_ID_OFFSET

◆ FEATURE_X_OFFSET

◆ FEATURE_Y_OFFSET

◆ FEATURE_Z_OFFSET

◆ INPUT_NAMES

◆ INPUT_SIZES

◆ MAX_NUM_HITS

◆ N_COORDINATE_DIM

◆ N_FEATURE_DIM

◆ rec_coll_name_

◆ recoil_from_tracking_

◆ rt_

◆ track_collection_

◆ track_pass_name_