Inheritance diagram for cluster::SimpleClusterMerger:

Public Types
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

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

virtual	~SimpleClusterMerger ()

void	produce (art::Event &evt) override

template<typename PROD , BranchType B = InEvent>
ProductID	getProductID (std::string const &instanceName={}) const

template<typename PROD , BranchType B>
ProductID	getProductID (ModuleDescription const &moduleDescription, std::string const &instanceName) const

bool	modifiesEvent () const

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	consumes (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	consumesView (InputTag const &it)

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

template<typename T , art::BranchType BT>
art::ProductToken< T >	mayConsume (InputTag const &it)

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

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

template<typename T , art::BranchType BT>
art::ViewToken< T >	mayConsumeView (InputTag const &it)

base_engine_t &	createEngine (seed_t seed)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make)

base_engine_t &	createEngine (seed_t seed, std::string const &kind_of_engine_to_make, label_t const &engine_label)

seed_t	get_seed_value (fhicl::ParameterSet const &pset, char const key[]="seed", seed_t const implicit_seed=-1)

Static Public Member Functions
static cet::exempt_ptr< Consumer >	non_module_context ()

Protected Member Functions
CurrentProcessingContext const *	currentContext () const

void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)

void	prepareForJob (fhicl::ParameterSet const &pset)

void	showMissingConsumes () const

Private Attributes
::cmtool::CMergeHelper	fCMerge
	ClusterMergeHelper. More...

std::string	fClusterModuleLabel
	Input cluster data product producer name label. More...

::util::GeometryUtilities	fGeoU
	GeometryUtilities instance. More...

::cmtool::CBAlgoArray	fMergeAlg
	Example merging algorithm: algorithm array container. More...

::cmtool::CBAlgoShortestDist	fDistAlg
	Merging algorithm 1. More...

::cmtool::CBAlgoAngleCompat	fAngleAlg
	Merging algorithm 2. More...

::cmtool::CBAlgoTrackSeparate	fProhibitAlg
	Example prohibit algorithm. More...

Detailed Description

Definition at line 36 of file SimpleClusterMerger_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 34 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::EDProducer::Table = ProducerBase::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 43 of file EDProducer.h.

using art::EDProducer::WorkerType = WorkerT<EDProducer>

inherited

Definition at line 35 of file EDProducer.h.

Constructor & Destructor Documentation

cluster::SimpleClusterMerger::SimpleClusterMerger ( fhicl::ParameterSet const & p )

explicit

Definition at line 83 of file SimpleClusterMerger_module.cc.

References cmtool::CBAlgoArray::AddAlgo(), cmtool::CMergeManager::AddMergeAlgo(), cmtool::CMergeManager::AddSeparateAlgo(), cmtool::CMManagerBase::DebugMode(), fAngleAlg, fClusterModuleLabel, fCMerge, fDistAlg, fMergeAlg, fProhibitAlg, fhicl::ParameterSet::get(), cmtool::CMergeHelper::GetManager(), cmtool::CMManagerBase::kPerIteration, cmtool::CMManagerBase::MergeTillConverge(), cmtool::CBAlgoAngleCompat::SetAllow180Ambig(), cmtool::CBAlgoAngleCompat::SetAngleCut(), cmtool::CBAlgoTrackSeparate::SetDebug(), cmtool::CBAlgoTrackSeparate::SetMaxOpeningAngle(), cmtool::CBAlgoTrackSeparate::SetMinAngleDiff(), cmtool::CBAlgoShortestDist::SetMinHits(), cmtool::CBAlgoAngleCompat::SetMinHits(), cmtool::CBAlgoTrackSeparate::SetMinLength(), cmtool::CBAlgoTrackSeparate::SetMinNumHits(), cmtool::CBAlgoShortestDist::SetSquaredDistanceCut(), cmtool::CBAlgoTrackSeparate::SetVerbose(), and cmtool::CMAlgoBase::SetVerbose().

   {
     // Declare output data products
     produces< std::vector<recob::Cluster> >();
     produces< art::Assns<recob::Cluster, recob::Hit> >();
     
     // Fill fcl parameter
     fClusterModuleLabel = p.get<std::string>("InputClusterLabel");
 
     //--- Configure Merging Algorithm ---//
     /*
       This is where we should pass fcl parameters to configure various algorithms
       we defined as class member. Here, for simplicity, I don't pass any configuration
       parameters but you should in your custom merging module.
     */
     
     // Configure angle algorithm
     fAngleAlg.SetVerbose(false);       // no verbous mode... annoying
     fAngleAlg.SetMinHits(10);          // Set minimum # hits to be 10
     fAngleAlg.SetAngleCut(180);        // Set angle-diff cut < 180 degree (i.e. anything :))
     fAngleAlg.SetAllow180Ambig(true);  // Allow 180-degree ambiguity (direction mis-reco)
 
     // Configure distance algorithm
     fDistAlg.SetVerbose(false);        // No verbous mode ... annoying
     fDistAlg.SetMinHits(10);           // Set minimum # hits to be 10 
     fDistAlg.SetSquaredDistanceCut(9); // Set distance-squared cut to be 9 cm^2
 
     // Attach them to CBAlgoArray to make it into one merging algorithm
     fMergeAlg.AddAlgo(&fAngleAlg,true); // attach to CBAlgoArray in AND condition
     fMergeAlg.AddAlgo(&fDistAlg,true);  // attach to CBAlgoArray in AND condition
 
     //--- Configure Prohibit Algorithm ---//
 
     // I configure this using totally arbitrary numbers + I do not configure all parameters... 
     // This is just for example.
     fProhibitAlg.SetVerbose(false);
     fProhibitAlg.SetDebug(false);
     fProhibitAlg.SetMinNumHits(10);       
     fProhibitAlg.SetMinAngleDiff(5);
     fProhibitAlg.SetMaxOpeningAngle(10);
     fProhibitAlg.SetMinLength(5);
     
 
     //--- Configure Merger ---//
 
     fCMerge.GetManager(0).AddMergeAlgo(&fMergeAlg);        // Attach merging  algorithm
     fCMerge.GetManager(0).AddSeparateAlgo(&fProhibitAlg);  // Attach prohibit algorithm
     fCMerge.GetManager(0).DebugMode(::cmtool::CMergeManager::kPerIteration); // Set verbosity level to be per-merging-iteration report
     fCMerge.GetManager(0).MergeTillConverge(true);         // Set to iterate over till it finds no more newly merged clusters
 
     //
     // FYI there's an algorithm to just-merge-everything if you want to do a simple test (line commented out below)
     //
     //fCMerge.GetManager(0).AddMergeAlgo( new CBAlgoMergeAll );
 
     
   }

