recon::PFEcalClusterProducer Class Reference

Public Member Functions
	PFEcalClusterProducer (const std::string &name, framework::Process &process)
virtual void	configure (framework::config::Parameters &ps)
	Callback for the EventProcessor to configure itself from the given set of parameters.
virtual void	produce (framework::Event &event)
	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
bool	singleCluster_ {true}
bool	logEnergyWeight_ {true}
float	minHitEnergy_ {0}
float	clusterHitDist_ {100.}
float	clusterZBias_ {1.}
int	minClusterHitMult_ {2}
std::string	hitCollName_
std::string	clusterCollName_
std::string	suffix_

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

Definition at line 29 of file PFEcalClusterProducer.h.

Constructor & Destructor Documentation

PFEcalClusterProducer()

recon::PFEcalClusterProducer::PFEcalClusterProducer ( const std::string &  name, framework::Process &  process  )

inline

Definition at line 31 of file PFEcalClusterProducer.h.

      : framework::Producer(name, process) {}

Member Function Documentation

configure()

void recon::PFEcalClusterProducer::configure ( framework::config::Parameters &  parameters )

virtual

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 className equal to the EventProcessor class name.

For an example, look at MyProcessor.

Parameters

parameters

Parameters for configuration.

Reimplemented from framework::EventProcessor.

Definition at line 9 of file PFEcalClusterProducer.cxx.

                                                                   {
  hitCollName_ = ps.getParameter<std::string>("hitCollName");
  clusterCollName_ = ps.getParameter<std::string>("clusterCollName");
  suffix_ = ps.getParameter<std::string>("suffix", "");
  singleCluster_ = ps.getParameter<bool>("doSingleCluster");
  logEnergyWeight_ = ps.getParameter<bool>("logEnergyWeight");
  // DBScan parameters
  minClusterHitMult_ = ps.getParameter<int>("minClusterHitMult");
  clusterHitDist_ = ps.getParameter<double>("clusterHitDist");
  clusterZBias_ = ps.getParameter<double>("clusterZBias", 1);
  minHitEnergy_ = ps.getParameter<double>("minHitEnergy");
}

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

produce()

void recon::PFEcalClusterProducer::produce ( framework::Event &  event )

virtual

Process the event and put new data products into it.

Parameters

event

The Event to process.

Implements framework::Producer.

Definition at line 22 of file PFEcalClusterProducer.cxx.

                                                         {
  if (!event.exists(hitCollName_)) return;
  const auto ecalRecHits = event.getCollection<ldmx::EcalHit>(hitCollName_);
 
  float eTotal = 0;
  for (const auto& h : ecalRecHits) eTotal += h.getEnergy();
 
  std::vector<ldmx::CaloCluster> pfClusters;
  if (!singleCluster_) {
    DBScanClusterBuilder cb(minHitEnergy_, clusterHitDist_, clusterZBias_,
                            minClusterHitMult_);
    std::vector<const ldmx::CalorimeterHit*> ptrs;
    for (const auto& h : ecalRecHits) ptrs.push_back(&h);
    std::vector<std::vector<const ldmx::CalorimeterHit*> > all_hit_ptrs =
        cb.runDBSCAN(ptrs, false);
 
    for (const auto& hit_ptrs : all_hit_ptrs) {
      ldmx::CaloCluster cl;
      cb.fillClusterInfoFromHits(&cl, hit_ptrs, logEnergyWeight_);
      pfClusters.push_back(cl);
    }
  } else {  // create a single, large cluster
 
    ldmx::CaloCluster cl;
    std::vector<const ldmx::CalorimeterHit*> ptrs;
    ptrs.reserve(ecalRecHits.size());
    for (const auto& h : ecalRecHits) {
      ptrs.push_back(&h);
    }
    DBScanClusterBuilder dummy;
    dummy.fillClusterInfoFromHits(&cl, ptrs, logEnergyWeight_);
    pfClusters.push_back(cl);
  }
 
  std::sort(pfClusters.begin(), pfClusters.end(),
            [](ldmx::CaloCluster a, ldmx::CaloCluster b) {
              return a.getEnergy() > b.getEnergy();
            });
  event.add(clusterCollName_, pfClusters);
  event.add("EcalTotalEnergy" + suffix_, eTotal);
}

References framework::Event::exists(), and ldmx::CalorimeterHit::getEnergy().

Member Data Documentation

clusterCollName_

std::string recon::PFEcalClusterProducer::clusterCollName_

private

Definition at line 50 of file PFEcalClusterProducer.h.

clusterHitDist_

float recon::PFEcalClusterProducer::clusterHitDist_ {100.}

private

Definition at line 43 of file PFEcalClusterProducer.h.

{100.};

clusterZBias_

float recon::PFEcalClusterProducer::clusterZBias_ {1.}

private

Definition at line 44 of file PFEcalClusterProducer.h.

{1.};  // private parameter for z bias

hitCollName_

std::string recon::PFEcalClusterProducer::hitCollName_

private

Definition at line 48 of file PFEcalClusterProducer.h.

logEnergyWeight_

bool recon::PFEcalClusterProducer::logEnergyWeight_ {true}

private

Definition at line 40 of file PFEcalClusterProducer.h.

{true};

minClusterHitMult_

int recon::PFEcalClusterProducer::minClusterHitMult_ {2}

private

Definition at line 45 of file PFEcalClusterProducer.h.

{2};

minHitEnergy_

float recon::PFEcalClusterProducer::minHitEnergy_ {0}

private

Definition at line 42 of file PFEcalClusterProducer.h.

{0};

singleCluster_

bool recon::PFEcalClusterProducer::singleCluster_ {true}

private

Definition at line 39 of file PFEcalClusterProducer.h.

{true};

suffix_

std::string recon::PFEcalClusterProducer::suffix_

private

Definition at line 51 of file PFEcalClusterProducer.h.

---

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

• Recon/include/Recon/PFEcalClusterProducer.h
• Recon/src/Recon/PFEcalClusterProducer.cxx