LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
CandHitStandard_tool.cc
Go to the documentation of this file.
1 
7 
11 
12 #include <algorithm>
13 
14 namespace reco_tool {
15 
17  public:
18  explicit CandHitStandard(const fhicl::ParameterSet& pset);
19 
20  void findHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t&,
21  const size_t,
22  const size_t,
23  const size_t,
24  HitCandidateVec&) const override;
25 
26  void MergeHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t&,
27  const HitCandidateVec&,
28  MergeHitCandidateVec&) const override;
29 
30  private:
33  const size_t,
34  const size_t,
35  HitCandidateVec&) const;
36 
37  // Member variables from the fhicl file
38  const float fRoiThreshold;
39 
40  const geo::GeometryCore* fGeometry = lar::providerFrom<geo::Geometry>();
41  };
42 
43  //----------------------------------------------------------------------
44  // Constructor.
46  : fRoiThreshold(pset.get<float>("RoiThreshold", 5.))
47  {}
48 
50  const recob::Wire::RegionsOfInterest_t::datarange_t& dataRange,
51  const size_t roiStartTick,
52  const size_t channel,
53  const size_t /* eventCount */,
54  HitCandidateVec& hitCandidateVec) const
55  {
56  // Recover the actual waveform
57  const Waveform& waveform = dataRange.data();
58 
59  // Recover the plane index for this method
60  std::vector<geo::WireID> wids = fGeometry->ChannelToWire(channel);
61  const size_t plane = wids[0].Plane;
62 
63  // Use the recursive version to find the candidate hits
64  findHitCandidates(waveform.begin(), waveform.end(), roiStartTick, plane, hitCandidateVec);
65 
66  return;
67  }
68 
71  const size_t roiStartTick,
72  const size_t planeIdx,
73  HitCandidateVec& hitCandidateVec) const
74  {
75  // Need a minimum number of ticks to do any work here
76  if (std::distance(startItr, stopItr) > 4) {
77  // Find the highest peak in the range given
78  auto maxItr = std::max_element(startItr, stopItr);
79 
80  float maxValue = *maxItr;
81  int maxTime = std::distance(startItr, maxItr);
82 
83  if (maxValue > fRoiThreshold) {
84  // backwards to find first bin for this candidate hit
85  auto firstItr = std::distance(startItr, maxItr) > 2 ? maxItr - 1 : startItr;
86 
87  while (firstItr != startItr) {
88  // Check for pathology where waveform goes too negative
89  if (*firstItr < -fRoiThreshold) break;
90 
91  // Check both sides of firstItr and look for min/inflection point
92  if (*firstItr < *(firstItr + 1) && *firstItr <= *(firstItr - 1)) break;
93 
94  firstItr--;
95  }
96 
97  int firstTime = std::distance(startItr, firstItr);
98 
99  // Recursive call to find all candidate hits earlier than this peak
100  findHitCandidates(startItr, firstItr + 1, roiStartTick, planeIdx, hitCandidateVec);
101 
102  // forwards to find last bin for this candidate hit
103  auto lastItr = std::distance(maxItr, stopItr) > 2 ? maxItr + 1 : stopItr - 1;
104 
105  while (lastItr != stopItr - 1) {
106  // Check for pathology where waveform goes too negative
107  if (*lastItr < -fRoiThreshold) break;
108 
109  // Check both sides of firstItr and look for min/inflection point
110  if (*lastItr <= *(lastItr + 1) && *lastItr < *(lastItr - 1)) break;
111 
112  lastItr++;
113  }
114 
115  int lastTime = std::distance(startItr, lastItr);
116 
117  // Now save this candidate's start and max time info
118  HitCandidate hitCandidate;
119  hitCandidate.startTick = roiStartTick + firstTime;
120  hitCandidate.stopTick = roiStartTick + lastTime;
121  hitCandidate.maxTick = roiStartTick + firstTime;
122  hitCandidate.minTick = roiStartTick + lastTime;
123  hitCandidate.maxDerivative = *(startItr + firstTime);
124  hitCandidate.minDerivative = *(startItr + lastTime);
125  hitCandidate.hitCenter = roiStartTick + maxTime;
126  hitCandidate.hitSigma = std::max(2., float(lastTime - firstTime) / 6.);
127  hitCandidate.hitHeight = maxValue;
128 
129  hitCandidateVec.push_back(hitCandidate);
130 
131  // Recursive call to find all candidate hits later than this peak
132  findHitCandidates(lastItr + 1,
133  stopItr,
134  roiStartTick + std::distance(startItr, lastItr + 1),
135  planeIdx,
136  hitCandidateVec);
137  }
138  }
139 
140  return;
141  }
142 
143  void CandHitStandard::MergeHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t&,
144  const HitCandidateVec& hitCandidateVec,
145  MergeHitCandidateVec& mergedHitsVec) const
146  {
147  // If no hits then nothing to do here
148  if (hitCandidateVec.empty()) return;
149 
150  // The idea is to group hits that "touch" so they can be part of common fit, those that
151  // don't "touch" are fit independently. So here we build the output vector to achieve that
152  HitCandidateVec groupedHitVec;
153  int lastTick = hitCandidateVec.front().stopTick;
154 
155  // Step through the input hit candidates and group them by proximity
156  for (const auto& hitCandidate : hitCandidateVec) {
157  // Check condition that we have a new grouping
158  if (int(hitCandidate.startTick) - lastTick > 1) {
159  mergedHitsVec.emplace_back(groupedHitVec);
160 
161  groupedHitVec.clear();
162  }
163 
164  // Add the current hit to the current group
165  groupedHitVec.emplace_back(hitCandidate);
166 
167  lastTick = hitCandidate.stopTick;
168  }
169 
170  // Check end condition
171  if (!groupedHitVec.empty()) mergedHitsVec.emplace_back(groupedHitVec);
172 
173  return;
174  }
175 
177 }
CandHitStandard(const fhicl::ParameterSet &pset)
#define DEFINE_ART_CLASS_TOOL(tool)
Definition: ToolMacros.h:42
Utilities related to art service access.
std::vector< WireID > ChannelToWire(raw::ChannelID_t const channel) const
Returns a list of wires connected to the specified TPC channel.
void findHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t &, const size_t, const size_t, const size_t, HitCandidateVec &) const override
intermediate_table::const_iterator const_iterator
const float fRoiThreshold
minimum maximum to minimum peak distance
void MergeHitCandidates(const recob::Wire::RegionsOfInterest_t::datarange_t &, const HitCandidateVec &, MergeHitCandidateVec &) const override
Description of geometry of one entire detector.
Definition: GeometryCore.h:119
decltype(auto) get(T &&obj)
ADL-aware version of std::to_string.
Definition: StdUtils.h:120
const geo::GeometryCore * fGeometry
This provides an interface for tools which are tasked with finding candidate hits on input waveforms...
std::vector< HitCandidateVec > MergeHitCandidateVec
art framework interface to geometry description
std::vector< HitCandidate > HitCandidateVec