LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
trkf::SeedFinderModule Class Reference
Inheritance diagram for trkf::SeedFinderModule:
art::EDProducer art::ProducerBase art::Consumer art::EngineCreator art::ProductRegistryHelper

Public Types

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

Public Member Functions

 SeedFinderModule (fhicl::ParameterSet const &pset)
 
virtual ~SeedFinderModule ()
 
void reconfigure (fhicl::ParameterSet const &pset)
 
void beginJob ()
 
void produce (art::Event &evt)
 
void endJob ()
 
art::PtrVector< recob::HitGetHitsFromEvent (std::string HitModuleLabel, art::Event &evt)
 
void GetSortedHitsFromClusters (std::string ClusterModuleLabel, art::Event &evt, std::vector< std::vector< art::PtrVector< recob::Hit > > > &SortedHits)
 
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_tcreateEngine (seed_t seed)
 
base_engine_tcreateEngine (seed_t seed, std::string const &kind_of_engine_to_make)
 
base_engine_tcreateEngine (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< Consumernon_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

SeedFinderAlgorithm fSeedAlg
 
std::string fInputModuleLabel
 
int fInputSource
 

Detailed Description

Definition at line 28 of file SeedFinderModule_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

trkf::SeedFinderModule::SeedFinderModule ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 101 of file SeedFinderModule_module.cc.

References reconfigure().

101  :
102  fSeedAlg(pset.get<fhicl::ParameterSet>("SeedAlg"))
103  {
104  reconfigure(pset);
105  produces<std::vector<recob::Seed> >();
106 
107 
108  }
void reconfigure(fhicl::ParameterSet const &pset)
trkf::SeedFinderModule::~SeedFinderModule ( )
virtual

Definition at line 111 of file SeedFinderModule_module.cc.

112  {
113  }

Member Function Documentation

void trkf::SeedFinderModule::beginJob ( )
virtual

Reimplemented from art::EDProducer.

Definition at line 125 of file SeedFinderModule_module.cc.

126  {}
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().

148 {
149  if (!moduleContext_)
150  return ProductToken<T>::invalid();
151 
152  consumables_[BT].emplace_back(ConsumableType::Product,
153  TypeID{typeid(T)},
154  it.label(),
155  it.instance(),
156  it.process());
157  return ProductToken<T>{it};
158 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::consumesMany ( )
inherited

Definition at line 162 of file Consumer.h.

163 {
164  if (!moduleContext_)
165  return;
166 
167  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
168 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
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().

173 {
174  if (!moduleContext_)
175  return ViewToken<T>::invalid();
176 
177  consumables_[BT].emplace_back(ConsumableType::ViewElement,
178  TypeID{typeid(T)},
179  it.label(),
180  it.instance(),
181  it.process());
182  return ViewToken<T>{it};
183 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
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().

34 {
35  return rng()->createEngine(
36  placeholder_schedule_id(), seed, kind_of_engine_to_make);
37 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
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().

43 {
44  return rng()->createEngine(
45  placeholder_schedule_id(), seed, kind_of_engine_to_make, engine_label);
46 }
long seed
Definition: chem4.cc:68
static art::ServiceHandle< art::RandomNumberGenerator > & rng()
CurrentProcessingContext const * art::EDProducer::currentContext ( ) const
protectedinherited

Definition at line 120 of file EDProducer.cc.

References art::EDProducer::current_context_.

121  {
122  return current_context_.get();
123  }
CPC_exempt_ptr current_context_
Definition: EDProducer.h:116
void trkf::SeedFinderModule::endJob ( )
virtual

Reimplemented from art::EDProducer.

Definition at line 255 of file SeedFinderModule_module.cc.

256  {
257 
258  }
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_().

52 {
53  auto const& explicit_seeds = pset.get<std::vector<int>>(key, {});
54  return explicit_seeds.empty() ? implicit_seed : explicit_seeds.front();
55 }
art::PtrVector< recob::Hit > trkf::SeedFinderModule::GetHitsFromEvent ( std::string  HitModuleLabel,
art::Event evt 
)

Definition at line 234 of file SeedFinderModule_module.cc.

References art::DataViewImpl::getByLabel(), and art::PtrVector< T >::push_back().

Referenced by produce().

235  {
236 
239  evt.getByLabel(HitModuleLabel, hith);
240  for(unsigned int i=0; i<hith->size(); ++i)
241  {
242  art::Ptr<recob::Hit> hit(hith, i);
243  TheHits.push_back(hit);
244  }
245 
246  return TheHits;
247  }
void push_back(Ptr< U > const &p)
Definition: PtrVector.h:441
Detector simulation of raw signals on wires.
bool getByLabel(std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
Definition: DataViewImpl.h:344
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_.

124  {
125  return ProducerBase::getProductID<PROD, B>(moduleDescription_,
126  instanceName);
127  }
ModuleDescription moduleDescription_
Definition: EDProducer.h:115
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().

58  {
59  auto const& pd =
60  get_ProductDescription<PROD>(B, md.moduleLabel(), instanceName);
61  return pd.productID();
62  }
Int_t B
Definition: plot.C:25
void trkf::SeedFinderModule::GetSortedHitsFromClusters ( std::string  ClusterModuleLabel,
art::Event evt,
std::vector< std::vector< art::PtrVector< recob::Hit > > > &  SortedHits 
)

Definition at line 193 of file SeedFinderModule_module.cc.

References art::fill_ptr_vector(), art::DataViewImpl::getByLabel(), art::Handle< T >::isValid(), art::PtrVector< T >::push_back(), lar::dump::vector(), and recob::Cluster::View().

Referenced by produce().

194  {
195 
196  SortedHits.clear();
197  SortedHits.resize(3);
198  std::vector<art::Ptr<recob::Cluster> > Clusters;
199 
201  evt.getByLabel(ClusterModuleLabel, clusterh);
202 
203  if(clusterh.isValid()) {
204  art::fill_ptr_vector(Clusters, clusterh);
205  }
206 
207  art::FindManyP<recob::Hit> fm(clusterh, evt, ClusterModuleLabel);
208 
209  for(size_t iclus = 0; iclus < Clusters.size(); ++iclus) {
210  art::Ptr<recob::Cluster> ThisCluster = Clusters.at(iclus);
211 
212  std::vector< art::Ptr<recob::Hit> > ihits = fm.at(iclus);
213 
214  art::PtrVector<recob::Hit> HitsThisCluster;
215  for(std::vector< art::Ptr<recob::Hit> >::const_iterator i = ihits.begin();
216  i != ihits.end(); ++i)
217  HitsThisCluster.push_back(*i);
218 
219  SortedHits[ThisCluster->View()].push_back(HitsThisCluster);
220 
221  }
222  }
bool isValid() const
Definition: Handle.h:190
auto vector(Vector const &v)
Returns a manipulator which will print the specified array.
Definition: DumpUtils.h:265
void push_back(Ptr< U > const &p)
Definition: PtrVector.h:441
geo::View_t View() const
Returns the view for this cluster.
Definition: Cluster.h:741
bool getByLabel(std::string const &label, std::string const &productInstanceName, Handle< PROD > &result) const
Definition: DataViewImpl.h:344
void fill_ptr_vector(std::vector< Ptr< T >> &ptrs, H const &h)
Definition: Ptr.h:464
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().

191 {
192  if (!moduleContext_)
193  return ProductToken<T>::invalid();
194 
195  consumables_[BT].emplace_back(ConsumableType::Product,
196  TypeID{typeid(T)},
197  it.label(),
198  it.instance(),
199  it.process());
200  return ProductToken<T>{it};
201 }
static ProductToken< T > invalid()
Definition: ProductToken.h:47
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
template<typename T , art::BranchType BT>
void art::Consumer::mayConsumeMany ( )
inherited

Definition at line 205 of file Consumer.h.

206 {
207  if (!moduleContext_)
208  return;
209 
210  consumables_[BT].emplace_back(ConsumableType::Many, TypeID{typeid(T)});
211 }
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
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().

216 {
217  if (!moduleContext_)
218  return ViewToken<T>::invalid();
219 
220  consumables_[BT].emplace_back(ConsumableType::ViewElement,
221  TypeID{typeid(T)},
222  it.label(),
223  it.instance(),
224  it.process());
225  return ViewToken<T>{it};
226 }
static ViewToken< Element > invalid()
Definition: ProductToken.h:75
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
bool art::ProducerBase::modifiesEvent ( ) const
inlineinherited

Definition at line 40 of file ProducerBase.h.

References art::ProducerBase::getProductID().

41  {
42  return true;
43  }
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().

90 {
91  if (!moduleContext_)
92  return;
93 
94  pset.get_if_present("errorOnMissingConsumes", requireConsumes_);
95  for (auto& consumablesPerBranch : consumables_) {
96  cet::sort_all(consumablesPerBranch);
97  }
98 }
bool requireConsumes_
Definition: Consumer.h:137
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
void trkf::SeedFinderModule::produce ( art::Event evt)
virtual

Implements art::EDProducer.

Definition at line 132 of file SeedFinderModule_module.cc.

References fInputModuleLabel, fInputSource, fSeedAlg, GetHitsFromEvent(), trkf::SeedFinderAlgorithm::GetSeedsFromSortedHits(), trkf::SeedFinderAlgorithm::GetSeedsFromUnSortedHits(), GetSortedHitsFromClusters(), and art::Event::put().

133  {
134 
135  std::unique_ptr<std::vector<recob::Seed> > seeds(new std::vector<recob::Seed>);
136 
137  std::vector<std::vector<recob::SpacePoint> > SpacePointsWithSeeds;
138  std::vector<recob::Seed> SeedVector;
139 
140  // Make seeds from clusters
141  if(fInputSource==1)
142  {
143  std::vector<std::vector<art::PtrVector<recob::Hit> > > HitsPerSeed;
144 
145  std::vector< std::vector< art::PtrVector<recob::Hit> > > SortedHits;
147 
148  std::vector<std::vector<recob::Seed> > Seeds = fSeedAlg.GetSeedsFromSortedHits(SortedHits, HitsPerSeed);
149 
150  for(size_t i=0; i!=Seeds.size(); ++i)
151  for(size_t j=0; j!=Seeds.at(i).size(); ++j)
152  SeedVector.push_back(Seeds.at(i).at(j));
153  }
154 
155  // Make seeds from unsorted hits
156  else if(fInputSource==0)
157  {
158 
160  std::vector<art::PtrVector<recob::Hit> > HitCatalogue;
161  SeedVector = fSeedAlg.GetSeedsFromUnSortedHits(Hits, HitCatalogue);
162  }
163  else
164  {
165  throw cet::exception("SeedFinderModule") <<
166  "Unkown source mode " << fInputSource<<"\n";
167  }
168 
169  if(SeedVector.size()>0)
170  {
171  for(size_t i=0; i!=SeedVector.size(); ++i)
172  {
173  seeds->push_back(SeedVector.at(i));
174  }
175 
176  }
177  else
178  mf::LogInfo("SeedFinder")<<"Seed finder made no seeds : no space points in event"<<std::endl;
179 
180  evt.put(std::move(seeds));
181 
182 
183 
184  }
std::vector< art::Ptr< recob::Seed > > SeedVector
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
void GetSortedHitsFromClusters(std::string ClusterModuleLabel, art::Event &evt, std::vector< std::vector< art::PtrVector< recob::Hit > > > &SortedHits)
ProductID put(std::unique_ptr< PROD > &&product)
Definition: Event.h:102
std::vector< std::vector< recob::Seed > > GetSeedsFromSortedHits(std::vector< std::vector< art::PtrVector< recob::Hit > > > const &SortedHits, std::vector< std::vector< art::PtrVector< recob::Hit > > > &HitsPerSeed, unsigned int StopAfter=0)
art::PtrVector< recob::Hit > Hits
std::vector< recob::Seed > GetSeedsFromUnSortedHits(art::PtrVector< recob::Hit > const &, std::vector< art::PtrVector< recob::Hit > > &, unsigned int StopAfter=0)
art::PtrVector< recob::Hit > GetHitsFromEvent(std::string HitModuleLabel, art::Event &evt)
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
void trkf::SeedFinderModule::reconfigure ( fhicl::ParameterSet const &  pset)

Definition at line 116 of file SeedFinderModule_module.cc.

References fInputModuleLabel, fInputSource, fSeedAlg, fhicl::ParameterSet::get(), and trkf::SeedFinderAlgorithm::reconfigure().

Referenced by SeedFinderModule().

117  {
118  fSeedAlg.reconfigure ( pset.get<fhicl::ParameterSet>("SeedAlg") );
119  fInputModuleLabel = pset.get<std::string>("InputModuleLabel");
120  fInputSource = pset.get<int>("InputSource");
121 
122  }
void reconfigure(fhicl::ParameterSet const &pset)
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().

126 {
127  if (!moduleContext_)
128  return;
129 
130  // If none of the branches have missing consumes statements, exit early.
131  if (std::all_of(cbegin(missingConsumes_),
132  cend(missingConsumes_),
133  [](auto const& perBranch) { return perBranch.empty(); }))
134  return;
135 
136  constexpr cet::HorizontalRule rule{60};
137  mf::LogPrint log{"MTdiagnostics"};
138  log << '\n'
139  << rule('=') << '\n'
140  << "The following consumes (or mayConsume) statements are missing from\n"
141  << module_context(moduleDescription_) << '\n'
142  << rule('-') << '\n';
143 
144  cet::for_all_with_index(
145  missingConsumes_, [&log](std::size_t const i, auto const& perBranch) {
146  for (auto const& pi : perBranch) {
147  log << " "
148  << assemble_consumes_statement(static_cast<BranchType>(i), pi)
149  << '\n';
150  }
151  });
152  log << rule('=');
153 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139
void art::Consumer::validateConsumedProduct ( BranchType const  bt,
ProductInfo const &  pi 
)
protectedinherited

Definition at line 101 of file Consumer.cc.

References art::errors::ProductRegistrationFailure.

103 {
104  // Early exits if consumes tracking has been disabled or if the
105  // consumed product is an allowed consumable.
106  if (!moduleContext_)
107  return;
108 
109  if (cet::binary_search_all(consumables_[bt], pi))
110  return;
111 
112  if (requireConsumes_) {
114  "Consumer: an error occurred during validation of a "
115  "retrieved product\n\n")
116  << "The following consumes (or mayConsume) statement is missing from\n"
117  << module_context(moduleDescription_) << ":\n\n"
118  << " " << assemble_consumes_statement(bt, pi) << "\n\n";
119  }
120 
121  missingConsumes_[bt].insert(pi);
122 }
cet::exempt_ptr< ModuleDescription const > moduleDescription_
Definition: Consumer.h:140
bool requireConsumes_
Definition: Consumer.h:137
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
constexpr T pi()
Returns the constant pi (up to 35 decimal digits of precision)
ConsumableProducts consumables_
Definition: Consumer.h:138
bool moduleContext_
Definition: Consumer.h:136
ConsumableProductSets missingConsumes_
Definition: Consumer.h:139

Member Data Documentation

std::string trkf::SeedFinderModule::fInputModuleLabel
private

Definition at line 57 of file SeedFinderModule_module.cc.

Referenced by produce(), and reconfigure().

int trkf::SeedFinderModule::fInputSource
private

Definition at line 58 of file SeedFinderModule_module.cc.

Referenced by produce(), and reconfigure().

SeedFinderAlgorithm trkf::SeedFinderModule::fSeedAlg
private

Definition at line 56 of file SeedFinderModule_module.cc.

Referenced by produce(), and reconfigure().


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