Inheritance diagram for gar::rec::CaloClustering:

Public Member Functions
	CaloClustering (fhicl::ParameterSet const &p)

	CaloClustering (CaloClustering const &)=delete

	CaloClustering (CaloClustering &&)=delete

CaloClustering &	operator= (CaloClustering const &)=delete

CaloClustering &	operator= (CaloClustering &&)=delete

void	produce (art::Event &e) override

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

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)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

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)

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

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

Private Member Functions
void	CollectTracks (const art::Event &evt, const std::string &label, std::vector< art::Ptr< gar::rec::Track > > &trkVector)

void	CollectHits (const art::Event &evt, const std::string &label, const std::string &instance, std::vector< art::Ptr< gar::rec::CaloHit > > &hitVector)

Private Attributes
std::string	fTrackLabel
	label to find the reco tracks More...

std::string	fCaloHitLabel
	label to find the right reco calo hits More...

std::string	fInstanceName
	product instance name More...

const detinfo::DetectorProperties *	fDetProp
	detector properties More...

const geo::GeometryCore *	fGeo
	pointer to the geometry More...

std::unique_ptr< rec::alg::KNNClusterAlg >	fClusterAlgo

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
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 ()

Detailed Description

Definition at line 41 of file CaloClustering_module.cc.

Constructor & Destructor Documentation

gar::rec::CaloClustering::CaloClustering ( fhicl::ParameterSet const & p )

explicit

Definition at line 73 of file CaloClustering_module.cc.

                                                                   : EDProducer{p}
         {
             fTrackLabel = p.get<std::string>("TrackLabel", "track");
             fCaloHitLabel = p.get<std::string>("CaloHitLabel", "calohit");
             fInstanceName =  p.get<std::string >("InstanceLabelName", "");
 
             fGeo     = gar::providerFrom<geo::GeometryGAr>();
             fDetProp = gar::providerFrom<detinfo::DetectorPropertiesService>();
 
             //configure the cluster algorithm
             auto fClusterAlgoPars = p.get<fhicl::ParameterSet>("ClusterAlgPars");
             fClusterAlgo = std::make_unique<rec::alg::KNNClusterAlg>(fClusterAlgoPars);
 
             art::InputTag tag(fCaloHitLabel, fInstanceName);
             consumes<std::vector<gar::rec::CaloHit>>(tag);
             produces< std::vector<gar::rec::Cluster> >(fInstanceName);
             produces< art::Assns<gar::rec::Cluster, gar::rec::CaloHit> >(fInstanceName);
             if (fClusterAlgo->usesTracks()) produces< art::Assns<gar::rec::Cluster, gar::rec::Track> >(fInstanceName);
         }

gar::rec::CaloClustering::CaloClustering ( CaloClustering const & )

delete

gar::rec::CaloClustering::CaloClustering ( CaloClustering && )

delete

Member Function Documentation

void gar::rec::CaloClustering::CollectHits	(	const art::Event &	evt,
		const std::string &	label,
		const std::string &	instance,
		std::vector< art::Ptr< gar::rec::CaloHit > > &	hitVector
	)

private

Definition at line 175 of file CaloClustering_module.cc.

         {
             art::InputTag itag(label,instance);
             auto theHits = evt.getHandle< std::vector<gar::rec::CaloHit> >(itag);
             if (!theHits) return;
 
             for (unsigned int i = 0; i < theHits->size(); ++i)
             {
                 const art::Ptr<gar::rec::CaloHit> hit(theHits, i);
                 hitVector.push_back(hit);
             }
         }

void gar::rec::CaloClustering::CollectTracks	(	const art::Event &	evt,
		const std::string &	label,
		std::vector< art::Ptr< gar::rec::Track > > &	trkVector
	)

private

Definition at line 188 of file CaloClustering_module.cc.

         {
             auto theTracks = evt.getHandle< std::vector<gar::rec::Track> >(label);
             if (!theTracks) return;
 
             for (unsigned int i = 0; i < theTracks->size(); ++i)
             {
                 const art::Ptr<gar::rec::Track> track(theTracks, i);
                 trkVector.push_back(track);
             }
         }

CaloClustering& gar::rec::CaloClustering::operator= ( CaloClustering const & )

delete

CaloClustering& gar::rec::CaloClustering::operator= ( CaloClustering && )

delete

