cluster::HoughLineFinder Class Reference

Inheritance diagram for cluster::HoughLineFinder:

Public Member Functions
	HoughLineFinder (fhicl::ParameterSet const &pset)
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	produce (art::Event &evt) override

Private Attributes
std::string	fDBScanModuleLabel
unsigned int	fHoughSeed
HoughBaseAlg	fHLAlg
	object that does the Hough Transform More...
CLHEP::HepRandomEngine &	fEngine

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 45 of file HoughLineFinder_module.cc.

Constructor & Destructor Documentation

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

explicit

Definition at line 59 of file HoughLineFinder_module.cc.

    : EDProducer{pset}
    , fDBScanModuleLabel{pset.get<std::string>("DBScanModuleLabel")}
    , fHoughSeed{pset.get<unsigned int>("HoughSeed", 0)}
    , fHLAlg(pset.get<fhicl::ParameterSet>("HoughBaseAlg"))
    // Create random number engine needed for PPHT;
    // obtain the random seed from NuRandomService,
    // unless overridden in configuration with key "Seed"
    // remember that HoughSeed will override this on each event if specified
    , fEngine(art::ServiceHandle<rndm::NuRandomService> {}->createEngine(*this, pset, "Seed"))
  {
    produces<std::vector<recob::Cluster>>();
    produces<art::Assns<recob::Cluster, recob::Hit>>();
  }

Member Function Documentation

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

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 76 of file HoughLineFinder_module.cc.

  {
    //////////////////////////////////////////////////////
    // here is how to get a collection of objects out of the file
    // and connect it to a art::Handle
    //////////////////////////////////////////////////////
    auto const clusterListHandle =
      evt.getValidHandle<std::vector<recob::Cluster>>(fDBScanModuleLabel);

    std::vector<art::Ptr<recob::Cluster>> clusIn;
    clusIn.reserve(clusterListHandle->size());
    for (unsigned int ii = 0; ii < clusterListHandle->size(); ++ii) {
      clusIn.emplace_back(clusterListHandle, ii);
    }

    //Point to a collection of clusters to output.
    auto ccol = std::make_unique<std::vector<recob::Cluster>>();
    auto assn = std::make_unique<art::Assns<recob::Cluster, recob::Hit>>();

    // make a std::vector< art::PtrVector<recob::Hit> >
    // to hold the associated hits of the Hough Transform
    std::vector<art::PtrVector<recob::Hit>> clusHitsOut;

    // If a nonzero random number seed has been provided,
    // overwrite the seed already initialized
    if (fHoughSeed != 0) { fEngine.setSeed(fHoughSeed, 0); }

    size_t const numclus =
      fHLAlg.FastTransform(clusIn, *ccol, clusHitsOut, fEngine, evt, fDBScanModuleLabel);

    MF_LOG_DEBUG("HoughLineClusters") << "found " << numclus << "clusters with HoughBaseAlg";

    mf::LogVerbatim("Summary") << std::setfill('-') << std::setw(175) << "-" << std::setfill(' ');
    mf::LogVerbatim("Summary") << "HoughLineFinder Summary:";
    for (size_t i = 0; i < ccol->size(); ++i) {
      mf::LogVerbatim("Summary") << ccol->at(i);

      // associate the hits to this cluster
      util::CreateAssn(*this, evt, *ccol, clusHitsOut[i], *assn, i);
    }

    evt.put(move(ccol));
    evt.put(move(assn));
  }

Member Data Documentation

std::string cluster::HoughLineFinder::fDBScanModuleLabel

private

Definition at line 52 of file HoughLineFinder_module.cc.

CLHEP::HepRandomEngine& cluster::HoughLineFinder::fEngine

private

Definition at line 55 of file HoughLineFinder_module.cc.

HoughBaseAlg cluster::HoughLineFinder::fHLAlg

private

object that does the Hough Transform

Definition at line 54 of file HoughLineFinder_module.cc.

unsigned int cluster::HoughLineFinder::fHoughSeed

private

Definition at line 53 of file HoughLineFinder_module.cc.

---

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

• larreco/larreco/ClusterFinder/HoughLineFinder_module.cc