Inheritance diagram for cluster::ClusterPCA:

Public Types
using	ModuleType = EDAnalyzer

Public Member Functions
	ClusterPCA (fhicl::ParameterSet const &pset)

	~ClusterPCA ()

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
std::string const &	processName () const

bool	wantAllEvents () const noexcept

bool	wantEvent (ScheduleID id, Event const &e) const

Handle< TriggerResults >	getTriggerResults (Event const &e) const

ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Private Member Functions
void	PerformClusterPCA (const std::vector< art::Ptr< recob::Hit >> &HitsThisCluster, double *PrincDirectionWT, double &PrincValue, double &TotalCharge, bool NormPC)

void	analyze (art::Event const &evt)

void	beginJob ()

Private Attributes
std::string	fClusterModuleLabel

bool	fNormPC

TTree *	fTree

Int_t	fView

Float_t	fPrincDirW

Float_t	fPrincDirT

Float_t	fPrincValue

Float_t	fTotalCharge

Float_t	fNHits

Detailed Description

Definition at line 36 of file ClusterPCA_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 22 of file EDAnalyzer.h.

Constructor & Destructor Documentation

cluster::ClusterPCA::ClusterPCA ( fhicl::ParameterSet const & pset )

explicit

Definition at line 73 of file ClusterPCA_module.cc.

     : EDAnalyzer(pset)
     , fClusterModuleLabel(pset.get<std::string>("ClusterModuleLabel"))
     , fNormPC(pset.get<bool>("NormPC"))
   {}

cluster::ClusterPCA::~ClusterPCA ( )

Definition at line 80 of file ClusterPCA_module.cc.

80 {}

Member Function Documentation

void cluster::ClusterPCA::analyze ( art::Event const & evt )

privatevirtual

Implements art::EDAnalyzer.

Definition at line 97 of file ClusterPCA_module.cc.

References fClusterModuleLabel, fNHits, fNormPC, fPrincDirT, fPrincDirW, fPrincValue, fTotalCharge, fTree, fView, art::ProductRetriever::getByLabel(), geo::kU, geo::kV, geo::kZ, PerformClusterPCA(), and recob::Cluster::View().

   {
     // Get a Handle for the input Cluster object(s).
     art::Handle<std::vector<recob::Cluster>> clusterVecHandle;
     evt.getByLabel(fClusterModuleLabel, clusterVecHandle);
 
     constexpr size_t nViews = 3;
 
     // one vector of cluster index in the original collection, per view;
     // to support all present views, replace with a dynamically growing array
     std::array<std::vector<size_t>, nViews> ClsIndex;
 
     // loop over the input Clusters
     for (size_t i = 0; i < clusterVecHandle->size(); ++i) {
 
       //get a art::Ptr to each Cluster
       art::Ptr<recob::Cluster> cl(clusterVecHandle, i);
 
       switch (cl->View()) {
       case geo::kU: fView = 0; break;
       case geo::kV: fView = 1; break;
       case geo::kZ: fView = 2; break;
       default:
         mf::LogError("ClusterPCA") << "Hit belongs to an unsupported view (#" << cl->View() << ")";
         break;
       } // end switch on view
 
       ClsIndex[fView].push_back(i);
     } // end loop over input clusters
 
     art::FindManyP<recob::Hit> fm(clusterVecHandle, evt, fClusterModuleLabel);
     for (fView = 0; fView < (int)nViews; ++fView) {
 
       const std::vector<size_t>& ClsIndices = ClsIndex[fView];
 
       for (size_t c = 0; c < ClsIndices.size(); ++c) {
 
         // find the hits associated with the current cluster
         const std::vector<art::Ptr<recob::Hit>>& ptrvs = fm.at(ClsIndices[c]);
 
         double PrincDir[2], PrincValue = 0;
         double TotalCharge = 0;
 
         PerformClusterPCA(ptrvs, PrincDir, PrincValue, TotalCharge, fNormPC);
 
         fPrincDirW = PrincDir[0];
         fPrincDirT = PrincDir[1];
         fPrincValue = PrincValue;
         fTotalCharge = TotalCharge;
         fNHits = ptrvs.size();
 
         fTree->Fill();
 
       } // end loop over first cluster iterator
     }   // end loop over planes
 
     return;
 
   } // ClusterPCA::analyze()

void cluster::ClusterPCA::beginJob ( )

privatevirtual

Reimplemented from art::EDAnalyzer.

Definition at line 84 of file ClusterPCA_module.cc.