void gar::rec::CaloClustering::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 93 of file CaloClustering_module.cc.

         {
             //maps of the hit/track pointer to art ptr pointers
             std::unordered_map< const gar::rec::CaloHit*, art::Ptr<gar::rec::CaloHit> > hitMaptoArtPtr;
             std::unordered_map< const gar::rec::Track*, art::Ptr<gar::rec::Track> > trkMaptoArtPtr;
 
             //Collect the tracks to be passed to the algo.  As of Jun 2019, the algo doesn't need tracks.
             //But maybe someday it will!
             std::vector< art::Ptr<gar::rec::Track> > artTrk;
             if (fClusterAlgo->usesTracks())
                 this->CollectTracks(e, fTrackLabel, artTrk);
 
             //Collect the hits to be passed to the algo
             std::vector< art::Ptr<gar::rec::CaloHit> > artHits;
             this->CollectHits(e, fCaloHitLabel, fInstanceName, artHits);
 
             //Prepare the hits for clustering (tag isolated hits and possible mip hits)
             //artTrk and trkMaptoArtPtr will be empty if ( !fClusterAlgo->usesTracks() )
             fClusterAlgo->PrepareAlgo(artTrk, artHits, trkMaptoArtPtr, hitMaptoArtPtr);
             //Perform the clustering
             fClusterAlgo->DoClustering();
             //Get back the cluster results
             std::vector< gar::rec::Cluster* > ClusterVec = fClusterAlgo->GetFoundClusters();
 
             // make an art::PtrVector of the clusters
             std::unique_ptr< std::vector<gar::rec::Cluster> > ClusterCol(new std::vector<gar::rec::Cluster>);
             std::unique_ptr< art::Assns<gar::rec::Cluster, gar::rec::CaloHit> > ClusterHitAssns(new art::Assns<gar::rec::Cluster, gar::rec::CaloHit>);
             std::unique_ptr< art::Assns<gar::rec::Cluster, gar::rec::Track> > ClusterTrackAssns(new art::Assns<gar::rec::Cluster, gar::rec::Track>);
 
             art::PtrMaker<gar::rec::Cluster> makeClusterPtr(e, fInstanceName);
 
             MF_LOG_DEBUG("CaloClustering_module")
             << "Found " << ClusterVec.size() << " Clusters";
 
             //Copy the clusters to the collection
             for(auto const &it : ClusterVec)
             {
                 MF_LOG_DEBUG("CaloClustering_module")
                 << "Cluster has " << it->CalorimeterHits().size() << " calo hits";
 
                 ClusterCol->emplace_back(*it);
 
                 art::Ptr<gar::rec::Cluster> clusterPtr = makeClusterPtr(ClusterCol->size() - 1);
 
                 //get list of hits associated to the cluster
                 const std::vector< gar::rec::CaloHit* > hitVec = it->CalorimeterHits();
                 for (size_t i=0; i<hitVec.size(); ++i)
                 {
                     const gar::rec::CaloHit* pCaloHit = hitVec[i];
                     //Need to find the corresponding art ptr in the map
                     if(hitMaptoArtPtr.find(pCaloHit) != hitMaptoArtPtr.end())
                     {
                         // associate the hits to this cluster
                         art::Ptr<gar::rec::CaloHit> hitpointer = hitMaptoArtPtr[pCaloHit];
                         ClusterHitAssns->addSingle(clusterPtr, hitpointer);
                     }
                 }
 
                 if (fClusterAlgo->usesTracks()) {
                                     //get list of track associated to the cluster
                     const std::vector< gar::rec::Track* > trkVec = it->Tracks();
                     for(const gar::rec::Track *const pTrack : trkVec)
                     {
                         //Need to find the corresponding art ptr in the map
                         if(trkMaptoArtPtr.find(pTrack) != trkMaptoArtPtr.end())
                         {
                             // associate the hits to this cluster
                             art::Ptr<gar::rec::Track> trkpointer = trkMaptoArtPtr[pTrack];
                             ClusterTrackAssns->addSingle(clusterPtr, trkpointer);
                         }
                     }
                 }
             }
 
             e.put(std::move(ClusterCol), fInstanceName);
             e.put(std::move(ClusterHitAssns), fInstanceName);
             if (fClusterAlgo->usesTracks())
                 e.put(std::move(ClusterTrackAssns), fInstanceName);
 
             return;
         }

Member Data Documentation

std::string gar::rec::CaloClustering::fCaloHitLabel

private

label to find the right reco calo hits

Definition at line 63 of file CaloClustering_module.cc.

std::unique_ptr<rec::alg::KNNClusterAlg> gar::rec::CaloClustering::fClusterAlgo

private

Definition at line 69 of file CaloClustering_module.cc.

const detinfo::DetectorProperties* gar::rec::CaloClustering::fDetProp

private

detector properties

Definition at line 66 of file CaloClustering_module.cc.

const geo::GeometryCore* gar::rec::CaloClustering::fGeo

private

pointer to the geometry

Definition at line 67 of file CaloClustering_module.cc.

std::string gar::rec::CaloClustering::fInstanceName

private

product instance name

Definition at line 64 of file CaloClustering_module.cc.

std::string gar::rec::CaloClustering::fTrackLabel

private

label to find the reco tracks

Definition at line 62 of file CaloClustering_module.cc.

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

garsoft/Reco/CaloClustering_module.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation