RecoProxyUsageExample Class Reference

Example of analyzer accessing vertices, tracks, and hits, using RecoBaseProxy. More...

Inheritance diagram for RecoProxyUsageExample:

Classes
struct	Config

Public Types
using	Parameters = art::EDAnalyzer::Table< Config >
using	WorkerType = WorkerT< EDAnalyzer >
using	ModuleType = EDAnalyzer

Public Member Functions
	RecoProxyUsageExample (Parameters const &p)
	RecoProxyUsageExample (RecoProxyUsageExample const &)=delete
	RecoProxyUsageExample (RecoProxyUsageExample &&)=delete
RecoProxyUsageExample &	operator= (RecoProxyUsageExample const &)=delete
RecoProxyUsageExample &	operator= (RecoProxyUsageExample &&)=delete
void	analyze (art::Event const &e) override
std::string	workerType () const
bool	modifiesEvent () const
void	registerProducts (MasterProductRegistry &, ProductDescriptions &, ModuleDescription const &)
std::string const &	processName () const
bool	wantAllEvents () const
bool	wantEvent (Event const &e)
fhicl::ParameterSetID	selectorConfig () const
art::Handle< art::TriggerResults >	getTriggerResults (Event const &e) 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
detail::CachedProducts &	cachedProducts ()
void	validateConsumedProduct (BranchType const bt, ProductInfo const &pi)
void	prepareForJob (fhicl::ParameterSet const &pset)
void	showMissingConsumes () const

Private Attributes
art::InputTag	trkTag
art::InputTag	vtxTag
art::InputTag	mcsTag

Detailed Description

Example of analyzer accessing vertices, tracks, and hits, using RecoBaseProxy.

The corresponding code without using RecoBaseProxy is also provided as a reference.

See also

LArSoft data proxies.

Author

G. Cerati (FNAL, MicroBooNE)

Date

2018

Version

1.0

Definition at line 38 of file RecoProxyUsageExample_module.cc.

Member Typedef Documentation

using art::EDAnalyzer::ModuleType = EDAnalyzer

inherited

Definition at line 39 of file EDAnalyzer.h.

using RecoProxyUsageExample::Parameters = art::EDAnalyzer::Table<Config>

Definition at line 56 of file RecoProxyUsageExample_module.cc.

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

inherited

Definition at line 38 of file EDAnalyzer.h.

Constructor & Destructor Documentation

RecoProxyUsageExample::RecoProxyUsageExample ( Parameters const &  p )

explicit

Definition at line 78 of file RecoProxyUsageExample_module.cc.

  : EDAnalyzer(config)
  , trkTag(config().trackInputTag())
  , vtxTag(config().vertexInputTag())
  , mcsTag(config().mcsInputTag())
{}

RecoProxyUsageExample::RecoProxyUsageExample ( RecoProxyUsageExample const &  )

delete

RecoProxyUsageExample::RecoProxyUsageExample ( RecoProxyUsageExample &&  )

delete

Member Function Documentation

void RecoProxyUsageExample::analyze ( art::Event const &  e )

overridevirtual

Implements art::EDAnalyzer.

Definition at line 85 of file RecoProxyUsageExample_module.cc.

References recob::MCSFitResult::bestMomentum(), recob::Vertex::chi2(), recob::Track::CountValidPoints(), art::FindManyP< ProdB, Data >::data(), DEFINE_ART_MODULE, e, hits(), art::Ptr< T >::key(), recob::Track::Length(), mcsTag, recob::Vertex::position(), recob::VertexAssnMeta::propDist(), track, trkTag, and vtxTag.

