LArSoft  v10_04_05
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
reco_tool::CandHitStandard Class Reference
Inheritance diagram for reco_tool::CandHitStandard:
reco_tool::ICandidateHitFinder

Public Member Functions

 CandHitStandard (const fhicl::ParameterSet &pset)
 
void findHitCandidates (const recob::Wire::RegionsOfInterest_t::datarange_t &, const size_t, const size_t, const size_t, HitCandidateVec &) const override
 
void MergeHitCandidates (const recob::Wire::RegionsOfInterest_t::datarange_t &, const HitCandidateVec &, MergeHitCandidateVec &) const override
 

Private Types

using HitCandidateVec = std::vector< HitCandidate >
 
using MergeHitCandidateVec = std::vector< HitCandidateVec >
 
using Waveform = std::vector< float >
 

Private Member Functions

void findHitCandidates (std::vector< float >::const_iterator, std::vector< float >::const_iterator, const size_t, const size_t, HitCandidateVec &) const
 

Private Attributes

const float fRoiThreshold
 minimum maximum to minimum peak distance More...
 
const geo::WireReadoutGeom * fWireReadoutGeom
 

Detailed Description

Definition at line 16 of file CandHitStandard_tool.cc.

Member Typedef Documentation

using reco_tool::ICandidateHitFinder::HitCandidateVec = std::vector<HitCandidate>
inherited

Definition at line 37 of file ICandidateHitFinder.h.

using reco_tool::ICandidateHitFinder::MergeHitCandidateVec = std::vector<HitCandidateVec>
inherited

Definition at line 38 of file ICandidateHitFinder.h.

using reco_tool::ICandidateHitFinder::Waveform = std::vector<float>
inherited

Definition at line 40 of file ICandidateHitFinder.h.

Constructor & Destructor Documentation

reco_tool::CandHitStandard::CandHitStandard ( const fhicl::ParameterSet &  pset)
explicit

Definition at line 46 of file CandHitStandard_tool.cc.

47  : fRoiThreshold(pset.get<float>("RoiThreshold", 5.))
48  {}
reco_tool::CandHitStandard::fRoiThreshold
const float fRoiThreshold
minimum maximum to minimum peak distance
Definition: CandHitStandard_tool.cc:38
fhicl::ParameterSet::get
T get(std::string const &key) const
Definition: ParameterSet.h:314

Member Function Documentation

void reco_tool::CandHitStandard::findHitCandidates ( const recob::Wire::RegionsOfInterest_t::datarange_t &  dataRange,
const size_t  roiStartTick,
const size_t  channel,
const size_t  ,
HitCandidateVec &  hitCandidateVec 
) const
overridevirtual

Implements reco_tool::ICandidateHitFinder.

Definition at line 50 of file CandHitStandard_tool.cc.

References geo::WireReadoutGeom::ChannelToWire(), and fWireReadoutGeom.

Referenced by findHitCandidates().

56  {
57  // Recover the actual waveform
58  const Waveform& waveform = dataRange.data();
59 
60  // Recover the plane index for this method
61  std::vector<geo::WireID> wids = fWireReadoutGeom->ChannelToWire(channel);
62  const size_t plane = wids[0].Plane;
63 
64  // Use the recursive version to find the candidate hits
65  findHitCandidates(waveform.begin(), waveform.end(), roiStartTick, plane, hitCandidateVec);
66  }
reco_tool::CandHitStandard::fWireReadoutGeom
const geo::WireReadoutGeom * fWireReadoutGeom
Definition: CandHitStandard_tool.cc:40
reco_tool::CandHitStandard::findHitCandidates
void findHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t &, const size_t, const size_t, const size_t, HitCandidateVec &) const override
Definition: CandHitStandard_tool.cc:50
reco_tool::ICandidateHitFinder::Waveform
std::vector< float > Waveform
Definition: ICandidateHitFinder.h:40
geo::WireReadoutGeom::ChannelToWire
virtual std::vector< WireID > ChannelToWire(raw::ChannelID_t channel) const =0
void reco_tool::CandHitStandard::findHitCandidates ( std::vector< float >::const_iterator  startItr,
std::vector< float >::const_iterator  stopItr,
const size_t  roiStartTick,
const size_t  planeIdx,
HitCandidateVec &  hitCandidateVec 
) const
private

Definition at line 68 of file CandHitStandard_tool.cc.

References findHitCandidates(), fRoiThreshold, reco_tool::ICandidateHitFinder::HitCandidate::hitCenter, reco_tool::ICandidateHitFinder::HitCandidate::hitHeight, reco_tool::ICandidateHitFinder::HitCandidate::hitSigma, reco_tool::ICandidateHitFinder::HitCandidate::maxDerivative, reco_tool::ICandidateHitFinder::HitCandidate::maxTick, reco_tool::ICandidateHitFinder::HitCandidate::minDerivative, reco_tool::ICandidateHitFinder::HitCandidate::minTick, reco_tool::ICandidateHitFinder::HitCandidate::startTick, and reco_tool::ICandidateHitFinder::HitCandidate::stopTick.