cluster::SimpleClusterMerger::~SimpleClusterMerger ( )

virtual

Definition at line 141 of file SimpleClusterMerger_module.cc.

   {
     // Clean up dynamic memory and other resources here.
   }

Member Function Documentation

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::consumes ( InputTag const & it )

inherited

Definition at line 147 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::consumesMany ( )

inherited

Definition at line 162 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::consumesView ( InputTag const & it )

inherited

Definition at line 172 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

EngineCreator::base_engine_t & EngineCreator::createEngine ( seed_t seed )

inherited

Definition at line 26 of file EngineCreator.cc.

References art::EngineCreator::rng().

Referenced by evgen::CosmicsGen::CosmicsGen(), rndm::NuRandomService::createEngine(), cluster::fuzzyCluster::fuzzyCluster(), cluster::HoughLineFinder::HoughLineFinder(), art::MixFilter< T >::initEngine_(), larg4::LArG4::LArG4(), evgen::LightSource::LightSource(), evgen::NeutronOsc::NeutronOsc(), evgen::NucleonDecay::NucleonDecay(), opdet::OpMCDigi::OpMCDigi(), opdet::OptDetDigitizer::OptDetDigitizer(), phot::PhotonLibraryPropagation::PhotonLibraryPropagation(), detsim::SimDriftElectrons::SimDriftElectrons(), evgen::SingleGen::SingleGen(), evgen::SNNueAr40CCGen::SNNueAr40CCGen(), ToyOneShowerGen::ToyOneShowerGen(), and trkf::Track3DKalman::Track3DKalman().

 {
   return rng()->createEngine(placeholder_schedule_id(), seed);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make
	)

inherited

Definition at line 32 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make);
 }

EngineCreator::base_engine_t & EngineCreator::createEngine	(	seed_t	seed,
		std::string const &	kind_of_engine_to_make,
		label_t const &	engine_label
	)

inherited

Definition at line 40 of file EngineCreator.cc.

