Produce a reco::Track collection, as a result of the fit of an existing recob::Track collection. More...

Inheritance diagram for TrackProducerFromTrack:

Public Types
using	ModuleType = EDProducer

template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Member Functions
	TrackProducerFromTrack (fhicl::ParameterSet const &p)

	TrackProducerFromTrack (TrackProducerFromTrack const &)=delete

	TrackProducerFromTrack (TrackProducerFromTrack &&)=delete

TrackProducerFromTrack &	operator= (TrackProducerFromTrack const &)=delete

TrackProducerFromTrack &	operator= (TrackProducerFromTrack &&)=delete

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)

void	fillProductDescriptions ()

void	registerProducts (ProductDescriptions &productsToRegister)

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)

std::unique_ptr< Worker >	makeWorker (WorkerParams const &wp)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Protected Member Functions
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 ()

Private Member Functions
void	produce (art::Event &e) override

Private Attributes
std::unique_ptr< trkmkr::TrackMaker >	trackMaker_

art::InputTag	trackInputTag

bool	doTrackFitHitInfo_

bool	doSpacePoints_

bool	spacePointsFromTrajP_

Detailed Description

Produce a reco::Track collection, as a result of the fit of an existing recob::Track collection.

This producer takes an input an existing recob::Track collection (and the associated hits) and re-fits them. The mandatory output are: the resulting recob::Track collection and the associated hits. Optional outputs are recob::TrackFitHitInfo and recob::SpacePoint collections, plus the Assns of SpacePoints to Hits. An option is provided to create SpacePoints from the TrajectoryPoints in the Track. The fit is performed by an user-defined tool, which must inherit from larreco/TrackFinder/TrackMaker.

Parameters: trackMaker (fhicl::ParameterSet for the trkmkr::TrackMaker tool used to do the fit), inputCollection (art::InputTag of the input recob::Track collection), doTrackFitHitInfo (bool to decide whether to produce recob::TrackFitHitInfo's), doSpacePoints (bool to decide whether to produce recob::SpacePoint's), and spacePointsFromTrajP (bool to decide whether the produced recob::SpacePoint's are taken from the recob::tracking::TrajectoryPoint_t's of the fitted recob::Track).

Author: G. Cerati (FNAL, MicroBooNE)

Date: 2017

Version: 1.0

Definition at line 42 of file TrackProducerFromTrack_module.cc.

Member Typedef Documentation

using art::EDProducer::ModuleType = EDProducer

inherited

Definition at line 17 of file EDProducer.h.

template<typename UserConfig , typename KeysToIgnore = void>

using art::detail::Producer::Table = Modifier::Table<UserConfig, KeysToIgnore>

inherited

Definition at line 26 of file Producer.h.

Constructor & Destructor Documentation

TrackProducerFromTrack::TrackProducerFromTrack ( fhicl::ParameterSet const & p )

explicit

Definition at line 61 of file TrackProducerFromTrack_module.cc.

References doSpacePoints_, doTrackFitHitInfo_, spacePointsFromTrajP_, trackInputTag, and trackMaker_.

   : EDProducer{p}
   , trackMaker_{art::make_tool<trkmkr::TrackMaker>(p.get<fhicl::ParameterSet>("trackMaker"))}
   , trackInputTag{p.get<art::InputTag>("inputCollection")}
   , doTrackFitHitInfo_{p.get<bool>("doTrackFitHitInfo")}
   , doSpacePoints_{p.get<bool>("doSpacePoints")}
   , spacePointsFromTrajP_{p.get<bool>("spacePointsFromTrajP")}
 {
   produces<std::vector<recob::Track>>();
   produces<art::Assns<recob::Track, recob::Hit>>();
   if (doTrackFitHitInfo_) produces<std::vector<std::vector<recob::TrackFitHitInfo>>>();
   if (doSpacePoints_) {
     produces<std::vector<recob::SpacePoint>>();
     produces<art::Assns<recob::Hit, recob::SpacePoint>>();
   }
 }

TrackProducerFromTrack::TrackProducerFromTrack ( TrackProducerFromTrack const & )

delete

TrackProducerFromTrack::TrackProducerFromTrack ( TrackProducerFromTrack && )

delete

Member Function Documentation

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::consumes ( InputTag const & tag )

protectedinherited

Definition at line 61 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumes().

   {
     return collector_.consumes<T, BT>(tag);
   }

ConsumesCollector & art::ModuleBase::consumesCollector ( )

protectedinherited

Definition at line 57 of file ModuleBase.cc.

References art::ModuleBase::collector_.

   {
     return collector_;
   }

