cluster::SimpleLineCluster Class Reference

Inheritance diagram for cluster::SimpleLineCluster:

Public Types
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = ProducerBase::Table< UserConfig, KeysToIgnore >

Public Member Functions
	SimpleLineCluster (fhicl::ParameterSet const &p)
	SimpleLineCluster (SimpleLineCluster const &)=delete
	SimpleLineCluster (SimpleLineCluster &&)=delete
SimpleLineCluster &	operator= (SimpleLineCluster const &)=delete
SimpleLineCluster &	operator= (SimpleLineCluster &&)=delete
void	produce (art::Event &e) 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
std::unique_ptr< ClusterCrawlerAlg >	fCCAlg
art::InputTag	fHitFinderLabel
	label of module producing input hits More...
art::InputTag	fPFParticleLabel
	label of module producing input pfparticles More...

Detailed Description

Definition at line 36 of file SimpleLineCluster_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::SimpleLineCluster::SimpleLineCluster ( fhicl::ParameterSet const &  p )

explicit

Definition at line 61 of file SimpleLineCluster_module.cc.

References recob::HitAndAssociationsWriterBase::declare_products(), fCCAlg, and fhicl::ParameterSet::get().

  : fHitFinderLabel(p.get<art::InputTag>("HitFinderModuleLabel"))
  , fPFParticleLabel(p.get<art::InputTag>("PFParticleModuleLabel"))
{
  // this trick avoids double configuration on construction
  if (fCCAlg)
    fCCAlg->reconfigure(p.get< fhicl::ParameterSet >("ClusterCrawlerAlg"));
  else {
    fCCAlg.reset(new ClusterCrawlerAlg
                 (p.get< fhicl::ParameterSet >("ClusterCrawlerAlg")));
  }

  recob::HitCollectionAssociator::declare_products(*this);
  produces< std::vector<recob::Cluster> >();
  produces< art::Assns<recob::Cluster, recob::Hit> >();
}

cluster::SimpleLineCluster::SimpleLineCluster ( SimpleLineCluster const &  )

delete

cluster::SimpleLineCluster::SimpleLineCluster ( SimpleLineCluster &&  )

delete

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.

Referenced by art::RootOutput::beginSubRun(), art::OutputModule::doBeginRun(), art::OutputModule::doBeginSubRun(), art::OutputModule::doEndRun(), art::OutputModule::doEndSubRun(), art::ProducingService::doPostReadEvent(), art::ProducingService::doPostReadRun(), art::ProducingService::doPostReadSubRun(), art::OutputModule::doWriteEvent(), art::ProcessPackage< L >::postScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::Run >::End::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::postScheduleSignal(), art::BeginEndPackage< Level::SubRun >::End::postScheduleSignal(), art::ProcessPackage< L >::preScheduleSignal(), art::BeginEndPackage< Level::Run >::Begin::preScheduleSignal(), art::BeginEndPackage< Level::SubRun >::Begin::preScheduleSignal(), art::EventProcessor::readEvent(), art::EventProcessor::readRun(), art::EmptyEvent::readRun_(), art::EventProcessor::readSubRun(), and art::EmptyEvent::readSubRun_().

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

SimpleLineCluster& cluster::SimpleLineCluster::operator= ( SimpleLineCluster const &  )

delete

SimpleLineCluster& cluster::SimpleLineCluster::operator= ( SimpleLineCluster &&  )

delete

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::SimpleLineCluster::produce ( art::Event &  e )

overridevirtual

Implements art::EDProducer.

Definition at line 78 of file SimpleLineCluster_module.cc.

References cluster::ClusterCrawlerAlg::ClusterStore::BeginAng, cluster::ClusterCrawlerAlg::ClusterStore::BeginChg, cluster::ClusterCrawlerAlg::ClusterStore::BeginTim, cluster::ClusterCrawlerAlg::ClusterStore::BeginWir, util::CreateAssn(), cluster::ClusterCrawlerAlg::ClusterStore::CTP, cluster::ClusterCrawlerAlg::DecodeCTP(), DEFINE_ART_MODULE, cluster::ClusterCrawlerAlg::ClusterStore::EndAng, cluster::ClusterCrawlerAlg::ClusterStore::EndChg, cluster::ClusterCrawlerAlg::ClusterStore::EndTim, cluster::ClusterCrawlerAlg::ClusterStore::EndWir, fCCAlg, fHitFinderLabel, art::fill_ptr_vector(), fPFParticleLabel, art::DataViewImpl::getValidHandle(), hits(), cluster::ClusterCrawlerAlg::ClusterStore::ID, geo::vect::indices(), recob::Hit::Integral(), art::errors::ProductRegistrationFailure, art::Event::put(), recob::Cluster::Sentry, recob::Hit::SummedADC(), cluster::ClusterCrawlerAlg::ClusterStore::tclhits, and recob::HitRefinerAssociator::use_hits().

