ecal::EcalClusterProducer Class Reference

Simple algorithm that does clustering in the ECal. More...

#include <EcalClusterProducer.h>

Public Member Functions
	EcalClusterProducer (const std::string &name, framework::Process &process)
void	configure (framework::config::Parameters &parameters) override
	Configure the processor using the given user specified 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 Attributes
double	seed_threshold_ {0}
double	cutoff_ {0}
double	dc_ {0}
double	rhoc_ {0}
double	deltac_ {0}
double	deltao_ {0}
float	min_hit_energy_ {1.}
std::string	rec_hit_coll_name_
std::string	rec_hit_pass_name_
std::string	algo_coll_name_
std::string	cluster_coll_name_
bool	clue_
int	nbr_of_layers_
bool	reclustering_
TString	algo_name_
	The name of the cluster algorithm used.

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

Simple algorithm that does clustering in the ECal.

Definition at line 44 of file EcalClusterProducer.h.

Constructor & Destructor Documentation

EcalClusterProducer()

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

Definition at line 13 of file EcalClusterProducer.cxx.

    : Producer(name, process) {}

Member Function Documentation

configure()

void ecal::EcalClusterProducer::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 17 of file EcalClusterProducer.cxx.

                                                                 {
  cutoff_ = ps.get<double>("cutoff");
  seed_threshold_ = ps.get<double>("seed_threshold");
 
  dc_ = ps.get<double>("dc");
  rhoc_ = ps.get<double>("rhoc");
  deltac_ = ps.get<double>("deltac");
  deltao_ = ps.get<double>("deltao");
 
  rec_hit_coll_name_ = ps.get<std::string>("rec_hit_coll_name");
  rec_hit_pass_name_ = ps.get<std::string>("rec_hit_pass_name");
  algo_coll_name_ = ps.get<std::string>("algo_coll_name");
  algo_name_ = ps.get<std::string>("algo_name");
  cluster_coll_name_ = ps.get<std::string>("cluster_coll_name");
  clue_ = ps.get<bool>("CLUE");
  nbr_of_layers_ = ps.get<int>("nbr_of_layers");
  reclustering_ = ps.get<bool>("reclustering");
}

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

produce()