References art::EngineCreator::rng().

 {
   return rng()->createEngine(
     placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
 }

CurrentProcessingContext const * art::EDProducer::currentContext ( ) const

protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

   {
     return current_context_.get();
   }

EngineCreator::seed_t EngineCreator::get_seed_value	(	fhicl::ParameterSet const &	pset,
		char const	key[] = `"seed"`,
		seed_t const	implicit_seed = `-1`
	)

inherited

Definition at line 49 of file EngineCreator.cc.

References fhicl::ParameterSet::get().

Referenced by art::MixFilter< T >::initEngine_().

 {
   auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
   return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
 }

template<typename PROD , BranchType B>

ProductID art::EDProducer::getProductID ( std::string const & instanceName = {} ) const

inlineinherited

Definition at line 123 of file EDProducer.h.

References art::EDProducer::moduleDescription_.

   {
     return ProducerBase::getProductID<PROD, B>(moduleDescription_,
                                                instanceName);
   }

template<typename PROD , BranchType B>

ProductID art::ProducerBase::getProductID	(	ModuleDescription const &	moduleDescription,
		std::string const &	instanceName
	)		const

inherited

Definition at line 56 of file ProducerBase.h.

References B, and art::ModuleDescription::moduleLabel().

Referenced by art::ProducerBase::modifiesEvent().

   {
     auto const& pd =
       get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
     return pd.productID();
   }

template<typename T , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ProductToken<T> art::Consumer::mayConsume ( InputTag const & it )

inherited

Definition at line 190 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ProductToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::Product,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ProductToken<T>{it};
 }

template<typename T , art::BranchType BT>

void art::Consumer::mayConsumeMany ( )

inherited

Definition at line 205 of file Consumer.h.

 {
   if (!moduleContext_)
     return;
 
   consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
 }

template<typename Element , BranchType = InEvent>

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

inherited

template<typename T , art::BranchType BT>

art::ViewToken<T> art::Consumer::mayConsumeView ( InputTag const & it )

inherited

Definition at line 215 of file Consumer.h.

References art::InputTag::instance(), art::InputTag::label(), and art::InputTag::process().

 {
   if (!moduleContext_)
     return ViewToken<T>::invalid();
 
   consumables_[BT].emplace_back(ConsumableType::ViewElement,
                                 TypeID{typeid(T)},
                                 it.label(),
                                 it.instance(),
                                 it.process());
   return ViewToken<T>{it};
 }

bool art::ProducerBase::modifiesEvent ( ) const

inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

     {
       return true;
     }

cet::exempt_ptr< art::Consumer > art::Consumer::non_module_context ( )

staticinherited

Definition at line 76 of file Consumer.cc.

 {
   static Consumer invalid{InvalidTag{}};
   return &invalid;
 }

void art::Consumer::prepareForJob ( fhicl::ParameterSet const & pset )

protectedinherited

Definition at line 89 of file Consumer.cc.

References fhicl::ParameterSet::get_if_present().

Referenced by art::EDProducer::doBeginJob(), art::EDFilter::doBeginJob(), and art::EDAnalyzer::doBeginJob().

 {
   if (!moduleContext_)
     return;
 
   pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
   for (auto& consumablesPerBranch : consumables_) {
     cet::sort_all(consumablesPerBranch);
   }
 }

void cluster::SimpleClusterMerger::produce ( art::Event & evt )

overridevirtual

Implements art::EDProducer.

