Public Member Functions | Private Member Functions | Private Attributes | List of all members
lar_pandora::LArPandoraTrackCreation Class Reference
Inheritance diagram for lar_pandora::LArPandoraTrackCreation:
art::EDProducer art::detail::Producer art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper

Public Member Functions

 LArPandoraTrackCreation (fhicl::ParameterSet const &pset)
 
 LArPandoraTrackCreation (LArPandoraTrackCreation const &)=delete
 
 LArPandoraTrackCreation (LArPandoraTrackCreation &&)=delete
 
LArPandoraTrackCreationoperator= (LArPandoraTrackCreation const &)=delete
 
LArPandoraTrackCreationoperator= (LArPandoraTrackCreation &&)=delete
 
void produce (art::Event &evt) override
 
- Public Member Functions inherited from art::EDProducer
 EDProducer (fhicl::ParameterSet const &pset)
 
template<typename Config >
 EDProducer (Table< Config > const &config)
 
std::string workerType () const
 
- Public Member Functions inherited from art::detail::Producer
virtual ~Producer () noexcept
 
 Producer (fhicl::ParameterSet const &)
 
 Producer (Producer const &)=delete
 
 Producer (Producer &&)=delete
 
Produceroperator= (Producer const &)=delete
 
Produceroperator= (Producer &&)=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)
 
- Public Member Functions inherited from art::Modifier
 ~Modifier () noexcept
 
 Modifier ()
 
 Modifier (Modifier const &)=delete
 
 Modifier (Modifier &&)=delete
 
Modifieroperator= (Modifier const &)=delete
 
Modifieroperator= (Modifier &&)=delete
 
- 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 Member Functions

recob::Track BuildTrack (const int id, const lar_content::LArTrackStateVector &trackStateVector) const
 Build a recob::Track object. More...
 

Private Attributes

std::string m_pfParticleLabel
 The pf particle label. More...
 
unsigned int m_minTrajectoryPoints
 The minimum number of trajectory points. More...
 
unsigned int m_slidingFitHalfWindow
 The sliding fit half window. More...
 
bool m_useAllParticles
 Build a recob::Track for every recob::PFParticle. More...
 

Additional Inherited Members

- Public Types inherited from art::EDProducer
using ModuleType = EDProducer
 
using WorkerType = WorkerT< EDProducer >
 
- Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using Table = Modifier::Table< UserConfig, KeysToIgnore >
 
- Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
 
- Static Public Member Functions inherited from art::EDProducer
static void commitEvent (EventPrincipal &ep, Event &e)
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollectorconsumesCollector ()
 
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

Definition at line 25 of file LArPandoraTrackCreation_module.cc.

Constructor & Destructor Documentation

lar_pandora::LArPandoraTrackCreation::LArPandoraTrackCreation ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 89 of file LArPandoraTrackCreation_module.cc.

89  :
90  EDProducer{pset},
91  m_pfParticleLabel(pset.get<std::string>("PFParticleLabel")),
92  m_minTrajectoryPoints(pset.get<unsigned int>("MinTrajectoryPoints", 2)),
93  m_slidingFitHalfWindow(pset.get<unsigned int>("SlidingFitHalfWindow", 20)),
94  m_useAllParticles(pset.get<bool>("UseAllParticles", false))
95 {
96  produces< std::vector<recob::Track> >();
97  produces< art::Assns<recob::PFParticle, recob::Track> >();
98  produces< art::Assns<recob::Track, recob::Hit> >();
99  produces< art::Assns<recob::Track, recob::Hit, recob::TrackHitMeta> >();
100 
101  if (m_minTrajectoryPoints<2) throw cet::exception("LArPandoraTrackCreation") << "MinTrajectoryPoints should not be smaller than 2!";
102 
103 }
std::string string
Definition: nybbler.cc:12
EDProducer(fhicl::ParameterSet const &pset)
Definition: EDProducer.h:20
unsigned int m_slidingFitHalfWindow
The sliding fit half window.
bool m_useAllParticles
Build a recob::Track for every recob::PFParticle.
std::string m_pfParticleLabel
The pf particle label.
unsigned int m_minTrajectoryPoints
The minimum number of trajectory points.
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
lar_pandora::LArPandoraTrackCreation::LArPandoraTrackCreation ( LArPandoraTrackCreation const &  )
delete
lar_pandora::LArPandoraTrackCreation::LArPandoraTrackCreation ( LArPandoraTrackCreation &&  )
delete