{

  //
  // Example using proxies.
  //
  
  //
  // Get vertex collection proxy and associated tracks, with meta data
  auto const& vertices = proxy::getCollection<std::vector<recob::Vertex> >(e,vtxTag,proxy::withAssociatedMeta<recob::Track, recob::VertexAssnMeta>());
  //
  // Get track collection proxy and parallel mcs fit data (associated hits loaded by default)
  // Note: if tracks were produced from a TrackTrajectory collection you could access the original trajectories adding ',proxy::withOriginalTrajectory()' to the list of arguments
  auto const& tracks   = proxy::getCollection<proxy::Tracks>(e,trkTag,proxy::withParallelData<recob::MCSFitResult>(mcsTag));
  //
  // Loop over vertex proxies (get recob::Vertex with '->')
  for (const auto& v : vertices) {
    mf::LogVerbatim("ProxyExample") << "vertex pos=" << v->position() << " chi2=" << v->chi2();
    //
    // Get tracks(+meta) associated to vertex, and loop over them
    const auto& assocTracks = v.get<recob::Track>();
    for (const auto& trackAssn : assocTracks) {
      //
      // Note that here we access the methods of recob::Track using '->' and that we get the recob::VertexAssnMeta with '.data()'
      mf::LogVerbatim("ProxyExample") << "track with key=" << trackAssn.key() << " and length=" << trackAssn->Length() << " has propDist from vertex=" << trackAssn.data().propDist();
      //
      // Now get the track proxy from the key, and use it to access the parallel MCSFitResult; note that the track proxy has already access to the associated hits
      const auto& track = tracks[trackAssn.key()];
      const recob::MCSFitResult& assocMCS = track.get<recob::MCSFitResult>();
      //
      // Print some information; here we access the methods of recob::Track using '->' and proxy::Track with '.'
      // Note: if the original trajectories were associated to the proxy, you could get the original/unfitted length with 'track(proxy::Tracks::Unfitted)->Length()'
      mf::LogVerbatim("ProxyExample") << "\tCountValidPoints=" << track->CountValidPoints() << " and nHits=" << track.nHits() << " and MCSMom=" << assocMCS.bestMomentum();
      //
      // Now loop over the associated hits from the track proxy
      if (track.nHits()<50) {
        for (const art::Ptr<recob::Hit>& h : track.hits()) {
          mf::LogVerbatim("ProxyExample") << "\t\thit wire=" << h->WireID() << " peak time=" << h->PeakTime();
        }
      }
    } // for associated tracks
  } // for vertices

  //
  // Same example without using proxies. 
  //

  //
  // Get vertex collection handle and get associated tracks with meta data using FindManyP
  auto const& vertexHandle = e.getValidHandle<std::vector<recob::Vertex> >(vtxTag);
  auto const& vertexColl = *vertexHandle;
  art::FindManyP<recob::Track, recob::VertexAssnMeta> assocTracksWithMeta(vertexHandle, e, vtxTag);
  //
  // Get track collection handle, get associated hits using FindMany, and get mcs collection (parallel to track collection)
  auto const& trackHandle  = e.getValidHandle<std::vector<recob::Track> >(trkTag);
  art::FindMany<recob::Hit> assocHits(trackHandle, e, trkTag);
  auto const& mcsColl = *(e.getValidHandle<std::vector<recob::MCSFitResult> >(mcsTag));
  //
  // Loop over the vertex collection
  for (size_t iv=0; iv<vertexColl.size(); ++iv) {
    const recob::Vertex& v = vertexColl[iv];
    mf::LogVerbatim("ProxyExample") << "vertex pos=" << v.position() << " chi2=" << v.chi2();
    //
    // Get tracks(+meta) associated to vertex, and loop over them
    auto const& assocTks = assocTracksWithMeta.at(iv);
    auto const& assocTksMeta = assocTracksWithMeta.data(iv);
    for (size_t itk=0;itk<assocTks.size();++itk) {
      //
      // Get the recob::Track and VertexAssnMeta instance
      const art::Ptr<recob::Track>& trackAssn = assocTks[itk];
      const recob::VertexAssnMeta* trackMeta = assocTksMeta[itk];
      mf::LogVerbatim("ProxyExample") << "track with key=" << trackAssn.key() << " and length=" << trackAssn->Length() << " has propDist from vertex=" << trackMeta->propDist();
      //
      // Get the associated recob::Hit and the MCSFitResult
      const recob::MCSFitResult& assocMCS = mcsColl[trackAssn.key()];
      const std::vector<recob::Hit const*>& hits = assocHits.at(trackAssn.key());
      //
      // Print some information
      mf::LogVerbatim("ProxyExample") << "\tCountValidPoints=" << trackAssn->CountValidPoints() << " and nHits=" << hits.size() << " and MCSMom=" << assocMCS.bestMomentum();
      //
      // Now loop over the associated hits
      if (hits.size()<50) {
        for (const recob::Hit* h : hits) {
          mf::LogVerbatim("ProxyExample") << "\t\thit wire=" << h->WireID() << " peak time=" << h->PeakTime();
        }
      }
    } // for track
  } // for vertex

} // RecoProxyUsageExample::analyze()