void ecal::EcalClusterProducer::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 36 of file EcalClusterProducer.cxx.

                                                       {
  const auto& ecal_hits{event.getCollection<ldmx::EcalHit>(rec_hit_coll_name_,
                                                           rec_hit_pass_name_)};
  if (ecal_hits.size() == 0) {
    // don't do anything if there are no ECal hits
    ldmx_log(fatal) << "No ECal hits found... exiting";
    return;
  }
 
  if (clue_) {
    ldmx_log(info) << "Using CLUE clustering algorithm";
    CLUE cf;
    cf.cluster(ecal_hits, dc_, rhoc_, deltac_, deltao_, nbr_of_layers_,
               reclustering_);
    ldmx_log(debug) << "CLUE algorithm finished clustering";
    std::vector<IntermediateCluster> interm_cluster = cf.getClusters();
    std::vector<IntermediateCluster> f_interm_cluster =
        cf.getFirstLayerCentroids();
    ldmx_log(debug) << "Got " << interm_cluster.size() << " clusters with "
                    << f_interm_cluster.size() << " first layer centroids";
 
    auto n_loops = cf.getNLoops();
    ldmx_log(debug) << "Number of clustering loops: " << n_loops;
 
    if (reclustering_) {
      ldmx_log(debug) << "Reclustererd initial number of clusters: "
                      << cf.getInitialClusterNbr()
                      << ", final number of clusters: "
                      << interm_cluster.size();
    }
 
    std::vector<ldmx::EcalCluster> ecal_clusters;
    ldmx_log(debug) << "Filling " << interm_cluster.size()
                    << " clusters into ecal_clusters";
    for (int cluster_indx = 0; cluster_indx < interm_cluster.size();
         cluster_indx++) {
      ldmx::EcalCluster cluster;
 
      cluster.setEnergy(interm_cluster[cluster_indx].centroid().E());
      cluster.setCentroidXYZ(interm_cluster[cluster_indx].centroid().x(),
                             interm_cluster[cluster_indx].centroid().y(),
                             interm_cluster[cluster_indx].centroid().z());
      cluster.setFirstLayerCentroidXYZ(
          f_interm_cluster[cluster_indx].centroid().x(),
          f_interm_cluster[cluster_indx].centroid().y(),
          f_interm_cluster[cluster_indx].centroid().z());
      cluster.setNHits(interm_cluster[cluster_indx].getHits().size());
      cluster.addHits(interm_cluster[cluster_indx].getHits());
      cluster.addFirstLayerHits(f_interm_cluster[cluster_indx].getHits());
 
      float cl_x(0), cl_y(0), cl_z(0), cl_xx(0), cl_yy(0), cl_zz(0);
      float cl_w = 1;  // weight
      float sumw = 0;
 
      for (auto hit : interm_cluster[cluster_indx].getHits()) {
        if (hit->getEnergy() < min_hit_energy_) continue;
        cl_w = log(hit->getEnergy()) - log(min_hit_energy_);
        cl_x += cl_w * hit->getXPos();
        cl_y += cl_w * hit->getYPos();
        cl_z += cl_w * hit->getZPos();
        cl_xx += cl_w * hit->getXPos() * hit->getXPos();
        cl_yy += cl_w * hit->getYPos() * hit->getYPos();
        cl_zz += cl_w * hit->getZPos() * hit->getZPos();
        sumw += cl_w;
      }  // over hits
      // could probably get this as cluster.getCentroidX() instead
      cl_x /= sumw;  // now is <x_>
      cl_y /= sumw;
      cl_z /= sumw;
      cl_xx /= sumw;  // now is <x_^2>
      cl_yy /= sumw;
      cl_zz /= sumw;
      cl_xx = sqrt(cl_xx - cl_x * cl_x);  // now is sqrt(<x_^2>-<x_>^2)
      cl_yy = sqrt(cl_yy - cl_y * cl_y);
      cl_zz = sqrt(cl_zz - cl_z * cl_z);
 
      cluster.setRMSXYZ(cl_xx, cl_yy, cl_zz);
      cluster.setLayer(interm_cluster[cluster_indx].getLayer());
      ldmx_log(trace) << "Cluster " << cluster_indx
                      << " energy: " << cluster.getEnergy()
                      << ", nHits: " << cluster.getNHits() << ", centroid: ("
                      << cluster.getCentroidX() << ", "
                      << cluster.getCentroidY() << ", "
                      << cluster.getCentroidZ() << "), " << "RMS : ("
                      << cluster.getRMSX() << ", " << cluster.getRMSY() << ", "
                      << cluster.getRMSZ() << ")" << ", first layer centroid: ("
                      << cluster.getFirstLayerCentroidX() << ", "
                      << cluster.getFirstLayerCentroidY() << ", "
                      << cluster.getFirstLayerCentroidZ() << ")";
 
      ecal_clusters.push_back(cluster);
    }
    ldmx_log(debug) << "Filled " << ecal_clusters.size()
                    << " clusters into ecal_clusters";
    event.add(cluster_coll_name_, ecal_clusters);
  } else {
    ldmx_log(info) << "Using simple clustering algorithm " << algo_name_;
    TemplatedClusterFinder<MyClusterWeight> cf;
 
    for (const ldmx::EcalHit& hit : ecal_hits) {
      // Skip zero energy digis.
      if (hit.getEnergy() == 0) {
        continue;
      }
      cf.add(hit);
    }
 
    cf.cluster(seed_threshold_, cutoff_);
    std::vector<IntermediateCluster> interm_cluster = cf.getClusters();
    std::map<int, double> c_weights = cf.getWeights();
 
    ldmx::ClusterAlgoResult algo_result;
    algo_result.set(algo_name_, 3, c_weights.rbegin()->first);
    algo_result.setAlgoVar(0, cutoff_);
    algo_result.setAlgoVar(1, seed_threshold_);
    algo_result.setAlgoVar(2, cf.getNSeeds());
 
    std::map<int, double>::iterator it = c_weights.begin();
    for (it = c_weights.begin(); it != c_weights.end(); it++) {
      algo_result.setWeight(it->first, it->second / 100);
    }
 
    std::vector<ldmx::EcalCluster> ecal_clusters;
    for (int cluster_indx = 0; cluster_indx < interm_cluster.size();
         cluster_indx++) {
      ldmx::EcalCluster cluster;
 
      cluster.setEnergy(interm_cluster[cluster_indx].centroid().E());
      cluster.setCentroidXYZ(interm_cluster[cluster_indx].centroid().x(),
                             interm_cluster[cluster_indx].centroid().y(),
                             interm_cluster[cluster_indx].centroid().z());
      cluster.setLayer(interm_cluster[cluster_indx].getLayer());
      std::cout << "Cluster layer: " << cluster.getLayer() << std::endl;
      cluster.setNHits(interm_cluster[cluster_indx].getHits().size());
      cluster.addHits(interm_cluster[cluster_indx].getHits());
      ecal_clusters.push_back(cluster);
    }
 
    event.add(cluster_coll_name_, ecal_clusters);
    event.add(algo_coll_name_, algo_result);
  }  // end on simple clustering
}