Definition at line 146 of file SimpleClusterMerger_module.cc.

   {
     std::unique_ptr<std::vector<recob::Cluster> > out_clusters(new std::vector<recob::Cluster>);
     std::unique_ptr<art::Assns<recob::Cluster, recob::Hit> > out_assn(new art::Assns<recob::Cluster, recob::Hit>);
     
     art::ServiceHandle<geo::Geometry> geo;
 
     //
     // Preparation
     //
 
     // Retrieve input clusters
     art::Handle<std::vector<recob::Cluster> > cHandle;
     evt.getByLabel(fClusterModuleLabel,cHandle);
 
     if(!cHandle.isValid())
       throw cet::exception(__FUNCTION__) << "Invalid input cluster label!" << std::endl;
 
     // Cluster type conversion: recob::Hit => util::PxHit 
     std::vector<std::vector< ::util::PxHit> > local_clusters;
     art::FindManyP<recob::Hit> hit_m(cHandle, evt, fClusterModuleLabel);
     ::util::PxHitConverter conv;
     for(size_t i=0; i<cHandle->size(); ++i) {
 
       local_clusters.push_back(std::vector< ::util::PxHit>());
 
       const std::vector<art::Ptr<recob::Hit> >& hits = hit_m.at(i);
 
       conv.GeneratePxHit(hits, local_clusters.back());
     }
     
     //--- Process merging ---//
     fCMerge.Process(local_clusters);
     
     // Store output
     auto merged_clusters = fCMerge.GetResult().GetResult();
 
     auto const& cpan_v = fCMerge.GetClusters();
     if(merged_clusters.size()!=cpan_v.size())
 
       throw cet::exception(__FUNCTION__) << "LOGIC ERROR: merged cluster id length != output cluster counts..." << std::endl;
 
     for(size_t out_index=0; out_index < merged_clusters.size(); ++out_index) {
       
       // To save typing let's just retrieve const cluster_params instance
       const cluster_params &res = cpan_v[out_index].GetParams();
       
       // this "algo" is actually parroting its cluster_params
       LazyClusterParamsAlg algo(res);
       
       std::vector<art::Ptr<recob::Hit> > merged_hits;
       for(auto const& c_index : merged_clusters[out_index]) {
         const std::vector<art::Ptr<recob::Hit> >& hits = hit_m.at(c_index);
         merged_hits.reserve(merged_hits.size() + hits.size());
         for(auto const& ptr : hits) merged_hits.push_back(ptr);
       }
       
       // the full plane needed but not a part of cluster_params...
       // get the one from the first hit
       geo::PlaneID plane; // invalid by default
       if (!merged_hits.empty()) plane = merged_hits.front()->WireID().planeID();
       
       // View_t needed but not a part of cluster_params, so retrieve it here
       geo::View_t view_id = geo->Plane(plane).View();
       
       // Push back a new cluster data product with parameters copied from cluster_params
       out_clusters->emplace_back(
         res.start_point.w / fGeoU.WireToCm(), // start_wire
         0.,                                   // sigma_start_wire
         res.start_point.t / fGeoU.TimeToCm(), // start_tick
         0.,                                   // sigma_start_tick
         algo.StartCharge().value(),           // start_charge
         algo.StartAngle().value(),            // start_angle
         algo.StartOpeningAngle().value(),     // start_opening
         res.end_point.w   / fGeoU.WireToCm(), // end_wire
         0.,                                   // sigma_end_wire
         res.end_point.t   / fGeoU.TimeToCm(), // end_tick
         0.,                                   // sigma_end_tick
         algo.EndCharge().value(),             // end_charge
         algo.EndAngle().value(),              // end_angle
         algo.EndOpeningAngle().value(),       // end_opening
         algo.Integral().value(),              // integral
         algo.IntegralStdDev().value(),        // integral_stddev
         algo.SummedADC().value(),             // summedADC
         algo.SummedADCStdDev().value(),       // summedADC_stddev
         algo.NHits(),                         // n_hits
         algo.MultipleHitDensity(),              // multiple_hit_density
         algo.Width(),                         // width
         out_clusters->size(),                 // ID
         view_id,                              // view
         plane,                                // plane
         recob::Cluster::Sentry                // sentry
         );
       
       util::CreateAssn(*this, 
                        evt, 
                        *(out_clusters.get()), 
                        merged_hits,
                        *(out_assn.get())
                        );
 
     }
     
   evt.put(std::move(out_clusters));
   evt.put(std::move(out_assn));
   }

void art::Consumer::showMissingConsumes ( ) const

protectedinherited

Definition at line 125 of file Consumer.cc.

Referenced by art::EDProducer::doEndJob(), art::EDFilter::doEndJob(), art::EDAnalyzer::doEndJob(), and art::RootOutput::endJob().

 {
   if (!moduleContext_)
     return;
 
   // If none of the branches have missing consumes statements, exit early.
   if (std::all_of(cbegin(missingConsumes_),
                   cend(missingConsumes_),
                   [](auto const& perBranch) { return perBranch.empty(); }))
     return;
 
   constexpr cet::HorizontalRule rule{60};
   mf::LogPrint log{"MTdiagnostics"};
   log << '\n'
       << rule('=') << '\n'
       << "The following consumes (or mayConsume) statements are missing from\n"
       << module_context(moduleDescription_) << '\n'
       << rule('-') << '\n';
 
   cet::for_all_with_index(
     missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
       for (auto const& pi : perBranch) {
         log << "  "
             << assemble_consumes_statement(static_cast<BranchType>(i), pi)
             << '\n';
       }
     });
   log << rule('=');
 }

void art::Consumer::validateConsumedProduct	(	BranchType const	bt,
		ProductInfo const &	pi
	)

protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

 {
   // Early exits if consumes tracking has been disabled or if the
   // consumed product is an allowed consumable.
   if (!moduleContext_)
     return;
 
   if (cet::binary_search_all(consumables_[bt], pi))
     return;
 
   if (requireConsumes_) {
     throw Exception(errors::ProductRegistrationFailure,
                     "Consumer: an error occurred during validation of a "
                     "retrieved product\n\n")
       << "The following consumes (or mayConsume) statement is missing from\n"
       << module_context(moduleDescription_) << ":\n\n"
       << "  " << assemble_consumes_statement(bt, pi) << "\n\n";
   }
 
   missingConsumes_[bt].insert(pi);
 }