detail::CachedProducts& art::EventObserverBase::cachedProducts ( )

inlineprotectedinherited

Definition at line 79 of file EventObserverBase.h.

References art::EventObserverBase::selectors_.

Referenced by art::EDAnalyzer::doEvent(), and art::OutputModule::doWriteEvent().

  {
    return selectors_;
  }

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::EDAnalyzer::currentContext ( ) const

protectedinherited

Definition at line 114 of file EDAnalyzer.cc.

References art::EDAnalyzer::current_context_.

Referenced by art::EDAnalyzer::workerType().

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

art::Handle<art::TriggerResults> art::EventObserverBase::getTriggerResults ( Event const &  e ) const

inlineinherited

Definition at line 61 of file EventObserverBase.h.

References art::detail::CachedProducts::getOneTriggerResults(), and art::EventObserverBase::selectors_.

Referenced by art::OutputModule::doWriteEvent().

  {
    return selectors_.getOneTriggerResults(e);
  }

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::EventObserverBase::modifiesEvent ( ) const

inlineinherited

Definition at line 25 of file EventObserverBase.h.

  {
    return false;
  }

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

RecoProxyUsageExample& RecoProxyUsageExample::operator= ( RecoProxyUsageExample const &  )

delete

RecoProxyUsageExample& RecoProxyUsageExample::operator= ( RecoProxyUsageExample &&  )

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

std::string const& art::EventObserverBase::processName ( ) const

inlineinherited

Definition at line 41 of file EventObserverBase.h.

References art::EventObserverBase::process_name_.

Referenced by art::FileDumperOutput::printPrincipal(), and art::RootOutput::RootOutput().

  {
    return process_name_;
  }

void art::EventObserverBase::registerProducts ( MasterProductRegistry &  , ProductDescriptions &  , ModuleDescription const &    )

inlineinherited

Definition at line 33 of file EventObserverBase.h.

  {}

fhicl::ParameterSetID art::EventObserverBase::selectorConfig ( ) const

inlineinherited

Definition at line 56 of file EventObserverBase.h.

References art::EventObserverBase::selector_config_id_.

Referenced by art::RootOutputFile::writeOne().

  {
    return selector_config_id_;
  }

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

bool art::EventObserverBase::wantAllEvents ( ) const

inlineinherited

Definition at line 46 of file EventObserverBase.h.

References art::EventObserverBase::wantAllEvents_.

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), art::OutputModule::doWriteEvent(), art::RootOutput::RootOutput(), and art::OutputWorker::wantAllEvents().

  {
    return wantAllEvents_;
  }

bool art::EventObserverBase::wantEvent ( Event const &  e )

inlineinherited

Definition at line 51 of file EventObserverBase.h.

References art::EventObserverBase::selectors_, and art::detail::CachedProducts::wantEvent().

Referenced by art::EDAnalyzer::doEvent(), art::OutputModule::doEvent(), and art::OutputModule::doWriteEvent().

  {
    return selectors_.wantEvent(e);
  }

std::string art::EDAnalyzer::workerType ( ) const

inlineinherited

Definition at line 109 of file EDAnalyzer.h.

References art::EDAnalyzer::currentContext().

    {
      return "WorkerT<EDAnalyzer>";
    }

Member Data Documentation

art::InputTag RecoProxyUsageExample::mcsTag

private

Definition at line 74 of file RecoProxyUsageExample_module.cc.

Referenced by analyze().

art::InputTag RecoProxyUsageExample::trkTag

private

Definition at line 74 of file RecoProxyUsageExample_module.cc.

Referenced by analyze().

art::InputTag RecoProxyUsageExample::vtxTag

private

Definition at line 74 of file RecoProxyUsageExample_module.cc.

Referenced by analyze().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/RecoProxyUsageExample/RecoProxyUsageExample_module.cc