References ldmx::EcalCluster::addHits(), ldmx::CaloCluster::getCentroidX(), ldmx::CaloCluster::getCentroidY(), ldmx::CaloCluster::getCentroidZ(), ldmx::CaloCluster::getLayer(), ldmx::CaloCluster::getRMSX(), ldmx::CaloCluster::getRMSY(), ldmx::CaloCluster::getRMSZ(), ldmx::ClusterAlgoResult::set(), ldmx::ClusterAlgoResult::setAlgoVar(), ldmx::CaloCluster::setCentroidXYZ(), ldmx::CaloCluster::setEnergy(), ldmx::CaloCluster::setNHits(), and ldmx::ClusterAlgoResult::setWeight().

Member Data Documentation

algo_coll_name_

std::string ecal::EcalClusterProducer::algo_coll_name_

private

Definition at line 71 of file EcalClusterProducer.h.

algo_name_

TString ecal::EcalClusterProducer::algo_name_

private

The name of the cluster algorithm used.

Definition at line 79 of file EcalClusterProducer.h.

clue_

bool ecal::EcalClusterProducer::clue_

private

Definition at line 74 of file EcalClusterProducer.h.

cluster_coll_name_

std::string ecal::EcalClusterProducer::cluster_coll_name_

private

Definition at line 72 of file EcalClusterProducer.h.

cutoff_

double ecal::EcalClusterProducer::cutoff_ {0}

private

Definition at line 60 of file EcalClusterProducer.h.

{0};

dc_

double ecal::EcalClusterProducer::dc_ {0}

private

Definition at line 62 of file EcalClusterProducer.h.

{0};

deltac_

double ecal::EcalClusterProducer::deltac_ {0}

private

Definition at line 64 of file EcalClusterProducer.h.

{0};

deltao_

double ecal::EcalClusterProducer::deltao_ {0}

private

Definition at line 65 of file EcalClusterProducer.h.

{0};

min_hit_energy_

float ecal::EcalClusterProducer::min_hit_energy_ {1.}

private

Definition at line 67 of file EcalClusterProducer.h.

{1.};

nbr_of_layers_

int ecal::EcalClusterProducer::nbr_of_layers_

private

Definition at line 75 of file EcalClusterProducer.h.

rec_hit_coll_name_

std::string ecal::EcalClusterProducer::rec_hit_coll_name_

private

Definition at line 69 of file EcalClusterProducer.h.

rec_hit_pass_name_

std::string ecal::EcalClusterProducer::rec_hit_pass_name_

private

Definition at line 70 of file EcalClusterProducer.h.

reclustering_

bool ecal::EcalClusterProducer::reclustering_

private

Definition at line 76 of file EcalClusterProducer.h.

rhoc_

double ecal::EcalClusterProducer::rhoc_ {0}

private

Definition at line 63 of file EcalClusterProducer.h.

{0};

seed_threshold_

double ecal::EcalClusterProducer::seed_threshold_ {0}

private

Definition at line 59 of file EcalClusterProducer.h.

{0};

---

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

• Ecal/include/Ecal/EcalClusterProducer.h
• Ecal/src/Ecal/EcalClusterProducer.cxx