trkmkr::OptionalOutputs Struct Reference

Struct holding optional TrackMaker outputs. More...

#include "TrackMaker.h"

Public Types
typedef std::pair< recob::SpacePoint, art::Ptr< recob::Hit > >	SpHitPair

Public Member Functions
void	addPoint (OptionalPointElement &ope)
	add one OptionalPointElement More...
void	addPoint (OptionalPointElement &ope, art::Ptr< recob::Hit > hptr)
	add one OptionalPointElement and the corresponding hit More...
void	reset ()
	reset the stored vectors More...
void	initTrackFitInfos ()
	initialize the output vector of TrackFitHitInfos More...
void	initSpacePoints ()
	initialize the output vector of SpHitPair More...
bool	isTrackFitInfosInit ()
	check initialization of the output vector of TrackFitHitInfos More...
bool	isSpacePointsInit ()
	check initialization of the output vector of SpHitPair More...
std::vector< recob::TrackFitHitInfo >	trackFitHitInfos ()
	get the output vector of TrackFitHitInfos by releasing and moving More...
std::vector< SpHitPair >	spacePointHitPairs ()
	get the output vector of SpHitPair by releasing and moving More...

Private Attributes
std::unique_ptr< std::vector< recob::TrackFitHitInfo > >	outTrackFitHitInfos
std::unique_ptr< std::vector< SpHitPair > >	outSpacePointHitPairs

Detailed Description

Struct holding optional TrackMaker outputs.

This struct holds the optional outputs of track making and hides their details to the actual track making tools. In this way, adding a new optional output will affect only those tools that produce such new ouput.

It stores a unique_ptr to the vector of each optional output object (meant to be per-track). Track making tools need to init the outional outputs they will produce, so that only the unique_ptrs that are needed are actually created. Functions are provided (called addPoint) to add point-by-point elements (see OptionalPointElement). When the output objects are returned, the unique_ptr is reset, so that no new elements should be added and a new initialization is needed.

Author

G. Cerati (FNAL, MicroBooNE)

Date

2017

Version

1.0

Definition at line 73 of file TrackMaker.h.

Member Typedef Documentation

typedef std::pair<recob::SpacePoint, art::Ptr<recob::Hit> > trkmkr::OptionalOutputs::SpHitPair

Definition at line 75 of file TrackMaker.h.

Member Function Documentation

void trkmkr::OptionalOutputs::addPoint ( OptionalPointElement &  ope )

inline

add one OptionalPointElement

Definition at line 78 of file TrackMaker.h.

References trkmkr::OptionalPointElement::getTrackFitHitInfo(), and trkmkr::OptionalPointElement::isTrackFitInfoSet().

                                             {
      if (isTrackFitInfosInit() && ope.isTrackFitInfoSet()) {
        outTrackFitHitInfos->push_back( ope.getTrackFitHitInfo() );
      }
    }

void trkmkr::OptionalOutputs::addPoint ( OptionalPointElement &  ope, art::Ptr< recob::Hit >  hptr  )

inline

add one OptionalPointElement and the corresponding hit

Definition at line 84 of file TrackMaker.h.

References trkmkr::OptionalPointElement::getSpacePoint(), and trkmkr::OptionalPointElement::isSpacePointSet().

                                                                    {
      if (isSpacePointsInit() && ope.isSpacePointSet()) {
        outSpacePointHitPairs->emplace_back(ope.getSpacePoint(), hptr);
      }
      addPoint(ope);
    }

void trkmkr::OptionalOutputs::initSpacePoints ( )

inline

initialize the output vector of SpHitPair

Definition at line 106 of file TrackMaker.h.

Referenced by TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), and TrackProducerFromPFParticle::produce().

                           {
      outSpacePointHitPairs = std::make_unique< std::vector<SpHitPair> >();
    }

void trkmkr::OptionalOutputs::initTrackFitInfos ( )

inline

initialize the output vector of TrackFitHitInfos

Definition at line 102 of file TrackMaker.h.

Referenced by TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), TrackProducerFromPFParticle::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), and trkf::KalmanFilterFinalTrackFitter::produce().

                             {
      outTrackFitHitInfos = std::make_unique< std::vector<recob::TrackFitHitInfo> >();
    }

bool trkmkr::OptionalOutputs::isSpacePointsInit ( )

inline

check initialization of the output vector of SpHitPair

Definition at line 112 of file TrackMaker.h.

{ return bool(outSpacePointHitPairs); }

bool trkmkr::OptionalOutputs::isTrackFitInfosInit ( )

inline

check initialization of the output vector of TrackFitHitInfos

Definition at line 110 of file TrackMaker.h.

Referenced by trkf::TrackKalmanFitter::fillResult(), and trkmkr::KalmanFilterFitTrackMaker::restoreInputPoints().

{ return bool(outTrackFitHitInfos); }

void trkmkr::OptionalOutputs::reset ( void  )

inline

reset the stored vectors

Definition at line 91 of file TrackMaker.h.

                 {
      if (isTrackFitInfosInit()) {
        outTrackFitHitInfos.reset();
        initTrackFitInfos();
      }
      if (isSpacePointsInit()) {
        outSpacePointHitPairs.reset();
        initSpacePoints();
      }
    }

std::vector<SpHitPair> trkmkr::OptionalOutputs::spacePointHitPairs ( )

inline

get the output vector of SpHitPair by releasing and moving

Definition at line 119 of file TrackMaker.h.

References tmp.

Referenced by TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), and TrackProducerFromPFParticle::produce().

                                              {
      if (!isSpacePointsInit()) throw std::logic_error("outSpacePointHitPairs is not available (any more?).");
      auto tmp = *outSpacePointHitPairs; outSpacePointHitPairs.reset(); return tmp;
    }

std::vector<recob::TrackFitHitInfo> trkmkr::OptionalOutputs::trackFitHitInfos ( )

inline

get the output vector of TrackFitHitInfos by releasing and moving

Definition at line 114 of file TrackMaker.h.

References tmp.

Referenced by TrackProducerFromTrack::produce(), TrackProducerFromTrackTrajectory::produce(), TrackProducerFromPFParticle::produce(), trkf::KalmanFilterTrajectoryFitter::produce(), and trkf::KalmanFilterFinalTrackFitter::produce().

                                                       {
      if (!isTrackFitInfosInit()) throw std::logic_error("outTrackFitHitInfos is not available (any more?).");
      auto tmp = *outTrackFitHitInfos; outTrackFitHitInfos.reset(); return tmp;
    }

Member Data Documentation

std::unique_ptr< std::vector<SpHitPair> > trkmkr::OptionalOutputs::outSpacePointHitPairs

private

Definition at line 125 of file TrackMaker.h.

std::unique_ptr< std::vector<recob::TrackFitHitInfo> > trkmkr::OptionalOutputs::outTrackFitHitInfos

private

Definition at line 124 of file TrackMaker.h.

---

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

• larreco/v06_64_02/source/larreco/TrackFinder/TrackMaker.h