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 >
Public Types inherited from art::EDAnalyzer
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
Public Member Functions inherited from art::EDAnalyzer
	EDAnalyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDAnalyzer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Analyzer
virtual	~Analyzer () noexcept
	Analyzer (fhicl::ParameterSet const &pset)
template<typename Config >
	Analyzer (Table< Config > const &config)
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Observer
	~Observer () noexcept
	Observer (Observer const &)=delete
	Observer (Observer &&)=delete
Observer &	operator= (Observer const &)=delete
Observer &	operator= (Observer &&)=delete
void	registerProducts (ProductDescriptions &, ModuleDescription const &)
void	fillDescriptions (ModuleDescription const &)
fhicl::ParameterSetID	selectorConfig () const
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

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

Additional Inherited Members
Protected Member Functions inherited from art::Observer
std::string const &	processName () const
bool	wantAllEvents () const noexcept
bool	wantEvent (ScheduleID id, Event const &e) const
Handle< TriggerResults >	getTriggerResults (Event const &e) const
	Observer (fhicl::ParameterSet const &config)
	Observer (std::vector< std::string > const &select_paths, std::vector< std::string > const &reject_paths, fhicl::ParameterSet const &config)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

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

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

See also

LArSoftProxies.

Author

G. Cerati (FNAL, MicroBooNE)

Date

2018

Version

1.0

Definition at line 37 of file RecoProxyUsageExample_module.cc.

Member Typedef Documentation

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

Definition at line 55 of file RecoProxyUsageExample_module.cc.

Constructor & Destructor Documentation

RecoProxyUsageExample::RecoProxyUsageExample ( Parameters const &  p )

explicit

Definition at line 77 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 84 of file RecoProxyUsageExample_module.cc.

{

  //
  // 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()

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

delete

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

delete

Member Data Documentation

art::InputTag RecoProxyUsageExample::mcsTag

private

Definition at line 73 of file RecoProxyUsageExample_module.cc.

art::InputTag RecoProxyUsageExample::trkTag

private

Definition at line 73 of file RecoProxyUsageExample_module.cc.

art::InputTag RecoProxyUsageExample::vtxTag

private

Definition at line 73 of file RecoProxyUsageExample_module.cc.

---

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

• larexamples/larexamples/RecoProxyUsageExample/RecoProxyUsageExample_module.cc