References fNHits, fPrincDirT, fPrincDirW, fPrincValue, fTotalCharge, fTree, and fView.

   {
     art::ServiceHandle<art::TFileService const> tfs;
     fTree = tfs->make<TTree>("PCATree", "PCATree");
     fTree->Branch("View", &fView, "View/I");
     fTree->Branch("PrincDirW", &fPrincDirW, "PrincDirW/F");
     fTree->Branch("PrincDirT", &fPrincDirT, "PrincDirT/F");
     fTree->Branch("PrincValue", &fPrincValue, "PrincValue/F");
     fTree->Branch("TotalCharge", &fTotalCharge, "TotalCharge/F");
     fTree->Branch("NHits", &fNHits, "fNHits/F");
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Analyzer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 25 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Analyzer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 68 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 84 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

void art::detail::Analyzer::doEndJob ( )

inherited

Definition at line 33 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Analyzer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 76 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(std::as_const(rp).makeRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 92 of file Analyzer.cc.

References art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(std::as_const(srp).makeSubRun(mc), frame);
     return true;
   }

bool art::detail::Analyzer::doEvent	(	EventPrincipal &	ep,
		ModuleContext const &	mc,
		std::atomic< std::size_t > &	counts_run,
		std::atomic< std::size_t > &	counts_passed,
		std::atomic< std::size_t > &	counts_failed
	)

inherited

Definition at line 100 of file Analyzer.cc.

References e, and art::ModuleContext::scheduleID().

Referenced by art::detail::Analyzer::Analyzer().

   {
     auto const e = std::as_const(ep).makeEvent(mc);
     if (wantEvent(mc.scheduleID(), e)) {
       ++counts_run;
       ProcessingFrame const frame{mc.scheduleID()};
       analyzeWithFrame(e, frame);
       ++counts_passed;
     }
     return true;
   }

void art::detail::Analyzer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 47 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 61 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 40 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Analyzer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 54 of file Analyzer.cc.

Referenced by art::detail::Analyzer::Analyzer().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

Handle< TriggerResults > art::Observer::getTriggerResults ( Event const & e ) const

protectedinherited

Definition at line 75 of file Observer.cc.

References art::ProductRetriever::get(), and art::Observer::selectors_.

Referenced by art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (selectors_) {
       return selectors_->getOneTriggerResults(e);
     }
 
     // The following applies for cases where no SelectEvents entries
     // exist.
     Handle<TriggerResults> h;
     if (e.get(empty_process_name, h)) {
       return h;
     }
     return Handle<TriggerResults>{};
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

void cluster::ClusterPCA::PerformClusterPCA	(	const std::vector< art::Ptr< recob::Hit >> &	HitsThisCluster,
		double *	PrincDirectionWT,
		double &	PrincValue,
		double &	TotalCharge,
		bool	NormPC
	)

private

Definition at line 169 of file ClusterPCA_module.cc.

References DEFINE_ART_MODULE, and n.

Referenced by analyze().

   {
 
     double Center[2] = {0, 0};
     TotalCharge = 0;
 
     for (auto itHit = HitsThisCluster.begin(); itHit != HitsThisCluster.end(); ++itHit) {
       Center[0] += (*itHit)->WireID().Wire;
       Center[1] += (*itHit)->PeakTime();
       TotalCharge += (*itHit)->Integral();
     }
 
     Center[0] /= float(HitsThisCluster.size());
     Center[1] /= float(HitsThisCluster.size());
 
     double WireTime[2];
 
     std::string OptionString;
 
     if (NormPC == false)
       OptionString = "D";
     else
       OptionString = "ND";
 
     TPrincipal pc(2, OptionString.c_str());
 
     for (auto itHit = HitsThisCluster.begin(); itHit != HitsThisCluster.end(); ++itHit) {
       WireTime[0] = (*itHit)->WireID().Wire - Center[0];
       WireTime[1] = (*itHit)->PeakTime() - Center[1];
 
       pc.AddRow(WireTime);
     }
 
     pc.MakePrincipals();
 
     PrincipalEigenvalue = (*pc.GetEigenValues())[0];
 
     for (size_t n = 0; n != 2; ++n) {
       PrincipalDirection[n] = (*pc.GetEigenVectors())[0][n];
     }
 
     // Comment this out if you want to shut it up
     pc.Print("MSEV");
 
     pc.Clear();
     return;
   }

string const & art::Observer::processName ( ) const

protectedinherited

Definition at line 57 of file Observer.cc.

References art::Observer::process_name_.

Referenced by art::FileDumperOutput::printPrincipal().

   {
     return process_name_;
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }

bool art::Observer::wantAllEvents ( ) const

inlineprotectednoexceptinherited

Definition at line 31 of file Observer.h.

References e, art::Observer::getTriggerResults(), art::Observer::wantAllEvents_, and art::Observer::wantEvent().

     {
       return wantAllEvents_;
     }

bool art::Observer::wantEvent	(	ScheduleID	id,
		Event const &	e
	)		const

protectedinherited

Definition at line 63 of file Observer.cc.

References art::Observer::rejectors_, art::Observer::selectors_, and art::Observer::wantAllEvents_.

Referenced by art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), and art::Observer::wantAllEvents().

   {
     if (wantAllEvents_) {
       return true;
     }
     bool const select_event = selectors_ ? selectors_->matchEvent(id, e) : true;
     bool const reject_event =
       rejectors_ ? rejectors_->matchEvent(id, e) : false;
     return select_event and not reject_event;
   }

Member Data Documentation

std::string cluster::ClusterPCA::fClusterModuleLabel

private

Definition at line 52 of file ClusterPCA_module.cc.

Referenced by analyze().

Float_t cluster::ClusterPCA::fNHits

private

Definition at line 62 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

bool cluster::ClusterPCA::fNormPC

private

Definition at line 53 of file ClusterPCA_module.cc.

Referenced by analyze().

Float_t cluster::ClusterPCA::fPrincDirT

private

Definition at line 59 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

Float_t cluster::ClusterPCA::fPrincDirW

private

Definition at line 58 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

Float_t cluster::ClusterPCA::fPrincValue

private

Definition at line 60 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

Float_t cluster::ClusterPCA::fTotalCharge

private

Definition at line 61 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

TTree* cluster::ClusterPCA::fTree

private

Definition at line 55 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

Int_t cluster::ClusterPCA::fView

private

Definition at line 57 of file ClusterPCA_module.cc.

Referenced by analyze(), and beginJob().

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

larreco/v09_25_00/source/larreco/ClusterFinder/ClusterPCA_module.cc

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation