cluster::SmallClusterFinder Class Reference

Inheritance diagram for cluster::SmallClusterFinder:

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

Public Member Functions
	SmallClusterFinder (fhicl::ParameterSet const &pset)
virtual	~SmallClusterFinder ()
void	beginJob ()
void	beginRun (art::Run &run)
void	reconfigure (fhicl::ParameterSet const &pset)
void	produce (art::Event &evt)
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 Member Functions
int	GetPlaneAndTPC (art::Ptr< recob::Hit > a, unsigned int &p, unsigned int &cs, unsigned int &t, unsigned int &w)

Private Attributes
art::ServiceHandle< geo::Geometry >	geom
std::string	fHitFinderModuleLabel
bool	verbose
SmallClusterFinderAlg	fSmallClusterFinderAlg
unsigned int	fNPlanes

Detailed Description

Definition at line 62 of file SmallClusterFinder_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::SmallClusterFinder::SmallClusterFinder ( fhicl::ParameterSet const &  pset )

explicit

METHODS global

Definition at line 99 of file SmallClusterFinder_module.cc.

References reconfigure().

Referenced by produce().

        {
                this->reconfigure(pset);
                produces< std::vector<recob::Cluster> >();                              //This code makes clusters
                produces< art::Assns<recob::Cluster, recob::Hit>  >();  //Matches clusters with hits
        }

cluster::SmallClusterFinder::~SmallClusterFinder ( )

virtual

Constructor

Definition at line 116 of file SmallClusterFinder_module.cc.

        {
                //Nothing to do in the destructor
        }

Member Function Documentation

void cluster::SmallClusterFinder::beginJob ( )

virtual

Destructor

Get TFileService and define output Histograms

Reimplemented from art::EDProducer.

Definition at line 131 of file SmallClusterFinder_module.cc.

References fNPlanes, geom, and geo::GeometryCore::Nplanes().

        {
                // this will not change on a run per run basis.
                fNPlanes = geom->Nplanes();                             //get the number of planes in the TPC
                art::ServiceHandle<art::TFileService> tfs;
                return;
        }

void cluster::SmallClusterFinder::beginRun ( art::Run &  run )

virtual

Reimplemented from art::EDProducer.

Definition at line 122 of file SmallClusterFinder_module.cc.

          {
                //nothing to do at beginRun()
                return;
          }

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();
}

int cluster::SmallClusterFinder::GetPlaneAndTPC ( art::Ptr< recob::Hit >  a, unsigned int &  p, unsigned int &  cs, unsigned int &  t, unsigned int &  w  )

private

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;
}

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::SmallClusterFinder::produce ( art::Event &  evt )

virtual

Get Clusters

Implements art::EDProducer.

Definition at line 144 of file SmallClusterFinder_module.cc.

References util::CreateAssn(), geo::CryostatID::Cryostat, DEFINE_ART_MODULE, fHitFinderModuleLabel, cluster::SmallClusterFinderAlg::FindSmallClusters(), fNPlanes, fSmallClusterFinderAlg, geom, art::DataViewImpl::getByLabel(), cluster::SmallClusterFinderAlg::GetLeftoversByPlane(), cluster::SmallClusterFinderAlg::GetSmallClustersByPlane(), cluster::ClusterParamsImportWrapper< Algo >::ImportHits(), geo::GeometryCore::Plane(), art::Event::put(), recob::Cluster::Sentry, SmallClusterFinder(), geo::TPCID::TPC, verbose, and geo::PlaneGeo::View().

        { 
                //Get the hits for this event:
                art::Handle< std::vector<recob::Hit> > HitListHandle;
                evt.getByLabel(fHitFinderModuleLabel,HitListHandle);  

                //A vector to hold hits, not yet filled:
                std::vector< art::Ptr<recob::Hit> > hitlist;
        
                //How many hits in this event?  Tell user:
                if (verbose) std::cout << " ++++ Hitsreceived received " << HitListHandle->size() << " +++++ " << std::endl;
                //Catch the case were there are no hits in the event:
                if(HitListHandle->size() ==0 )
                {
                        if (verbose) std::cout << "No hits received! Exiting." << std::endl;
                        return;
                }
                hitlist.resize(HitListHandle->size());

                //wrap the hits in art::Ptrs to pass to the Alg
                for (unsigned int iHit = 0; iHit < hitlist.size(); iHit++){
                        hitlist[iHit] = art::Ptr< recob::Hit>(HitListHandle, iHit);
                }
        
                //std::cout << "Passing " << hitlist.size() << " hits to the alg." << std::endl;

  
                //Now run the alg to find the gammas:
                fSmallClusterFinderAlg.FindSmallClusters(hitlist);
                
                
                
                // make an art::PtrVector of the clusters
                std::unique_ptr< std::vector<recob::Cluster> > SmallClusterFinder(new std::vector<recob::Cluster>);
                std::unique_ptr< art::Assns<recob::Cluster, recob::Hit> > assn(new art::Assns<recob::Cluster, recob::Hit>);
                
                // prepare the algorithm to compute the cluster characteristics;
                // we use the "standard" one here; configuration would happen here,
                // but we are using the default configuration for that algorithm
                ClusterParamsImportWrapper<StandardClusterParamsAlg> ClusterParamAlgo;
                
                
                for(unsigned int iplane=0;iplane<fNPlanes;iplane++){
                
                        //Get the leftover hits for this plane:
                        std::vector<art::Ptr<recob::Hit> > leftoverHits = fSmallClusterFinderAlg.GetLeftoversByPlane(iplane);    
        
                        //write the leftover hits as a cluster:
                        if (leftoverHits.size() != 0){
                                // pick some information from the first hit
                                geo::PlaneID planeID = leftoverHits.front()->WireID().planeID();
                                if (verbose) std::cout << "Writing leftover hits to cluster ID: " << iplane*100 << std::endl;
                                
                                ClusterParamAlgo.ImportHits(leftoverHits);
                                
                                // create the recob::Cluster directly in the vector
                                ClusterCreator leftover(
                                  ClusterParamAlgo,                     // algo
                                  0.,                                   // start_wire
                                  0.,                                   // sigma_start_wire
                                  0.,                                   // start_tick
                                  0.,                                   // sigma_start_tick
                                  0.,                                   // end_wire
                                  0.,                                   // sigma_end_wire,
                                  0.,                                   // end_tick
                                  0.,                                   // sigma_end_tick
                                  iplane*100,                           // ID
                                  geom->Plane(iplane,planeID.TPC,planeID.Cryostat).View(),
                                                                        // view
                                  planeID,                              // plane
                                  recob::Cluster::Sentry                // sentry
                                  );
                                
                                SmallClusterFinder->emplace_back(leftover.move());
                                
                                util::CreateAssn(*this, evt, *SmallClusterFinder, leftoverHits, *assn);  
                        } //leftovers are written for this plane, if they exist.
                
                        //Now get the small clusters;
                        std::vector< std::vector<art::Ptr<recob::Hit> > > smallClusters;
                        smallClusters = fSmallClusterFinderAlg.GetSmallClustersByPlane(iplane);
                
                        for (unsigned int i = 0; i < smallClusters.size(); i++){
                                // pick some information from the first hit
                                geo::PlaneID planeID; // invalid by default
                                if (!smallClusters.empty()) planeID = smallClusters[i].front()->WireID().planeID();
                                
                                ClusterParamAlgo.ImportHits(smallClusters[i]);
                                
                                // create the recob::Cluster directly in the vector
                                ClusterCreator clust(
                                  ClusterParamAlgo,                     // algo
                                  0.,                                   // start_wire
                                  0.,                                   // sigma_start_wire
                                  0.,                                   // start_tick
                                  0.,                                   // sigma_start_tick
                                  0.,                                   // end_wire
                                  0.,                                   // sigma_end_wire,
                                  0.,                                   // end_tick
                                  0.,                                   // sigma_end_tick
                                  iplane*100 + i + 1,                   // ID
                                  geom->Plane(iplane,planeID.TPC,planeID.Cryostat).View(),
                                                                        // view
                                  planeID,                              // plane
                                  recob::Cluster::Sentry                // sentry
                                  );
                                
                                SmallClusterFinder->emplace_back(clust.move());
                                // associate the hits to this cluster
                                util::CreateAssn(*this, evt, *SmallClusterFinder, smallClusters[i], *assn);
                        }
                
                        //Just in case there is nothing for this event, make an empty cluster
                        //so that the clusters are defined.  Tag with ID -1.
                /*      if (smallClusters.size() == 0 && leftoverHits.size() == 0){
                                std::vector< art::Ptr < recob::Hit> > emptyVector;
                                recob::Cluster clust( 0,  0,    //start wire, error in start wire
                                                                 0,  0,         //start time, error in start time
                                                                 0., 0.,        //end   wire, error in end   wire
                                                                 0., 0.,        //end   time, error in end   wire
                                                                 0., 0.,        //dTdW, error in dTdW ??
                                                                 0., 0.,        //dQdW, error in dQdW ??
                                                                 0.,            //Total Q
                                                                 geom->Plane(iplane,0,0).View(),        //View (geo::View_t)
                                                                 -iplane,       //id for cluster, given as plane here
                                                                 PlaneID()); // invalid plane

        
                                SmallClusterFinder->push_back(clust);
                                // associate the hits to this cluster
                                util::CreateAssn(*this, evt, *SmallClusterFinder, emptyVector, *assn);
                        }
                */
                        
                }
        
                //Finish up:
                evt.put(std::move(SmallClusterFinder));
                evt.put(std::move(assn));
 
                return;
        } //end produce

void cluster::SmallClusterFinder::reconfigure

(

fhicl::ParameterSet const &

pset

)

Definition at line 106 of file SmallClusterFinder_module.cc.

References fHitFinderModuleLabel, fSmallClusterFinderAlg, fhicl::ParameterSet::get(), cluster::SmallClusterFinderAlg::reconfigure(), and verbose.

Referenced by SmallClusterFinder().

        {
                fHitFinderModuleLabel   =pset.get<      std::string > ("HitFinderModuleLabel"); 
                verbose                                 =pset.get<      bool            > ("Verbose");
        
                //Let the clusterAlg have access to the pset too:
                fSmallClusterFinderAlg.reconfigure(pset.get<fhicl::ParameterSet> ("smallClustAlg") );
         }

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::string cluster::SmallClusterFinder::fHitFinderModuleLabel

private

Definition at line 79 of file SmallClusterFinder_module.cc.

Referenced by produce(), and reconfigure().

unsigned int cluster::SmallClusterFinder::fNPlanes

private

Definition at line 87 of file SmallClusterFinder_module.cc.

Referenced by beginJob(), and produce().

SmallClusterFinderAlg cluster::SmallClusterFinder::fSmallClusterFinderAlg

private

Definition at line 85 of file SmallClusterFinder_module.cc.

Referenced by produce(), and reconfigure().

art::ServiceHandle<geo::Geometry> cluster::SmallClusterFinder::geom

private

Routine that finds the cluster and sets the dTdW of the 2D shower

Definition at line 76 of file SmallClusterFinder_module.cc.

Referenced by beginJob(), and produce().

bool cluster::SmallClusterFinder::verbose

private

Definition at line 80 of file SmallClusterFinder_module.cc.

Referenced by produce(), and reconfigure().

---

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

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