template<typename T , BranchType BT>

void art::ModuleBase::consumesMany ( )

protectedinherited

Definition at line 75 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesMany().

   {
     collector_.consumesMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::consumesView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::consumesView ( InputTag const & tag )

inherited

Definition at line 68 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::consumesView().

   {
     return collector_.consumesView<T, BT>(tag);
   }

void art::detail::Producer::doBeginJob ( SharedResources const & resources )

inherited

Definition at line 22 of file Producer.cc.

References art::detail::Producer::beginJobWithFrame(), and art::detail::Producer::setupQueues().

   {
     setupQueues(resources);
     ProcessingFrame const frame{ScheduleID{}};
     beginJobWithFrame(frame);
   }

bool art::detail::Producer::doBeginRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 65 of file Producer.cc.

References art::detail::Producer::beginRunWithFrame(), art::RangeSet::forRun(), art::RunPrincipal::makeRun(), r, art::RunPrincipal::runID(), and art::ModuleContext::scheduleID().

   {
     auto r = rp.makeRun(mc, RangeSet::forRun(rp.runID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doBeginSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 85 of file Producer.cc.

References art::detail::Producer::beginSubRunWithFrame(), art::RangeSet::forSubRun(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::SubRunPrincipal::subRunID().

   {
     auto sr = srp.makeSubRun(mc, RangeSet::forSubRun(srp.subRunID()));
     ProcessingFrame const frame{mc.scheduleID()};
     beginSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

void art::detail::Producer::doEndJob ( )

inherited

Definition at line 30 of file Producer.cc.

References art::detail::Producer::endJobWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     endJobWithFrame(frame);
   }

bool art::detail::Producer::doEndRun	(	RunPrincipal &	rp,
		ModuleContext const &	mc
	)

inherited

Definition at line 75 of file Producer.cc.

References art::detail::Producer::endRunWithFrame(), art::RunPrincipal::makeRun(), r, art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto r = rp.makeRun(mc, rp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endRunWithFrame(r, frame);
     r.commitProducts();
     return true;
   }

bool art::detail::Producer::doEndSubRun	(	SubRunPrincipal &	srp,
		ModuleContext const &	mc
	)

inherited

Definition at line 95 of file Producer.cc.

References art::detail::Producer::endSubRunWithFrame(), art::SubRunPrincipal::makeSubRun(), art::ModuleContext::scheduleID(), and art::Principal::seenRanges().

   {
     auto sr = srp.makeSubRun(mc, srp.seenRanges());
     ProcessingFrame const frame{mc.scheduleID()};
     endSubRunWithFrame(sr, frame);
     sr.commitProducts();
     return true;
   }

bool art::detail::Producer::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
	)

inherited

Definition at line 105 of file Producer.cc.

References art::detail::Producer::checkPutProducts_, e, art::EventPrincipal::makeEvent(), art::detail::Producer::produceWithFrame(), and art::ModuleContext::scheduleID().

   {
     auto e = ep.makeEvent(mc);
     ++counts_run;
     ProcessingFrame const frame{mc.scheduleID()};
     produceWithFrame(e, frame);
     e.commitProducts(checkPutProducts_, &expectedProducts<InEvent>());
     ++counts_passed;
     return true;
   }

void art::detail::Producer::doRespondToCloseInputFile ( FileBlock const & fb )

inherited

Definition at line 44 of file Producer.cc.

References art::detail::Producer::respondToCloseInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToCloseOutputFiles ( FileBlock const & fb )

inherited

Definition at line 58 of file Producer.cc.

References art::detail::Producer::respondToCloseOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToCloseOutputFilesWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenInputFile ( FileBlock const & fb )

inherited

Definition at line 37 of file Producer.cc.

References art::detail::Producer::respondToOpenInputFileWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenInputFileWithFrame(fb, frame);
   }

void art::detail::Producer::doRespondToOpenOutputFiles ( FileBlock const & fb )

inherited

Definition at line 51 of file Producer.cc.

References art::detail::Producer::respondToOpenOutputFilesWithFrame().

   {
     ProcessingFrame const frame{ScheduleID{}};
     respondToOpenOutputFilesWithFrame(fb, frame);
   }

void art::Modifier::fillProductDescriptions ( )

inherited

Definition at line 10 of file Modifier.cc.

References art::ProductRegistryHelper::fillDescriptions(), and art::ModuleBase::moduleDescription().

   {
     ProductRegistryHelper::fillDescriptions(moduleDescription());
   }

std::array< std::vector< ProductInfo >, NumBranchTypes > const & art::ModuleBase::getConsumables ( ) const

inherited

Definition at line 43 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::getConsumables().

   {
     return collector_.getConsumables();
   }

std::unique_ptr< Worker > art::ModuleBase::makeWorker ( WorkerParams const & wp )

inherited

Definition at line 37 of file ModuleBase.cc.

References art::ModuleBase::doMakeWorker(), and art::NumBranchTypes.

   {
     return doMakeWorker(wp);
   }

template<typename T , BranchType BT>

ProductToken< T > art::ModuleBase::mayConsume ( InputTag const & tag )

protectedinherited

Definition at line 82 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsume().

   {
     return collector_.mayConsume<T, BT>(tag);
   }

template<typename T , BranchType BT>

void art::ModuleBase::mayConsumeMany ( )

protectedinherited

Definition at line 96 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeMany().

   {
     collector_.mayConsumeMany<T, BT>();
   }

template<typename Element , BranchType = InEvent>

ViewToken<Element> art::ModuleBase::mayConsumeView ( InputTag const & )

protectedinherited

template<typename T , BranchType BT>

ViewToken<T> art::ModuleBase::mayConsumeView ( InputTag const & tag )

inherited

Definition at line 89 of file ModuleBase.h.

References art::ModuleBase::collector_, and art::ConsumesCollector::mayConsumeView().

   {
     return collector_.mayConsumeView<T, BT>(tag);
   }

ModuleDescription const & art::ModuleBase::moduleDescription ( ) const

inherited

Definition at line 13 of file ModuleBase.cc.

References art::errors::LogicError.

Referenced by art::OutputModule::doRespondToOpenInputFile(), art::OutputModule::doWriteEvent(), art::Modifier::fillProductDescriptions(), art::OutputModule::makePlugins_(), art::OutputWorker::OutputWorker(), reco::shower::LArPandoraModularShowerCreation::produce(), art::Modifier::registerProducts(), and art::OutputModule::registerProducts().

   {
     if (md_.has_value()) {
       return *md_;
     }
 
     throw Exception{errors::LogicError,
                     "There was an error while calling moduleDescription().\n"}
       << "The moduleDescription() base-class member function cannot be called\n"
          "during module construction.  To determine which module is "
          "responsible\n"
          "for calling it, find the '<module type>:<module "
          "label>@Construction'\n"
          "tag in the message prefix above.  Please contact artists@fnal.gov\n"
          "for guidance.\n";
   }

TrackProducerFromTrack& TrackProducerFromTrack::operator= ( TrackProducerFromTrack const & )

delete

TrackProducerFromTrack& TrackProducerFromTrack::operator= ( TrackProducerFromTrack && )

delete

void TrackProducerFromTrack::produce ( art::Event & e )

overrideprivatevirtual

Implements art::EDProducer.

Definition at line 78 of file TrackProducerFromTrack_module.cc.

References util::associated_groups(), DEFINE_ART_MODULE, doSpacePoints_, doTrackFitHitInfo_, art::ProductRetriever::getValidHandle(), trkmkr::OptionalOutputs::initSpacePoints(), trkmkr::OptionalOutputs::initTrackFitInfos(), recob::TrackTrajectory::LocationAtPoint(), recob::Track::NumberTrajectoryPoints(), art::Event::put(), trkmkr::OptionalOutputs::spacePointHitPairs(), spacePointsFromTrajP_, track, trkmkr::OptionalOutputs::trackFitHitInfos(), trackInputTag, trackMaker_, and recob::Track::Trajectory().

 {
   // Output collections
   auto outputTracks = std::make_unique<std::vector<recob::Track>>();
   auto outputHits = std::make_unique<art::Assns<recob::Track, recob::Hit>>();
   auto outputHitInfo = std::make_unique<std::vector<std::vector<recob::TrackFitHitInfo>>>();
   auto outputSpacePoints = std::make_unique<std::vector<recob::SpacePoint>>();
   auto outputHitSpacePointAssn = std::make_unique<art::Assns<recob::Hit, recob::SpacePoint>>();
 
   // PtrMakers for Assns
   art::PtrMaker<recob::Track> trackPtrMaker(e);
   art::PtrMaker<recob::SpacePoint> spacePointPtrMaker(e);
 
   // Input from event
   auto const inputTracks = e.getValidHandle<std::vector<recob::Track>>(trackInputTag);
   auto const& tkHitsAssn = *e.getValidHandle<art::Assns<recob::Track, recob::Hit>>(trackInputTag);
   const auto& tracksWithHits = util::associated_groups(tkHitsAssn);
 
   // Initialize tool for this event
   trackMaker_->initEvent(e);
 
   auto const detProp = art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(e);
 
   // Loop over tracks to refit
   unsigned int iTrack = 0;
   for (auto hitsRange : tracksWithHits) {
 
     // Get track and its hits
     art::Ptr<recob::Track> track(inputTracks, iTrack++);
     std::vector<art::Ptr<recob::Hit>> inHits;
     for (art::Ptr<recob::Hit> const& hit : hitsRange)
       inHits.push_back(hit);
 
     // Declare output objects
     recob::Track outTrack;
     std::vector<art::Ptr<recob::Hit>> outHits;
     trkmkr::OptionalOutputs optionals;
     if (doTrackFitHitInfo_) optionals.initTrackFitInfos();
     if (doSpacePoints_ && !spacePointsFromTrajP_) optionals.initSpacePoints();
 
     // Invoke tool to fit track and fill output objects
     bool fitok = trackMaker_->makeTrack(detProp, track, inHits, outTrack, outHits, optionals);
     if (!fitok) continue;
 
     // Check that the requirement Nhits == Npoints is satisfied
     // We also require the hits to the in the same order as the points (this cannot be enforced, can it?)
     if (outTrack.NumberTrajectoryPoints() != outHits.size()) {
       throw cet::exception("TrackProducerFromTrack")
         << "Produced recob::Track required to have 1-1 correspondance between hits and "
            "points.\noutTrack.NumberTrajectoryPoints()="
         << outTrack.NumberTrajectoryPoints() << " outHits.size()=" << outHits.size() << "\n";
     }
 
     // Fill output collections, including Assns
     outputTracks->emplace_back(std::move(outTrack));
     const art::Ptr<recob::Track> aptr = trackPtrMaker(outputTracks->size() - 1);
     unsigned int ip = 0;
     for (auto const& trhit : outHits) {
       outputHits->addSingle(aptr, trhit);
 
       if (doSpacePoints_ && spacePointsFromTrajP_ && outputTracks->back().HasValidPoint(ip)) {
         auto& tp = outputTracks->back().Trajectory().LocationAtPoint(ip);
         const double fXYZ[3] = {tp.X(), tp.Y(), tp.Z()};
         const double fErrXYZ[6] = {0};
         recob::SpacePoint sp(fXYZ, fErrXYZ, -1.);
         outputSpacePoints->emplace_back(std::move(sp));
         const art::Ptr<recob::SpacePoint> apsp = spacePointPtrMaker(outputSpacePoints->size() - 1);
         outputHitSpacePointAssn->addSingle(trhit, apsp);
       }
       ip++;
     }
     if (doSpacePoints_ && !spacePointsFromTrajP_) {
       auto osp = optionals.spacePointHitPairs();
       for (auto it = osp.begin(); it != osp.end(); ++it) {
         outputSpacePoints->emplace_back(std::move(it->first));
         const art::Ptr<recob::SpacePoint> apsp = spacePointPtrMaker(outputSpacePoints->size() - 1);
         outputHitSpacePointAssn->addSingle(it->second, apsp);
       }
     }
     if (doTrackFitHitInfo_) { outputHitInfo->emplace_back(optionals.trackFitHitInfos()); }
   }
 
   // Put collections in the event
   e.put(std::move(outputTracks));
   e.put(std::move(outputHits));
   if (doTrackFitHitInfo_) { e.put(std::move(outputHitInfo)); }
   if (doSpacePoints_) {
     e.put(std::move(outputSpacePoints));
     e.put(std::move(outputHitSpacePointAssn));
   }
 }

void art::Modifier::registerProducts ( ProductDescriptions & productsToRegister )

inherited

Definition at line 16 of file Modifier.cc.

References art::ModuleBase::moduleDescription(), and art::ProductRegistryHelper::registerProducts().

   {
     ProductRegistryHelper::registerProducts(productsToRegister,
                                             moduleDescription());
   }

void art::ModuleBase::setModuleDescription ( ModuleDescription const & md )

inherited

Definition at line 31 of file ModuleBase.cc.

References art::ModuleBase::md_.

   {
     md_ = md;
   }

void art::ModuleBase::sortConsumables ( std::string const & current_process_name )

inherited

Definition at line 49 of file ModuleBase.cc.

References art::ModuleBase::collector_, and art::ConsumesCollector::sortConsumables().

   {
     // Now that we know we have seen all the consumes declarations,
     // sort the results for fast lookup later.
     collector_.sortConsumables(current_process_name);
   }