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.
virtual 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	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
double	seedThreshold_ {0}
double	cutoff_ {0}
std::string	digisPassName_
std::string	algoCollName_
std::string	clusterCollName_
TString	algoName_
	The name of the cluster algorithm used.

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

Simple algorithm that does clustering in the ECal.

Definition at line 45 of file EcalClusterProducer.h.

Constructor & Destructor Documentation

EcalClusterProducer()

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

Definition at line 11 of file EcalClusterProducer.cxx.

    : Producer(name, process) {}

~EcalClusterProducer()

ecal::EcalClusterProducer::~EcalClusterProducer ( )

virtual

Definition at line 15 of file EcalClusterProducer.cxx.

{}

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_ = parameters.getParameter<double>("cutoff");
  seedThreshold_ = parameters.getParameter<double>("seedThreshold");
  digisPassName_ = parameters.getParameter<std::string>("digisPassName");
  algoCollName_ = parameters.getParameter<std::string>("algoCollName");
  algoName_ = parameters.getParameter<std::string>("algoName");
  clusterCollName_ = parameters.getParameter<std::string>("clusterCollName");
}

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

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 26 of file EcalClusterProducer.cxx.

                                                       {
  // Get the Ecal Geometry
  const auto& geometry = getCondition<ldmx::EcalGeometry>(
      ldmx::EcalGeometry::CONDITIONS_OBJECT_NAME);
 
  TemplatedClusterFinder<MyClusterWeight> cf;
 
  std::vector<ldmx::EcalHit> ecalHits =
      event.getCollection<ldmx::EcalHit>("ecalDigis", digisPassName_);
  int nEcalDigis = ecalHits.size();
 
  // Don't do anything if there are no ECal digis!
  if (!(nEcalDigis > 0)) {
    return;
  }
 
  for (ldmx::EcalHit& hit : ecalHits) {
    // Skip zero energy digis.
    if (hit.getEnergy() == 0) {
      continue;
    }
 
    cf.add(&hit, geometry);
  }
 
  cf.cluster(seedThreshold_, cutoff_);
  std::vector<WorkingCluster> wcVec = cf.getClusters();
 
  std::map<int, double> cWeights = cf.getWeights();
 
  ldmx::ClusterAlgoResult algoResult;
  algoResult.set(algoName_, 3, cWeights.rbegin()->first);
  algoResult.setAlgoVar(0, cutoff_);
  algoResult.setAlgoVar(1, seedThreshold_);
  algoResult.setAlgoVar(2, cf.getNSeeds());
 
  std::map<int, double>::iterator it = cWeights.begin();
  for (it = cWeights.begin(); it != cWeights.end(); it++) {
    algoResult.setWeight(it->first, it->second / 100);
  }
 
  std::vector<ldmx::EcalCluster> ecalClusters;
  for (int aWC = 0; aWC < wcVec.size(); aWC++) {
    ldmx::EcalCluster cluster;
 
    cluster.setEnergy(wcVec[aWC].centroid().E());
    cluster.setCentroidXYZ(wcVec[aWC].centroid().Px(),
                           wcVec[aWC].centroid().Py(),
                           wcVec[aWC].centroid().Pz());
    cluster.setNHits(wcVec[aWC].getHits().size());
    cluster.addHits(wcVec[aWC].getHits());
 
    ecalClusters.push_back(cluster);
  }
 
  event.add(clusterCollName_, ecalClusters);
  event.add(algoCollName_, algoResult);
}

References ldmx::EcalCluster::addHits(), ldmx::ClusterAlgoResult::set(), ldmx::ClusterAlgoResult::setAlgoVar(), ldmx::CaloCluster::setCentroidXYZ(), ldmx::CaloCluster::setEnergy(), ldmx::CaloCluster::setNHits(), and ldmx::ClusterAlgoResult::setWeight().

Member Data Documentation

algoCollName_

std::string ecal::EcalClusterProducer::algoCollName_

private

Definition at line 64 of file EcalClusterProducer.h.

algoName_

TString ecal::EcalClusterProducer::algoName_

private

The name of the cluster algorithm used.

Definition at line 68 of file EcalClusterProducer.h.

clusterCollName_

std::string ecal::EcalClusterProducer::clusterCollName_

private

Definition at line 65 of file EcalClusterProducer.h.

cutoff_

double ecal::EcalClusterProducer::cutoff_ {0}

private

Definition at line 62 of file EcalClusterProducer.h.

{0};

digisPassName_

std::string ecal::EcalClusterProducer::digisPassName_

private

Definition at line 63 of file EcalClusterProducer.h.

seedThreshold_

double ecal::EcalClusterProducer::seedThreshold_ {0}

private

Definition at line 61 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