{
  //Retrieve data products
  auto hitsHandle = evt.getValidHandle< std::vector<recob::Hit> >(fHitFinderLabel);
  auto clusHandle = evt.getValidHandle< std::vector<recob::Cluster> >(fPFParticleLabel);
  auto pfpsHandle = evt.getValidHandle< std::vector<recob::PFParticle> >(fPFParticleLabel);
  
  // all hits in the collection
  std::vector< art::Ptr<recob::Hit> > hits;
  art::fill_ptr_vector(hits, hitsHandle);
  
  // all pfps in the collection
  std::vector< art::Ptr<recob::PFParticle> > pfps;
  art::fill_ptr_vector(pfps, pfpsHandle);

  art::FindManyP < recob::Cluster > cluFromPfp(pfpsHandle, evt, fPFParticleLabel);
  art::FindManyP < recob::Hit > hitFromClu(clusHandle, evt, fPFParticleLabel);

  // also get the associated wires and raw digits;
  // we assume they have been created by the same module as the hits
  art::FindOneP<raw::RawDigit> channelHitRawDigits(hitsHandle, evt, fHitFinderLabel);
  art::FindOneP<recob::Wire>   channelHitWires    (hitsHandle, evt, fHitFinderLabel);

  std::vector<recob::Hit> allHits;
  std::vector<ClusterCrawlerAlg::ClusterStore> allClusters;
  std::vector<unsigned int> clusterhitindex;

  for (size_t i = 0; i < pfps.size(); ++i){
    std::vector<recob::Hit> pfphits;
    auto& clus_in_pfp = cluFromPfp.at(i);
    for (auto& clu : clus_in_pfp){
      auto& hits_in_clu = hitFromClu.at(clu.key());
      for (auto& hit : hits_in_clu) pfphits.push_back(*hit);
    }
    fCCAlg->RunCrawler(pfphits);

    //copy hits
    size_t nhits = allHits.size();
    for (auto & hit : fCCAlg->GetHits()){
      allHits.push_back(hit);
    }

    auto & Clusters = fCCAlg->GetClusters();
    for(auto &clstr : Clusters){
      allClusters.push_back(clstr);
      clusterhitindex.push_back(nhits);
    }

    fCCAlg->ClearResults();
  }
  

  std::vector<recob::Cluster> sccol;

  std::unique_ptr<art::Assns<recob::Cluster, recob::Hit> > 
    hc_assn(new art::Assns<recob::Cluster, recob::Hit>);

  // make the clusters and associations
  float sumChg, sumADC;
  unsigned int clsID = 0, nclhits;
  for(unsigned int icl = 0; icl < allClusters.size(); ++icl) {
    ClusterCrawlerAlg::ClusterStore const& clstr = allClusters[icl];
    if(clstr.ID < 0) continue;
    ++clsID;
    sumChg = 0;
    sumADC = 0;
    geo::PlaneID planeID = ClusterCrawlerAlg::DecodeCTP(clstr.CTP);
    //unsigned short plane = planeID.Plane;
    nclhits = clstr.tclhits.size();
    std::vector<unsigned int> clsHitIndices;
    // correct the hit indices to refer to the valid hits that were just added
    for(unsigned int itt = 0; itt < nclhits; ++itt) {
      unsigned int iht = clstr.tclhits[itt];
      recob::Hit const& hit = allHits[iht];
      sumChg += hit.Integral();
      sumADC += hit.SummedADC();
    } // itt
      // get the wire, plane from a hit
    unsigned int iht = clstr.tclhits[0];
    
    geo::View_t view = allHits[iht].View();
    sccol.emplace_back(
                       (float)clstr.BeginWir,  // Start wire
                       0,                      // sigma start wire
                       clstr.BeginTim,         // start tick
                       0,                      // sigma start tick
                       clstr.BeginChg,         // start charge
                       clstr.BeginAng,         // start angle
                       0,                      // start opening angle (0 for line-like clusters)
                       (float)clstr.EndWir,    // end wire
                       0,                      // sigma end wire
                       clstr.EndTim,           // end tick
                       0,                      // sigma end tick
                       clstr.EndChg,           // end charge
                       clstr.EndAng,           // end angle
                       0,                      // end opening angle (0 for line-like clusters)
                       sumChg,                 // integral
                       0,                      // sigma integral
                       sumADC,                 // summed ADC
                       0,                      // sigma summed ADC
                       nclhits,                // n hits
                       0,                      // wires over hits
                       0,                      // width (0 for line-like clusters)
                       clsID,                  // ID
                       view,                   // view
                       planeID,                // plane
                       recob::Cluster::Sentry  // sentry
                       );
    // make the cluster - hit association
    std::vector<size_t> indices;
    for (auto & ih : clstr.tclhits){
      indices.push_back(ih+clusterhitindex[icl]);
    }
    if(!util::CreateAssn(
                         *this, evt, sccol, allHits, *hc_assn, indices)
       )
      {
        throw art::Exception(art::errors::ProductRegistrationFailure)
          <<"Failed to associate hit "<<iht<<" with cluster "<<icl;
      } // exception
  }

  // convert cluster vector to unique_ptrs
  std::unique_ptr<std::vector<recob::Cluster> > ccol(new std::vector<recob::Cluster>(std::move(sccol)));

  std::unique_ptr<std::vector<recob::Hit>> FinalHits
    (new std::vector<recob::Hit>(std::move(allHits)));

  recob::HitRefinerAssociator shcol(*this, evt, fHitFinderLabel, 
                                    channelHitWires.isValid(), 
                                    channelHitRawDigits.isValid());

  shcol.use_hits(std::move(FinalHits));

  // move the hit collection and the associations into the event:
  shcol.put_into(evt);
  evt.put(std::move(ccol));
  evt.put(std::move(hc_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);
}

Member Data Documentation

std::unique_ptr<ClusterCrawlerAlg> cluster::SimpleLineCluster::fCCAlg

private

Definition at line 53 of file SimpleLineCluster_module.cc.

Referenced by produce(), and SimpleLineCluster().

art::InputTag cluster::SimpleLineCluster::fHitFinderLabel

private

label of module producing input hits

Definition at line 55 of file SimpleLineCluster_module.cc.

Referenced by produce().

art::InputTag cluster::SimpleLineCluster::fPFParticleLabel

private

label of module producing input pfparticles

Definition at line 56 of file SimpleLineCluster_module.cc.

Referenced by produce().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/ClusterFinder/SimpleLineCluster_module.cc