dqm::VisiblesFeatureProducer Class Reference

Public Member Functions
	VisiblesFeatureProducer (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	analyze (const framework::Event &event) override
	Process the event and make histograms or summaries.
Public Member Functions inherited from framework::Analyzer
	Analyzer (const std::string &name, Process &process)
	Class constructor.
virtual void	process (Event &event) final
	Processing an event for an Analyzer is calling analyze.
virtual void	beforeNewRun (ldmx::RunHeader &run_header) final
	Don't allow Analyzers to add parameters to the run header.
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	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
bool	inList (std::vector< int > parents, int track_id)

Private Attributes
bool	training_ {false}
std::string	training_file_
double	beam_energy_mev_ {0.}
std::string	hcal_rec_collection_
std::string	hcal_rec_pass_name_
std::string	ecal_rec_collection_
std::string	ecal_rec_pass_name_
bool	recoil_from_tracking_ {false}
std::string	track_collection_
std::string	track_pass_name_
std::string	sp_collection_
std::string	sp_pass_name_
std::string	sim_particles_coll_name_
std::string	sim_particles_pass_name_

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 17 of file VisiblesFeatureProducer.h.

Constructor & Destructor Documentation

VisiblesFeatureProducer()

dqm::VisiblesFeatureProducer::VisiblesFeatureProducer ( const std::string & name, framework::Process & process )

inline

Definition at line 19 of file VisiblesFeatureProducer.h.

      : Analyzer(name, process) {}

Member Function Documentation

analyze()

void dqm::VisiblesFeatureProducer::analyze ( const framework::Event & event )

overridevirtual

Process the event and make histograms or summaries.

Parameters

event

The Event to analyze

Implements framework::Analyzer.

Definition at line 53 of file VisiblesFeatureProducer.cxx.

                                                                 {
  std::vector<double> bdt_features;
 
  const auto &particle_map{event.getMap<int, ldmx::SimParticle>(
      sim_particles_coll_name_, sim_particles_pass_name_)};
 
  // Get target scoring plane hits for recoil electron
  // Use this to calculate the projected photon line vector
  // This currently uses truth-level information, but it should be replaced
  // by reconstructed tracker information, when available
  std::vector<double> gamma_p(3);
  std::vector<double> gamma_x0(3);
 
  std::vector<double> recoil_p(3);
  bool found_recoil_e = false;
 
  if (recoil_from_tracking_) {
    const auto &recoil_tracks{
        event.getCollection<ldmx::Track>(track_collection_, track_pass_name_)};
    // Fill this in later when you know how to use it
    for (auto &track : recoil_tracks) {
      // need to figure out how to best isolate candidate electron track
      if (track.q() == 1 && track.getNhits() == 5) {
        gamma_x0 = track.getPosition();
        gamma_p[0] = -1. * track.getMomentum()[0];
        gamma_p[1] = -1. * track.getMomentum()[1];
        gamma_p[2] = beam_energy_mev_ - track.getMomentum()[2];
      }
    }
  } else {
    if (event.exists(sp_collection_, sp_pass_name_)) {
      const auto &target_sp_hits = event.getCollection<ldmx::SimTrackerHit>(
          sp_collection_, sp_pass_name_);
      bool found_rec = false;
      for (auto const &it : particle_map) {
        for (auto const &sphit : target_sp_hits) {
          if (sphit.getPosition()[2] > 0) {
            if (it.first == sphit.getTrackID()) {
              if (it.second.getPdgID() == 622) {
                std::vector<float> x0_float = sphit.getPosition();
                std::vector<double> x0_double(x0_float.begin(), x0_float.end());
                gamma_x0 = x0_double;
                gamma_p = sphit.getMomentum();
                found_rec = true;
              }
              if (it.second.getPdgID() == 11 &&
                  inList(it.second.getParents(), 0)) {
                if (!found_rec) {
                  std::vector<float> x0_float = sphit.getPosition();
                  std::vector<double> x0_double(x0_float.begin(),
                                                x0_float.end());
                  gamma_x0 = x0_double;
                  gamma_p[0] = -1. * sphit.getMomentum()[0];
                  gamma_p[1] = -1. * sphit.getMomentum()[1];
                  gamma_p[2] = beam_energy_mev_ - sphit.getMomentum()[2];
                  found_rec = true;
                }
                recoil_p = sphit.getMomentum();
                found_recoil_e = true;
              }
            }
          }
        }
      }
    }
  }
 
  double p_mag = 0.;
  if (found_recoil_e) {
    p_mag = std::sqrt(recoil_p[0] * recoil_p[0] + recoil_p[1] * recoil_p[1] +
                      recoil_p[2] * recoil_p[2]);
  }
 
  const auto &ecal_rec_hits = event.getCollection<ldmx::EcalHit>(
      ecal_rec_collection_, ecal_rec_pass_name_);
  const auto &hcal_rec_hits = event.getCollection<ldmx::HcalHit>(
      hcal_rec_collection_, hcal_rec_pass_name_);
 
  double ecal_energy = 0.;
  double hcal_energy = 0.;
  bool hcal_containment = true;
 
  for (const ldmx::EcalHit &hit : ecal_rec_hits) {
    if (hit.getEnergy() > 0.) {
      ecal_energy += hit.getEnergy();
    }
  }
  for (const ldmx::HcalHit &hit : hcal_rec_hits) {
    if (hit.getEnergy() > 0.) {
      ldmx::HcalID det_id(hit.getID());
      if (det_id.getSection() != 0) {
        continue;
      }
      if (det_id.getLayerID() == 1 && hit.getPE() > 5) {
        hcal_containment = false;
      }
      hcal_energy += 12. * hit.getEnergy();
    }
  }
 
  if (ecal_energy < 3160 && hcal_energy > 4840 && hcal_containment &&
      p_mag < 2400) {
    // initialize all of the features
    int n_layers_hit = 0;
    double x_std = 0.;
    double y_std = 0.;
    double z_std = 0.;
    double x_mean = 0.;
    double y_mean = 0.;
    double r_mean = 0.;
    int iso_hits = 0;
    double iso_energy = 0.;
    int n_readout_hits = 0;
    double summed_det = 0.;
    double r_mean_from_photon_track = 0.;
 
    double z_mean = 0.;  // need this when calculating z_std
    std::vector<int> layers_hit;
 
    for (const ldmx::HcalHit &hit : hcal_rec_hits) {
      if (hit.getEnergy() > 0.) {
        ldmx::HcalID det_id(hit.getID());
        if (det_id.getSection() != 0) {  // skip hits that aren't in main Hcal
          continue;
        }
        if (fabs(hit.getXPos()) > 1000 || fabs(hit.getYPos()) > 1000) {
          continue;
        }
 
        n_readout_hits += 1;
        double hit_x = hit.getXPos();
        double hit_y = hit.getYPos();
        double hit_z = hit.getZPos();
        double hit_r = sqrt(hit_x * hit_x + hit_y * hit_y);
 
        summed_det += hit.getEnergy();
 
        x_mean += hit_x * hit.getEnergy();
        y_mean += hit_y * hit.getEnergy();
        z_mean += hit_z * hit.getEnergy();
        r_mean += hit_r * hit.getEnergy();
 
        // check if this is a new layer in the collection
        if (!(std::find(layers_hit.begin(), layers_hit.end(),
                        det_id.getLayerID()) != layers_hit.end())) {
          layers_hit.push_back(det_id.getLayerID());
        }
 
        double proj_x =
            gamma_x0[0] + (hit_z - gamma_x0[2]) * gamma_p[0] / gamma_p[2];
        double proj_y =
            gamma_x0[1] + (hit_z - gamma_x0[2]) * gamma_p[1] / gamma_p[2];
 
        r_mean_from_photon_track +=
            hit.getEnergy() * sqrt((hit_x - proj_x) * (hit_x - proj_x) +
                                   (hit_y - proj_y) * (hit_y - proj_y));
 
        // Calculate isolated hits
        double closest_point = 9999.;
        for (const ldmx::HcalHit &hit2 : hcal_rec_hits) {
          if (hit2.getEnergy() > 0.) {
            ldmx::HcalID det_i_d2(hit2.getID());
            if (fabs(hit2.getXPos()) > 1000 || fabs(hit2.getYPos()) > 1000) {
              continue;
            }
            if (det_i_d2.getLayerID() == det_id.getLayerID()) {
              // Determine if a bar is vertical (along y-axis) or horizontal
              // (along x-axis) Odd layers have horizontal strips Even layers
              // have vertical strips
              if (hit.isOrientationX()) {
                if (fabs(hit2.getYPos() - hit_y) > 0) {
                  if (fabs(hit2.getYPos() - hit_y) < closest_point) {
                    closest_point = fabs(hit2.getYPos() - hit_y);
                  }
                }
              }
              if (hit.isOrientationY()) {
                if (fabs(hit2.getXPos() - hit_x) > 0) {
                  if (fabs(hit2.getXPos() - hit_x) < closest_point) {
                    closest_point = fabs(hit2.getXPos() - hit_x);
                  }
                }
              }
            }
          }
        }
        if (closest_point > 50.) {
          iso_hits += 1;
          iso_energy += hit.getEnergy();
        }
      }
    }
 
    n_layers_hit = layers_hit.size();
 
    if (summed_det > 0.) {
      x_mean /= summed_det;
      y_mean /= summed_det;
      z_mean /= summed_det;
      r_mean /= summed_det;
 
      r_mean_from_photon_track /= summed_det;
    }
 
    for (const ldmx::HcalHit &hit : hcal_rec_hits) {
      if (hit.getEnergy() > 0.) {
        if (fabs(hit.getXPos()) > 1000 || fabs(hit.getYPos()) > 1000) {
          continue;
        }
        ldmx::HcalID det_id(hit.getID());
        if (det_id.getSection() == 0) {
          x_std += hit.getEnergy() * (hit.getXPos() - x_mean) *
                   (hit.getXPos() - x_mean);
          y_std += hit.getEnergy() * (hit.getYPos() - y_mean) *
                   (hit.getYPos() - y_mean);
          z_std += hit.getEnergy() * (hit.getZPos() - z_mean) *
                   (hit.getZPos() - z_mean);
        }
      }
    }
 
    if (summed_det > 0.) {
      x_std = sqrt(x_std / summed_det);
      y_std = sqrt(y_std / summed_det);
      z_std = sqrt(z_std / summed_det);
    }
 
    // Fill histograms
    histograms_.fill("layers_hit", n_layers_hit);
    histograms_.fill("x_std", x_std);
    histograms_.fill("y_std", y_std);
    histograms_.fill("z_std", z_std);
    histograms_.fill("x_mean", x_mean);
    histograms_.fill("y_mean", y_mean);
    histograms_.fill("r_mean", r_mean);
    histograms_.fill("iso_hits", iso_hits);
    histograms_.fill("iso_energy", iso_energy);
    histograms_.fill("n_hits", n_readout_hits);
    histograms_.fill("total_energy", hcal_energy);
    histograms_.fill("photon_track", r_mean_from_photon_track);
 
    bdt_features.push_back(n_layers_hit);
    bdt_features.push_back(x_std);
    bdt_features.push_back(y_std);
    bdt_features.push_back(z_std);
    bdt_features.push_back(x_mean);
    bdt_features.push_back(y_mean);
    bdt_features.push_back(r_mean);
    bdt_features.push_back(iso_hits);
    bdt_features.push_back(iso_energy);
    bdt_features.push_back(n_readout_hits);
    bdt_features.push_back(hcal_energy);
    bdt_features.push_back(r_mean_from_photon_track);
 
    if (training_) {
      std::ofstream file(training_file_, std::ios::app);
      if (!file.is_open()) {
        ldmx_log(fatal) << "Error: Could not open file " << training_file_;
        return;
      }
      for (int i = 0; i < bdt_features.size(); ++i) {
        file << bdt_features[i] << (i + 1 == bdt_features.size() ? "\n" : ", ");
      }
    }
  }
 
  return;
}

References framework::Event::exists(), framework::HistogramPool::fill(), ldmx::HcalID::getLayerID(), and framework::EventProcessor::histograms_.

configure()

void dqm::VisiblesFeatureProducer::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 22 of file VisiblesFeatureProducer.cxx.

                                           {
  training_ = parameters.get<bool>("training");
  training_file_ = parameters.get<std::string>("training_file");
 
  beam_energy_mev_ = parameters.get<double>("beam_energy");
 
  // collection names
  hcal_rec_collection_ = parameters.get<std::string>("hcal_rec_coll_name");
  hcal_rec_pass_name_ = parameters.get<std::string>("hcal_rec_pass_name");
 
  ecal_rec_collection_ = parameters.get<std::string>("ecal_rec_coll_name");
  ecal_rec_pass_name_ = parameters.get<std::string>("ecal_rec_pass_name");
 
  recoil_from_tracking_ = parameters.get<bool>("recoil_from_tracking");
  track_collection_ = parameters.get<std::string>("track_collection");
  track_pass_name_ = parameters.get<std::string>("track_pass_name");
 
  sp_collection_ = parameters.get<std::string>("sp_coll_name");
  sp_pass_name_ = parameters.get<std::string>("sp_pass_name");
 
  sim_particles_coll_name_ =
      parameters.get<std::string>("sim_particles_coll_name");
  sim_particles_pass_name_ =
      parameters.get<std::string>("sim_particles_pass_name");
}

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

inList()

bool dqm::VisiblesFeatureProducer::inList ( std::vector< int > parents, int track_id )

private

Definition at line 49 of file VisiblesFeatureProducer.cxx.

                                                                         {
  return std::find(parents.begin(), parents.end(), track_id) != parents.end();
}

Member Data Documentation

beam_energy_mev_

double dqm::VisiblesFeatureProducer::beam_energy_mev_ {0.}

private

Definition at line 32 of file VisiblesFeatureProducer.h.

{0.};

ecal_rec_collection_

std::string dqm::VisiblesFeatureProducer::ecal_rec_collection_

private

Definition at line 36 of file VisiblesFeatureProducer.h.

ecal_rec_pass_name_

std::string dqm::VisiblesFeatureProducer::ecal_rec_pass_name_

private

Definition at line 37 of file VisiblesFeatureProducer.h.

hcal_rec_collection_

std::string dqm::VisiblesFeatureProducer::hcal_rec_collection_

private

Definition at line 34 of file VisiblesFeatureProducer.h.

hcal_rec_pass_name_

std::string dqm::VisiblesFeatureProducer::hcal_rec_pass_name_

private

Definition at line 35 of file VisiblesFeatureProducer.h.

recoil_from_tracking_

bool dqm::VisiblesFeatureProducer::recoil_from_tracking_ {false}

private

Definition at line 38 of file VisiblesFeatureProducer.h.

{false};

sim_particles_coll_name_

std::string dqm::VisiblesFeatureProducer::sim_particles_coll_name_

private

Definition at line 43 of file VisiblesFeatureProducer.h.

sim_particles_pass_name_

std::string dqm::VisiblesFeatureProducer::sim_particles_pass_name_

private

Definition at line 44 of file VisiblesFeatureProducer.h.

sp_collection_

std::string dqm::VisiblesFeatureProducer::sp_collection_

private

Definition at line 41 of file VisiblesFeatureProducer.h.

sp_pass_name_

std::string dqm::VisiblesFeatureProducer::sp_pass_name_

private

Definition at line 42 of file VisiblesFeatureProducer.h.

track_collection_

std::string dqm::VisiblesFeatureProducer::track_collection_

private

Definition at line 39 of file VisiblesFeatureProducer.h.

track_pass_name_

std::string dqm::VisiblesFeatureProducer::track_pass_name_

private

Definition at line 40 of file VisiblesFeatureProducer.h.

training_

bool dqm::VisiblesFeatureProducer::training_ {false}

private

Definition at line 29 of file VisiblesFeatureProducer.h.

{false};

training_file_

std::string dqm::VisiblesFeatureProducer::training_file_

private

Definition at line 30 of file VisiblesFeatureProducer.h.

---

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

• DQM/include/DQM/VisiblesFeatureProducer.h
• DQM/src/DQM/VisiblesFeatureProducer.cxx