73  {
74  // Need a minimum number of ticks to do any work here
75  if (std::distance(startItr, stopItr) > 4) {
76  // Find the highest peak in the range given
77  auto maxItr = std::max_element(startItr, stopItr);
78 
79  float maxValue = *maxItr;
80  int maxTime = std::distance(startItr, maxItr);
81 
82  if (maxValue > fRoiThreshold) {
83  // backwards to find first bin for this candidate hit
84  auto firstItr = std::distance(startItr, maxItr) > 2 ? maxItr - 1 : startItr;
85 
86  while (firstItr != startItr) {
87  // Check for pathology where waveform goes too negative
88  if (*firstItr < -fRoiThreshold) break;
89 
90  // Check both sides of firstItr and look for min/inflection point
91  if (*firstItr < *(firstItr + 1) && *firstItr <= *(firstItr - 1)) break;
92 
93  firstItr--;
94  }
95 
96  int firstTime = std::distance(startItr, firstItr);
97 
98  // Recursive call to find all candidate hits earlier than this peak
99  findHitCandidates(startItr, firstItr + 1, roiStartTick, planeIdx, hitCandidateVec);
100 
101  // forwards to find last bin for this candidate hit
102  auto lastItr = std::distance(maxItr, stopItr) > 2 ? maxItr + 1 : stopItr - 1;
103 
104  while (lastItr != stopItr - 1) {
105  // Check for pathology where waveform goes too negative
106  if (*lastItr < -fRoiThreshold) break;
107 
108  // Check both sides of firstItr and look for min/inflection point
109  if (*lastItr <= *(lastItr + 1) && *lastItr < *(lastItr - 1)) break;
110 
111  lastItr++;
112  }
113 
114  int lastTime = std::distance(startItr, lastItr);
115 
116  // Now save this candidate's start and max time info
117  HitCandidate hitCandidate;
118  hitCandidate.startTick = roiStartTick + firstTime;
119  hitCandidate.stopTick = roiStartTick + lastTime;
120  hitCandidate.maxTick = roiStartTick + firstTime;
121  hitCandidate.minTick = roiStartTick + lastTime;
122  hitCandidate.maxDerivative = *(startItr + firstTime);
123  hitCandidate.minDerivative = *(startItr + lastTime);
124  hitCandidate.hitCenter = roiStartTick + maxTime;
125  hitCandidate.hitSigma = std::max(2., float(lastTime - firstTime) / 6.);
126  hitCandidate.hitHeight = maxValue;
127 
128  hitCandidateVec.push_back(hitCandidate);
129 
130  // Recursive call to find all candidate hits later than this peak
131  findHitCandidates(lastItr + 1,
132  stopItr,
133  roiStartTick + std::distance(startItr, lastItr + 1),
134  planeIdx,
135  hitCandidateVec);
136  }
137  }
138  }
reco_tool::CandHitStandard::findHitCandidates
void findHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t &, const size_t, const size_t, const size_t, HitCandidateVec &) const override
Definition: CandHitStandard_tool.cc:50
reco_tool::CandHitStandard::fRoiThreshold
const float fRoiThreshold
minimum maximum to minimum peak distance
Definition: CandHitStandard_tool.cc:38
void reco_tool::CandHitStandard::MergeHitCandidates ( const recob::Wire::RegionsOfInterest_t::datarange_t &  ,
const HitCandidateVec &  hitCandidateVec,
MergeHitCandidateVec &  mergedHitsVec 
) const
overridevirtual

Implements reco_tool::ICandidateHitFinder.

Definition at line 140 of file CandHitStandard_tool.cc.

References DEFINE_ART_CLASS_TOOL.

143  {
144  // If no hits then nothing to do here
145  if (hitCandidateVec.empty()) return;
146 
147  // The idea is to group hits that "touch" so they can be part of common fit, those that
148  // don't "touch" are fit independently. So here we build the output vector to achieve that
149  HitCandidateVec groupedHitVec;
150  int lastTick = hitCandidateVec.front().stopTick;
151 
152  // Step through the input hit candidates and group them by proximity
153  for (const auto& hitCandidate : hitCandidateVec) {
154  // Check condition that we have a new grouping
155  if (int(hitCandidate.startTick) - lastTick > 1) {
156  mergedHitsVec.emplace_back(groupedHitVec);
157 
158  groupedHitVec.clear();
159  }
160 
161  // Add the current hit to the current group
162  groupedHitVec.emplace_back(hitCandidate);
163 
164  lastTick = hitCandidate.stopTick;
165  }
166 
167  // Check end condition
168  if (!groupedHitVec.empty()) mergedHitsVec.emplace_back(groupedHitVec);
169  }
reco_tool::ICandidateHitFinder::HitCandidateVec
std::vector< HitCandidate > HitCandidateVec
Definition: ICandidateHitFinder.h:37

Member Data Documentation

const float reco_tool::CandHitStandard::fRoiThreshold
private

minimum maximum to minimum peak distance

Definition at line 38 of file CandHitStandard_tool.cc.

Referenced by findHitCandidates().

const geo::WireReadoutGeom* reco_tool::CandHitStandard::fWireReadoutGeom
private
Initial value:
=
&art::ServiceHandle<geo::WireReadout const>()->Get()

Definition at line 40 of file CandHitStandard_tool.cc.

Referenced by findHitCandidates().

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