All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MuonFilter_module.cc
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////
2 //
3 // MuonFilter
4 //
5 // This event filter can act to identify events with only through-going tracks
6 //
7 // pagebri3@msu.edu
8 //
9 ////////////////////////////////////////////////////////////////////////
10 
11 // Framework Includes
12 #include "art/Framework/Core/EDFilter.h"
13 #include "art/Framework/Core/ModuleMacros.h"
14 #include "art/Framework/Principal/Event.h"
15 #include "art/Framework/Principal/Handle.h"
16 #include "art/Framework/Services/Registry/ServiceHandle.h"
17 #include "canvas/Persistency/Common/FindManyP.h"
18 #include "canvas/Persistency/Common/Ptr.h"
19 #include "canvas/Persistency/Common/PtrVector.h"
20 #include "fhiclcpp/ParameterSet.h"
21 #include "messagefacility/MessageLogger/MessageLogger.h"
22 
23 // Larsoft Includes
30 
31 // C++ includes
32 #include <map>
33 #include <memory>
34 #include <string>
35 
36 // ROOT includes
37 #include "TMathBase.h"
38 
39 namespace filter {
40 
41  class MuonFilter : public art::EDFilter {
42  public:
43  explicit MuonFilter(fhicl::ParameterSet const&);
44 
45  private:
46  bool filter(art::Event& evt) override;
47 
48  std::string const fClusterModuleLabel;
49  std::string const fLineModuleLabel;
50  std::vector<double> const fCuts;
51  double const fDCenter;
52  double const fDelay;
53  double const fTolerance;
54  double const fMaxIon;
55  double const fIonFactor;
56  int const fDeltaWire; ///< allowed differences in wire number between 2 planes
57 
58  }; // class MuonFilter
59 
60  //-------------------------------------------------
61  MuonFilter::MuonFilter(fhicl::ParameterSet const& pset)
62  : EDFilter{pset}
63  , fClusterModuleLabel{pset.get<std::string>("ClusterModuleLabel")}
64  , fLineModuleLabel{pset.get<std::string>("LineModuleLabel")}
65  , fCuts{pset.get<std::vector<double>>("Cuts")}
66  , fDCenter{pset.get<double>("DCenter")}
67  , fDelay{pset.get<double>("Delay")}
68  , fTolerance{pset.get<double>("Tolerance")}
69  , fMaxIon{pset.get<double>("MaxIon")}
70  , fIonFactor{pset.get<double>("IonFactor")}
71  , fDeltaWire{pset.get<int>("DeltaWire")}
72  {}
73 
74  //-------------------------------------------------
75  bool
76  MuonFilter::filter(art::Event& evt)
77  {
78  art::ServiceHandle<geo::Geometry const> geom;
79  auto const clockData =
80  art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
81  auto const detProp =
82  art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataFor(evt, clockData);
83 
84  // Drift Velocity in cm/us Sampling rate in ns
85  double drift = detProp.DriftVelocity(detProp.Efield(), detProp.Temperature()) *
86  sampling_rate(clockData) / 1000.0;
87 
88  // This code only works comparing 2 planes so for now these are the
89  // last induction plane and collection plane
90  int vPlane = geom->Nplanes() - 1;
91  geo::View_t vView = geom->Plane(vPlane).View();
92  int uPlane = vPlane - 1;
93  geo::View_t uView = geom->Plane(uPlane).View();
94  art::Handle<std::vector<recob::Cluster>> clustHandle;
95  evt.getByLabel(fClusterModuleLabel, clustHandle);
96 
97  art::FindManyP<recob::Hit> fmh(clustHandle, evt, fClusterModuleLabel);
98 
99  art::PtrVector<recob::Cluster> clusters;
100  clusters.reserve(clustHandle->size());
101  for (unsigned int i = 0; i < clustHandle->size(); ++i) {
102  clusters.push_back(art::Ptr<recob::Cluster>(clustHandle, i));
103  }
104  double indIon(0), colIon(0);
105  std::map<int, int> indMap;
106  std::map<int, int> colMap;
107  std::vector<std::pair<int, int>> rLook;
108  int matchNum = 1;
109  std::vector<std::vector<double>> tGoing;
110  std::vector<std::vector<double>> matched;
111  std::vector<double> pointTemp(6);
112  std::pair<int, int> pairTemp;
113  double ionSum(0.0);
114  for (size_t cluster = 0; cluster < clusters.size(); ++cluster) {
115  ionSum = 0.0;
116  std::vector<art::Ptr<recob::Hit>> hits = fmh.at(cluster);
117  for (unsigned int hit = 0; hit < hits.size(); hit++) {
118  ionSum += hits[hit]->PeakAmplitude();
119  }
120  if (clusters[cluster]->View() == uView)
121  indIon += ionSum;
122  else if (clusters[cluster]->View() == vView)
123  colIon += ionSum;
124  }
125  mf::LogInfo("MuonFilter") << "Ionizations: " << indIon << " " << colIon;
126  art::Handle<std::vector<recob::Cluster>> lines;
127  art::PtrVector<recob::Cluster> inductionSegments, collectionSegments;
128  evt.getByLabel(fLineModuleLabel, lines);
129  art::PtrVector<recob::Cluster> lineVec;
130  lineVec.reserve(lines->size());
131  for (unsigned int i = 0; i < lines->size(); ++i) {
132  lineVec.push_back(art::Ptr<recob::Cluster>(lines, i));
133  }
134 
135  for (size_t cl = 0; cl < clusters.size(); cl++) {
136  std::vector<art::Ptr<recob::Hit>> hits = fmh.at(cl);
137  if (hits.size() > 0 && clusters[cl]->View() == uView)
138  inductionSegments.push_back(clusters[cl]);
139  else if (hits.size() > 0 && clusters[cl]->View() == vView)
140  collectionSegments.push_back(clusters[cl]);
141  }
142 
143  art::FindManyP<recob::Hit> fmhi(inductionSegments, evt, fClusterModuleLabel);
144  art::FindManyP<recob::Hit> fmhc(collectionSegments, evt, fClusterModuleLabel);
145 
146  if (inductionSegments.size() == 0 || collectionSegments.size() == 0) {
147  mf::LogInfo("MuonFilter") << "At least one plane with no track";
148  }
149  else {
150 
151  for (unsigned int i = 0; i < inductionSegments.size(); i++) {
152  if (indMap[i]) continue;
153  for (unsigned int j = 0; j < collectionSegments.size(); j++) {
154  if (colMap[j]) continue;
155 
156  art::Ptr<recob::Cluster> indSeg = inductionSegments[i];
157  art::Ptr<recob::Cluster> colSeg = collectionSegments[j];
158 
159  std::vector<art::Ptr<recob::Hit>> indHits = fmhi.at(i);
160 
161  std::vector<art::Ptr<recob::Hit>> colHits = fmhc.at(j);
162 
163  double trk1Start = indSeg->StartTick() + fDelay;
164  double trk1End = indSeg->EndTick() + fDelay;
165  double trk2Start = colSeg->StartTick();
166  double trk2End = colSeg->EndTick();
167 
168  int uPos1 = indSeg->StartWire();
169  int uPos2 = indSeg->EndWire();
170  int const vPos1 = colSeg->StartWire();
171  int const vPos2 = colSeg->EndWire();
172  mf::LogInfo("MuonFilter") << "I J " << i << " " << j;
173  mf::LogInfo("MuonFilter")
174  << "Start/end " << indSeg->StartWire() << " " << colSeg->StartWire() << " "
175  << indSeg->EndWire() << " " << colSeg->EndWire();
176  mf::LogInfo("MuonFilter")
177  << "U's " << uPos1 << " " << uPos2 << "V's " << vPos1 << " " << vPos2 << " times "
178  << trk1End << " " << trk2End << " " << trk1Start << " " << trk2Start;
179  // need to have the corresponding endpoints matched
180  // check if they match in this order else switch
181  // really should use the crossing function and then have limits
182  // on distance outide tpc, or some other way of dealing with
183  // imperfect matches
184  if ((TMath::Abs(uPos1 - vPos1) > fDeltaWire || TMath::Abs(uPos2 - vPos2) > fDeltaWire) &&
185  (TMath::Abs(uPos1 - vPos2) <= fDeltaWire &&
186  TMath::Abs(uPos2 - vPos1) <= fDeltaWire)) {
187  mf::LogInfo("MuonFilter") << "Swapped1";
188  std::swap(uPos1, uPos2);
189  }
190  // check for time tolerance
191  if ((TMath::Abs(trk1Start - trk2Start) > fTolerance &&
192  TMath::Abs(trk1End - trk2End) > fTolerance) &&
193  (TMath::Abs(trk1Start - trk2End) < fTolerance &&
194  TMath::Abs(trk1End - trk2Start) < fTolerance)) {
195  std::swap(trk1Start, trk1End);
196  std::swap(uPos1, uPos2);
197  mf::LogInfo("MuonFilter") << "Swapped2";
198  }
199  mf::LogInfo("MuonFilter")
200  << "Times: " << trk1Start << " " << trk2Start << " " << trk1End << " " << trk2End;
201  // again needs to be fixed
202  ///\todo: the delta wire numbers seem a bit magic,
203  ///\todo: should also change to using Geometry::ChannelsIntersect
204  ///method
205  if ((TMath::Abs(trk1Start - trk2Start) < fTolerance &&
206  TMath::Abs(trk1End - trk2End) < fTolerance) &&
207  (TMath::Abs(uPos1 - vPos1) <= fDeltaWire + 2 &&
208  TMath::Abs(uPos2 - vPos2) <= fDeltaWire + 2)) {
209  geo::WireID u_wID1(indSeg->Plane(), uPos1);
210  geo::WireID u_wID2(indSeg->Plane(), uPos2);
211  geo::WireID v_wID1(colSeg->Plane(), vPos1);
212  geo::WireID v_wID2(colSeg->Plane(), vPos2);
213 
214  double y1, y2, z1, z2;
215  geom->IntersectionPoint(u_wID1, v_wID1, y1, z1);
216  geom->IntersectionPoint(u_wID2, v_wID2, y2, z2);
217 
218  double const x1 = (trk1Start + trk2Start) / 2.0 * drift - fDCenter;
219  double const x2 = (trk1End + trk2End) / 2.0 * drift - fDCenter;
220  mf::LogInfo("MuonFilter") << "Match " << matchNum << " " << x1 << " " << y1 << " " << z1
221  << " " << x2 << " " << y2 << " " << z2;
222  bool x1edge, x2edge, y1edge, y2edge, z1edge, z2edge;
223  indMap[i] = matchNum;
224  colMap[j] = matchNum;
225  matchNum++;
226  pointTemp[0] = x1;
227  pointTemp[1] = y1;
228  pointTemp[2] = z1;
229  pointTemp[3] = x2;
230  pointTemp[4] = y2;
231  pointTemp[5] = z2;
232  x1edge = (TMath::Abs(x1) - fCuts[0] > 0);
233  x2edge = (TMath::Abs(x2) - fCuts[0] > 0);
234  y1edge = (TMath::Abs(y1) - fCuts[1] > 0);
235  y2edge = (TMath::Abs(y2) - fCuts[1] > 0);
236  z1edge = (TMath::Abs(z1) - fCuts[2] > 0);
237  z2edge = (TMath::Abs(z2) - fCuts[2] > 0);
238  if ((x1edge || y1edge || z1edge) && (x2edge || y2edge || z2edge)) {
239  tGoing.push_back(pointTemp);
240  mf::LogInfo("MuonFilter") << "outside Removed induction ion: ";
241 
242  for (size_t h = 0; h < indHits.size(); h++) {
243  mf::LogInfo("MuonFilter") << indHits[h]->PeakAmplitude() << " ";
244  indIon -= indHits[h]->PeakAmplitude();
245  }
246  mf::LogInfo("MuonFilter") << "Removed collection ion: ";
247 
248  for (size_t h = 0; h < colHits.size(); h++) {
249  mf::LogInfo("MuonFilter") << colHits[h]->PeakAmplitude() << " ";
250  colIon -= colHits[h]->PeakAmplitude();
251  }
252  mf::LogInfo("MuonFilter")
253  << "Ionization outside track I/C: " << indIon << " " << colIon;
254  }
255  else if ((x1edge || y1edge || z1edge) && !(x2edge || y2edge || z2edge) &&
256  (z2 - z1) > 1.2) {
257  tGoing.push_back(pointTemp);
258  mf::LogInfo("MuonFilter") << "stopping Removed induction ion: ";
259  for (size_t h = 0; h < indHits.size(); h++) {
260  mf::LogInfo("MuonFilter") << indHits[h]->PeakAmplitude() << " ";
261  indIon -= indHits[h]->PeakAmplitude();
262  }
263  mf::LogInfo("MuonFilter") << "Removed collection ion: ";
264  for (size_t h = 0; h < colHits.size(); h++) {
265  mf::LogInfo("MuonFilter") << colHits[h]->PeakAmplitude() << " ";
266  colIon -= colHits[h]->PeakAmplitude();
267  }
268  mf::LogInfo("MuonFilter")
269  << "Ionization outside track I/C: " << indIon << " " << colIon;
270  }
271  else {
272  pairTemp = std::make_pair(i, j);
273  mf::LogInfo("MuonFilter") << "rLook matchnum " << matchNum << " " << i << " " << j;
274  rLook.push_back(pairTemp);
275  matched.push_back(pointTemp);
276  }
277  break; // advances i, makes j=0;
278  }
279  }
280  }
281  }
282  // after all matches are made, remove deltas
283  double distance = 0;
284  for (unsigned int i = 0; i < tGoing.size(); i++)
285  for (unsigned int j = 0; j < matched.size(); j++) {
286  mf::LogInfo("MuonFilter") << tGoing.size() << " " << matched.size() << " " << i << " " << j;
287  // test if one is contained within the other in the z-direction
288  if ((tGoing[i][2] <= matched[j][2]) && (tGoing[i][5] >= matched[j][5])) {
289  TVector3 a1(&tGoing[i][0]);
290  TVector3 a2(&tGoing[i][3]);
291  TVector3 b1(&matched[j][0]);
292  distance = TMath::Abs((((a1 - a2).Cross((a1 - a2).Cross(a1 - b1))).Unit()).Dot(a1 - b1));
293  mf::LogInfo("MuonFilter") << "distance " << distance;
294  if (distance < 6) {
295  mf::LogInfo("MuonFilter")
296  << "Removing delta ion " << rLook.size() << " " << rLook[j].first << " " << matchNum;
297  std::vector<art::Ptr<recob::Hit>> temp = fmhi.at(rLook[j].first);
298  for (unsigned int h = 0; h < temp.size(); h++)
299  indIon -= temp[h]->PeakAmplitude();
300  temp = fmhc.at(rLook[j].second);
301  for (unsigned int h = 0; h < temp.size(); h++)
302  colIon -= temp[h]->PeakAmplitude();
303  }
304  }
305  }
306  mf::LogInfo("MuonFilter") << "indIon " << indIon * fIonFactor << " colIon " << colIon;
307  if ((indIon * fIonFactor > fMaxIon) && (colIon > fMaxIon))
308  return true;
309  else
310  return false;
311  }
312 
313  DEFINE_ART_MODULE(MuonFilter)
314 
315 } // namespace filt
bool filter(art::Event &evt) override
process_name cluster
Definition: cheaterreco.fcl:51
enum geo::_plane_proj View_t
Enumerate the possible plane projections.
Declaration of signal hit object.
std::vector< double > const fCuts
process_name hit
Definition: cheaterreco.fcl:51
while getopts h
int const fDeltaWire
allowed differences in wire number between 2 planes
#define a2
std::string const fLineModuleLabel
double distance(geo::Point_t const &point, CathodeDesc_t const &cathode)
Returns the distance of a point from the cathode.
MuonFilter(fhicl::ParameterSet const &)
std::string const fClusterModuleLabel
Declaration of cluster object.
physics filters filter
Encapsulate the construction of a single detector plane.
TCEvent evt
Definition: DataStructs.cxx:8
double sampling_rate(DetectorClocksData const &data)
Returns the period of the TPC readout electronics clock.
art framework interface to geometry description
auto const detProp
#define a1