Member Function Documentation

recob::Track lar_pandora::LArPandoraTrackCreation::BuildTrack ( const int  id,
const lar_content::LArTrackStateVector trackStateVector 
) const
private

Build a recob::Track object.

Parameters
idthe id code for the track
trackStateVectorthe vector of trajectory points for this track

Definition at line 250 of file LArPandoraTrackCreation_module.cc.

251 {
252  if (trackStateVector.empty())
253  throw cet::exception("LArPandoraTrackCreation") << "BuildTrack - No input trajectory points provided ";
254 
258 
259  for (const lar_content::LArTrackState &trackState : trackStateVector)
260  {
261  xyz.emplace_back(recob::tracking::Point_t(trackState.GetPosition().GetX(), trackState.GetPosition().GetY(), trackState.GetPosition().GetZ()));
262  pxpypz.emplace_back(recob::tracking::Vector_t(trackState.GetDirection().GetX(), trackState.GetDirection().GetY(), trackState.GetDirection().GetZ()));
263  // Set flag NoPoint if point has bogus coordinates, otherwise use clean flag set
264  if (std::fabs(trackState.GetPosition().GetX()-util::kBogusF)<std::numeric_limits<float>::epsilon() &&
265  std::fabs(trackState.GetPosition().GetY()-util::kBogusF)<std::numeric_limits<float>::epsilon() &&
266  std::fabs(trackState.GetPosition().GetZ()-util::kBogusF)<std::numeric_limits<float>::epsilon())
267  {
269  } else {
270  flags.emplace_back(recob::TrajectoryPointFlags());
271  }
272  }
273 
274  // note from gc: eventually we should produce a TrackTrajectory, not a Track with empty covariance matrix and bogus chi2, etc.
275  return recob::Track(recob::TrackTrajectory(std::move(xyz), std::move(pxpypz), std::move(flags), false),
277 }
static constexpr Flag_t NoPoint
The trajectory point is not defined.
ROOT::Math::SMatrix< Double32_t, 5, 5, ROOT::Math::MatRepSym< Double32_t, 5 > > SMatrixSym55
Definition: TrackingTypes.h:85
LArTrackState class.
Definition: LArPfoObjects.h:29
constexpr int kBogusI
obviously bogus integer value
ROOT::Math::DisplacementVector3D< ROOT::Math::Cartesian3D< Coord_t >, ROOT::Math::GlobalCoordinateSystemTag > Vector_t
Type for representation of momenta in 3D space. See recob::tracking::Coord_t for more details on the ...
Definition: TrackingTypes.h:29
A trajectory in space reconstructed from hits.
def move(depos, offset)
Definition: depos.py:107
std::vector< Vector_t > Momenta_t
Type of momentum list.
Definition: TrackingTypes.h:35
std::vector< PointFlags_t > Flags_t
Type of point flag list.
static constexpr HitIndex_t InvalidHitIndex
Value marking an invalid hit index.
std::vector< Point_t > Positions_t
Type of trajectory point list.
Definition: TrackingTypes.h:32
constexpr float kBogusF
obviously bogus float value
TrackCollectionProxyElement< TrackCollProxy > Track
Proxy to an element of a proxy collection of recob::Track objects.
Definition: Track.h:1036
ROOT::Math::PositionVector3D< ROOT::Math::Cartesian3D< Coord_t >, ROOT::Math::GlobalCoordinateSystemTag > Point_t
Type for representation of position in physical 3D space. See recob::tracking::Coord_t for more detai...
Definition: TrackingTypes.h:26
Set of flags pertaining a point of the track.
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
LArPandoraTrackCreation& lar_pandora::LArPandoraTrackCreation::operator= ( LArPandoraTrackCreation const &  )
delete
LArPandoraTrackCreation& lar_pandora::LArPandoraTrackCreation::operator= ( LArPandoraTrackCreation &&  )
delete
void lar_pandora::LArPandoraTrackCreation::produce ( art::Event evt)
overridevirtual

Implements art::EDProducer.

Definition at line 107 of file LArPandoraTrackCreation_module.cc.

108 {
109  std::unique_ptr< std::vector<recob::Track> > outputTracks( new std::vector<recob::Track> );
110  std::unique_ptr< art::Assns<recob::PFParticle, recob::Track> > outputParticlesToTracks( new art::Assns<recob::PFParticle, recob::Track> );
111  std::unique_ptr< art::Assns<recob::Track, recob::Hit> > outputTracksToHits( new art::Assns<recob::Track, recob::Hit> );
112  std::unique_ptr< art::Assns<recob::Track, recob::Hit, recob::TrackHitMeta> > outputTracksToHitsWithMeta( new art::Assns<recob::Track, recob::Hit, recob::TrackHitMeta> );
113 
114  LArPandoraDetectorType* detType(detector_functions::GetDetectorType());
115  // 'wirePitchW` is here used only to provide length scale for binning hits and performing sliding/local linear fits.
116  const float wirePitchW(detType->WirePitchW());
117 
118  int trackCounter(0);
119  const art::PtrMaker<recob::Track> makeTrackPtr(evt);
120 
121  // Organise inputs
122  PFParticleVector pfParticleVector, extraPfParticleVector;
123  PFParticlesToSpacePoints pfParticlesToSpacePoints;
124  PFParticlesToClusters pfParticlesToClusters;
125  LArPandoraHelper::CollectPFParticles(evt, m_pfParticleLabel, pfParticleVector, pfParticlesToSpacePoints);
126  LArPandoraHelper::CollectPFParticles(evt, m_pfParticleLabel, extraPfParticleVector, pfParticlesToClusters);
127 
128  VertexVector vertexVector;
129  PFParticlesToVertices pfParticlesToVertices;
130  LArPandoraHelper::CollectVertices(evt, m_pfParticleLabel, vertexVector, pfParticlesToVertices);
131 
132  for (const art::Ptr<recob::PFParticle> pPFParticle : pfParticleVector)
133  {
134  // Select track-like pfparticles
135  if (!m_useAllParticles && !LArPandoraHelper::IsTrack(pPFParticle))
136  continue;
137 
138  // Obtain associated spacepoints
139  PFParticlesToSpacePoints::const_iterator particleToSpacePointIter(pfParticlesToSpacePoints.find(pPFParticle));
140 
141  if (pfParticlesToSpacePoints.end() == particleToSpacePointIter)
142  {
143  mf::LogDebug("LArPandoraTrackCreation") << "No spacepoints associated to particle ";
144  continue;
145  }
146 
147  // Obtain associated clusters
148  PFParticlesToClusters::const_iterator particleToClustersIter(pfParticlesToClusters.find(pPFParticle));
149 
150  if (pfParticlesToClusters.end() == particleToClustersIter)
151  {
152  mf::LogDebug("LArPandoraShowerCreation") << "No clusters associated to particle ";
153  continue;
154  }
155 
156  // Obtain associated vertex
157  PFParticlesToVertices::const_iterator particleToVertexIter(pfParticlesToVertices.find(pPFParticle));
158 
159  if ((pfParticlesToVertices.end() == particleToVertexIter) || (1 != particleToVertexIter->second.size()))
160  {
161  mf::LogDebug("LArPandoraTrackCreation") << "Unexpected number of vertices for particle ";
162  continue;
163  }
164 
165  // Copy information into expected pandora form
166  pandora::CartesianPointVector cartesianPointVector;
167  for (const art::Ptr<recob::SpacePoint> spacePoint : particleToSpacePointIter->second)
168  cartesianPointVector.emplace_back(pandora::CartesianVector(spacePoint->XYZ()[0], spacePoint->XYZ()[1], spacePoint->XYZ()[2]));
169 
170  double vertexXYZ[3] = {0., 0., 0.};
171  particleToVertexIter->second.front()->XYZ(vertexXYZ);
172  const pandora::CartesianVector vertexPosition(vertexXYZ[0], vertexXYZ[1], vertexXYZ[2]);
173 
174  // Call pandora "fast" track fitter
175  lar_content::LArTrackStateVector trackStateVector;
176  pandora::IntVector indexVector;
177  try
178  {
179  lar_content::LArPfoHelper::GetSlidingFitTrajectory(cartesianPointVector, vertexPosition, m_slidingFitHalfWindow, wirePitchW, trackStateVector, &indexVector);
180  }
181  catch (const pandora::StatusCodeException &)
182  {
183  mf::LogDebug("LArPandoraTrackCreation") << "Unable to extract sliding fit trajectory";
184  continue;
185  }
186 
187  if (trackStateVector.size() < m_minTrajectoryPoints)
188  {
189  mf::LogDebug("LArPandoraTrackCreation") << "Insufficient input trajectory points to build track: " << trackStateVector.size();
190  continue;
191  }
192 
193  HitVector hitsFromSpacePoints, hitsFromClusters, hitsInParticle;
194  HitSet hitsInParticleSet;
195 
196  LArPandoraHelper::GetAssociatedHits(evt, m_pfParticleLabel, particleToSpacePointIter->second, hitsFromSpacePoints, &indexVector);
197  LArPandoraHelper::GetAssociatedHits(evt, m_pfParticleLabel, particleToClustersIter->second, hitsFromClusters);
198  //ATTN: hits ordered from space points if available, rest added at the end
199  for (unsigned int hitIndex = 0; hitIndex < hitsFromSpacePoints.size(); hitIndex++)
200  {
201  hitsInParticle.push_back(hitsFromSpacePoints.at(hitIndex));
202  (void) hitsInParticleSet.insert(hitsFromSpacePoints.at(hitIndex));
203  }
204 
205  for (unsigned int hitIndex = 0; hitIndex < hitsFromClusters.size(); hitIndex++)
206  {
207  if (hitsInParticleSet.count(hitsFromClusters.at(hitIndex)) == 0)
208  hitsInParticle.push_back(hitsFromClusters.at(hitIndex));
209  }
210 
211  // Add invalid points at the end of the vector, so that the number of the trajectory points is the same as the number of hits
212  if (trackStateVector.size()>hitsFromSpacePoints.size())
213  {
214  throw cet::exception("LArPandoraTrackCreation") << "trackStateVector.size() is greater than hitsFromSpacePoints.size()";
215  }
216  const unsigned int nInvalidPoints = hitsInParticle.size()-trackStateVector.size();
217  for (unsigned int i=0;i<nInvalidPoints;++i) {
218  trackStateVector.push_back(lar_content::LArTrackState(pandora::CartesianVector(util::kBogusF,util::kBogusF,util::kBogusF),
219  pandora::CartesianVector(util::kBogusF,util::kBogusF,util::kBogusF), nullptr));
220  }
221 
222  // Output objects
223  outputTracks->emplace_back(LArPandoraTrackCreation::BuildTrack(trackCounter++, trackStateVector));
224  art::Ptr<recob::Track> pTrack(makeTrackPtr(outputTracks->size() - 1));
225 
226  // Output associations, after output objects are in place
227  util::CreateAssn(*this, evt, pTrack, pPFParticle, *(outputParticlesToTracks.get()));
228  util::CreateAssn(*this, evt, *(outputTracks.get()), hitsInParticle, *(outputTracksToHits.get()));
229 
230  //ATTN: metadata added with index from space points if available, null for others
231  for (unsigned int hitIndex = 0; hitIndex < hitsInParticle.size(); hitIndex++)
232  {
233  const art::Ptr<recob::Hit> pHit(hitsInParticle.at(hitIndex));
234  const int index((hitIndex < hitsFromSpacePoints.size()) ? hitIndex : std::numeric_limits<int>::max());
236  outputTracksToHitsWithMeta->addSingle(pTrack, pHit, metadata);
237  }
238  }
239 
240  mf::LogDebug("LArPandoraTrackCreation") << "Number of new tracks: " << outputTracks->size() << std::endl;
241 
242  evt.put(std::move(outputTracks));
243  evt.put(std::move(outputTracksToHits));
244  evt.put(std::move(outputTracksToHitsWithMeta));
245  evt.put(std::move(outputParticlesToTracks));
246 }
std::unordered_set< art::Ptr< recob::Hit > > HitSet
std::map< art::Ptr< recob::PFParticle >, ClusterVector > PFParticlesToClusters
LArTrackState class.
Definition: LArPfoObjects.h:29
static void GetSlidingFitTrajectory(const pandora::CartesianPointVector &pointVector, const pandora::CartesianVector &vertexPosition, const unsigned int layerWindow, const float layerPitch, LArTrackStateVector &trackStateVector, pandora::IntVector *const pIndexVector=nullptr)
Apply 3D sliding fit to a set of 3D points and return track trajectory.
intermediate_table::const_iterator const_iterator
Data related to recob::Hit associated with recob::Track.The purpose is to collect several variables t...
Definition: TrackHitMeta.h:43
std::vector< int > IntVector
unsigned int m_slidingFitHalfWindow
The sliding fit half window.
std::map< art::Ptr< recob::PFParticle >, VertexVector > PFParticlesToVertices
static void GetAssociatedHits(const art::Event &evt, const std::string &label, const std::vector< art::Ptr< T >> &inputVector, HitVector &associatedHits, const pandora::IntVector *const indexVector=nullptr)
Get all hits associated with input clusters.
std::vector< art::Ptr< recob::PFParticle > > PFParticleVector
bool m_useAllParticles
Build a recob::Track for every recob::PFParticle.
def move(depos, offset)
Definition: depos.py:107
std::string m_pfParticleLabel
The pf particle label.
static void CollectVertices(const art::Event &evt, const std::string &label, VertexVector &vertexVector, PFParticlesToVertices &particlesToVertices)
Collect the reconstructed PFParticles and associated Vertices from the ART event record.
ProductID put(std::unique_ptr< PROD > &&edp, std::string const &instance={})
Definition: DataViewImpl.h:686
bool CreateAssn(PRODUCER const &prod, art::Event &evt, std::vector< T > const &a, art::Ptr< U > const &b, art::Assns< U, T > &assn, std::string a_instance, size_t indx=UINT_MAX)
Creates a single one-to-one association.
static int max(int a, int b)
std::map< art::Ptr< recob::PFParticle >, SpacePointVector > PFParticlesToSpacePoints
static void CollectPFParticles(const art::Event &evt, const std::string &label, PFParticleVector &particleVector)
Collect the reconstructed PFParticles from the ART event record.
std::vector< art::Ptr< recob::Hit > > HitVector
LArPandoraDetectorType * GetDetectorType()
Factory class that returns the correct detector type interface.
constexpr float kBogusF
obviously bogus float value
MaybeLogger_< ELseverityLevel::ELsev_success, false > LogDebug
static bool IsTrack(const art::Ptr< recob::PFParticle > particle)
Determine whether a particle has been reconstructed as track-like.
recob::Track BuildTrack(const int id, const lar_content::LArTrackStateVector &trackStateVector) const
Build a recob::Track object.
const Double32_t * XYZ() const
Definition: SpacePoint.h:76
std::vector< art::Ptr< recob::Vertex > > VertexVector
std::vector< LArTrackState > LArTrackStateVector
Definition: LArPfoObjects.h:67
unsigned int m_minTrajectoryPoints
The minimum number of trajectory points.
cet::coded_exception< error, detail::translate > exception
Definition: exception.h:33
QTextStream & endl(QTextStream &s)

Member Data Documentation

unsigned int lar_pandora::LArPandoraTrackCreation::m_minTrajectoryPoints
private

The minimum number of trajectory points.

Definition at line 47 of file LArPandoraTrackCreation_module.cc.

std::string lar_pandora::LArPandoraTrackCreation::m_pfParticleLabel
private

The pf particle label.

Definition at line 46 of file LArPandoraTrackCreation_module.cc.

unsigned int lar_pandora::LArPandoraTrackCreation::m_slidingFitHalfWindow
private

The sliding fit half window.

Definition at line 48 of file LArPandoraTrackCreation_module.cc.

bool lar_pandora::LArPandoraTrackCreation::m_useAllParticles
private

Build a recob::Track for every recob::PFParticle.

Definition at line 49 of file LArPandoraTrackCreation_module.cc.


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