LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
MuonFilter_module.cc
Go to the documentation of this file.
1 //
3 // MuonFilter
4 //
5 // This event filter can act to identify events with only through-going tracks
6 //
7 // pagebri3@msu.edu
8 //
10 
11 // Framework Includes
20 #include "fhiclcpp/ParameterSet.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;
57 
58  }; // class MuonFilter
59 
60  //-------------------------------------------------
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  //-------------------------------------------------
76  {
78  auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
79  auto const detProp =
81 
82  // Drift Velocity in cm/us Sampling rate in ns
83  double drift = detProp.DriftVelocity(detProp.Efield(), detProp.Temperature()) *
84  sampling_rate(clockData) / 1000.0;
85 
86  // This code only works comparing 2 planes so for now these are the
87  // last induction plane and collection plane
88  geo::TPCID const tpcid{0, 0};
89  unsigned int vPlane = geom->Nplanes(tpcid) - 1;
90  geo::View_t vView = geom->Plane({tpcid, vPlane}).View();
91  unsigned int uPlane = vPlane - 1;
92  geo::View_t uView = geom->Plane({tpcid, uPlane}).View();
94  evt.getByLabel(fClusterModuleLabel, clustHandle);
95 
96  art::FindManyP<recob::Hit> fmh(clustHandle, evt, fClusterModuleLabel);
97 
99  clusters.reserve(clustHandle->size());
100  for (unsigned int i = 0; i < clustHandle->size(); ++i) {
101  clusters.push_back(art::Ptr<recob::Cluster>(clustHandle, i));
102  }
103  double indIon(0), colIon(0);
104  std::map<int, int> indMap;
105  std::map<int, int> colMap;
106  std::vector<std::pair<int, int>> rLook;
107  int matchNum = 1;
108  std::vector<std::vector<double>> tGoing;
109  std::vector<std::vector<double>> matched;
110  std::vector<double> pointTemp(6);
111  std::pair<int, int> pairTemp;
112  double ionSum(0.0);
113  for (size_t cluster = 0; cluster < clusters.size(); ++cluster) {
114  ionSum = 0.0;
115  std::vector<art::Ptr<recob::Hit>> hits = fmh.at(cluster);
116  for (unsigned int hit = 0; hit < hits.size(); hit++) {
117  ionSum += hits[hit]->PeakAmplitude();
118  }
119  if (clusters[cluster]->View() == uView)
120  indIon += ionSum;
121  else if (clusters[cluster]->View() == vView)
122  colIon += ionSum;
123  }
124  mf::LogInfo("MuonFilter") << "Ionizations: " << indIon << " " << colIon;
126  art::PtrVector<recob::Cluster> inductionSegments, collectionSegments;
127  evt.getByLabel(fLineModuleLabel, lines);
129  lineVec.reserve(lines->size());
130  for (unsigned int i = 0; i < lines->size(); ++i) {
131  lineVec.push_back(art::Ptr<recob::Cluster>(lines, i));
132  }
133 
134  for (size_t cl = 0; cl < clusters.size(); cl++) {
135  std::vector<art::Ptr<recob::Hit>> hits = fmh.at(cl);
136  if (hits.size() > 0 && clusters[cl]->View() == uView)
137  inductionSegments.push_back(clusters[cl]);
138  else if (hits.size() > 0 && clusters[cl]->View() == vView)
139  collectionSegments.push_back(clusters[cl]);
140  }
141 
142  art::FindManyP<recob::Hit> fmhi(inductionSegments, evt, fClusterModuleLabel);
143  art::FindManyP<recob::Hit> fmhc(collectionSegments, evt, fClusterModuleLabel);
144 
145  if (inductionSegments.size() == 0 || collectionSegments.size() == 0) {
146  mf::LogInfo("MuonFilter") << "At least one plane with no track";
147  }
148  else {
149 
150  for (unsigned int i = 0; i < inductionSegments.size(); i++) {
151  if (indMap[i]) continue;
152  for (unsigned int j = 0; j < collectionSegments.size(); j++) {
153  if (colMap[j]) continue;
154 
155  art::Ptr<recob::Cluster> indSeg = inductionSegments[i];
156  art::Ptr<recob::Cluster> colSeg = collectionSegments[j];
157 
158  std::vector<art::Ptr<recob::Hit>> indHits = fmhi.at(i);
159 
160  std::vector<art::Ptr<recob::Hit>> colHits = fmhc.at(j);
161 
162  double trk1Start = indSeg->StartTick() + fDelay;
163  double trk1End = indSeg->EndTick() + fDelay;
164  double trk2Start = colSeg->StartTick();
165  double trk2End = colSeg->EndTick();
166 
167  int uPos1 = indSeg->StartWire();
168  int uPos2 = indSeg->EndWire();
169  int const vPos1 = colSeg->StartWire();
170  int const vPos2 = colSeg->EndWire();
171  mf::LogInfo("MuonFilter") << "I J " << i << " " << j;
172  mf::LogInfo("MuonFilter")
173  << "Start/end " << indSeg->StartWire() << " " << colSeg->StartWire() << " "
174  << indSeg->EndWire() << " " << colSeg->EndWire();
175  mf::LogInfo("MuonFilter")
176  << "U's " << uPos1 << " " << uPos2 << "V's " << vPos1 << " " << vPos2 << " times "
177  << trk1End << " " << trk2End << " " << trk1Start << " " << trk2Start;
178  // need to have the corresponding endpoints matched
179  // check if they match in this order else switch
180  // really should use the crossing function and then have limits
181  // on distance outide tpc, or some other way of dealing with
182  // imperfect matches
183  if ((TMath::Abs(uPos1 - vPos1) > fDeltaWire || TMath::Abs(uPos2 - vPos2) > fDeltaWire) &&
184  (TMath::Abs(uPos1 - vPos2) <= fDeltaWire &&
185  TMath::Abs(uPos2 - vPos1) <= fDeltaWire)) {
186  mf::LogInfo("MuonFilter") << "Swapped1";
187  std::swap(uPos1, uPos2);
188  }
189  // check for time tolerance
190  if ((TMath::Abs(trk1Start - trk2Start) > fTolerance &&
191  TMath::Abs(trk1End - trk2End) > fTolerance) &&
192  (TMath::Abs(trk1Start - trk2End) < fTolerance &&
193  TMath::Abs(trk1End - trk2Start) < fTolerance)) {
194  std::swap(trk1Start, trk1End);
195  std::swap(uPos1, uPos2);
196  mf::LogInfo("MuonFilter") << "Swapped2";
197  }
198  mf::LogInfo("MuonFilter")
199  << "Times: " << trk1Start << " " << trk2Start << " " << trk1End << " " << trk2End;
200  // again needs to be fixed
204  if ((TMath::Abs(trk1Start - trk2Start) < fTolerance &&
205  TMath::Abs(trk1End - trk2End) < fTolerance) &&
206  (TMath::Abs(uPos1 - vPos1) <= fDeltaWire + 2 &&
207  TMath::Abs(uPos2 - vPos2) <= fDeltaWire + 2)) {
208  geo::WireID u_wID1(indSeg->Plane(), uPos1);
209  geo::WireID u_wID2(indSeg->Plane(), uPos2);
210  geo::WireID v_wID1(colSeg->Plane(), vPos1);
211  geo::WireID v_wID2(colSeg->Plane(), vPos2);
212 
213  double y1, y2, z1, z2;
214  geom->IntersectionPoint(u_wID1, v_wID1, y1, z1);
215  geom->IntersectionPoint(u_wID2, v_wID2, y2, z2);
216 
217  double const x1 = (trk1Start + trk2Start) / 2.0 * drift - fDCenter;
218  double const x2 = (trk1End + trk2End) / 2.0 * drift - fDCenter;
219  mf::LogInfo("MuonFilter") << "Match " << matchNum << " " << x1 << " " << y1 << " " << z1
220  << " " << x2 << " " << y2 << " " << z2;
221  bool x1edge, x2edge, y1edge, y2edge, z1edge, z2edge;
222  indMap[i] = matchNum;
223  colMap[j] = matchNum;
224  matchNum++;
225  pointTemp[0] = x1;
226  pointTemp[1] = y1;
227  pointTemp[2] = z1;
228  pointTemp[3] = x2;
229  pointTemp[4] = y2;
230  pointTemp[5] = z2;
231  x1edge = (TMath::Abs(x1) - fCuts[0] > 0);
232  x2edge = (TMath::Abs(x2) - fCuts[0] > 0);
233  y1edge = (TMath::Abs(y1) - fCuts[1] > 0);
234  y2edge = (TMath::Abs(y2) - fCuts[1] > 0);
235  z1edge = (TMath::Abs(z1) - fCuts[2] > 0);
236  z2edge = (TMath::Abs(z2) - fCuts[2] > 0);
237  if ((x1edge || y1edge || z1edge) && (x2edge || y2edge || z2edge)) {
238  tGoing.push_back(pointTemp);
239  mf::LogInfo("MuonFilter") << "outside Removed induction ion: ";
240 
241  for (size_t h = 0; h < indHits.size(); h++) {
242  mf::LogInfo("MuonFilter") << indHits[h]->PeakAmplitude() << " ";
243  indIon -= indHits[h]->PeakAmplitude();
244  }
245  mf::LogInfo("MuonFilter") << "Removed collection ion: ";
246 
247  for (size_t h = 0; h < colHits.size(); h++) {
248  mf::LogInfo("MuonFilter") << colHits[h]->PeakAmplitude() << " ";
249  colIon -= colHits[h]->PeakAmplitude();
250  }
251  mf::LogInfo("MuonFilter")
252  << "Ionization outside track I/C: " << indIon << " " << colIon;
253  }
254  else if ((x1edge || y1edge || z1edge) && !(x2edge || y2edge || z2edge) &&
255  (z2 - z1) > 1.2) {
256  tGoing.push_back(pointTemp);
257  mf::LogInfo("MuonFilter") << "stopping Removed induction ion: ";
258  for (size_t h = 0; h < indHits.size(); h++) {
259  mf::LogInfo("MuonFilter") << indHits[h]->PeakAmplitude() << " ";
260  indIon -= indHits[h]->PeakAmplitude();
261  }
262  mf::LogInfo("MuonFilter") << "Removed collection ion: ";
263  for (size_t h = 0; h < colHits.size(); h++) {
264  mf::LogInfo("MuonFilter") << colHits[h]->PeakAmplitude() << " ";
265  colIon -= colHits[h]->PeakAmplitude();
266  }
267  mf::LogInfo("MuonFilter")
268  << "Ionization outside track I/C: " << indIon << " " << colIon;
269  }
270  else {
271  pairTemp = std::make_pair(i, j);
272  mf::LogInfo("MuonFilter") << "rLook matchnum " << matchNum << " " << i << " " << j;
273  rLook.push_back(pairTemp);
274  matched.push_back(pointTemp);
275  }
276  break; // advances i, makes j=0;
277  }
278  }
279  }
280  }
281  // after all matches are made, remove deltas
282  double distance = 0;
283  for (unsigned int i = 0; i < tGoing.size(); i++)
284  for (unsigned int j = 0; j < matched.size(); j++) {
285  mf::LogInfo("MuonFilter") << tGoing.size() << " " << matched.size() << " " << i << " " << j;
286  // test if one is contained within the other in the z-direction
287  if ((tGoing[i][2] <= matched[j][2]) && (tGoing[i][5] >= matched[j][5])) {
288  TVector3 a1(&tGoing[i][0]);
289  TVector3 a2(&tGoing[i][3]);
290  TVector3 b1(&matched[j][0]);
291  distance = TMath::Abs((((a1 - a2).Cross((a1 - a2).Cross(a1 - b1))).Unit()).Dot(a1 - b1));
292  mf::LogInfo("MuonFilter") << "distance " << distance;
293  if (distance < 6) {
294  mf::LogInfo("MuonFilter")
295  << "Removing delta ion " << rLook.size() << " " << rLook[j].first << " " << matchNum;
296  std::vector<art::Ptr<recob::Hit>> temp = fmhi.at(rLook[j].first);
297  for (unsigned int h = 0; h < temp.size(); h++)
298  indIon -= temp[h]->PeakAmplitude();
299  temp = fmhc.at(rLook[j].second);
300  for (unsigned int h = 0; h < temp.size(); h++)
301  colIon -= temp[h]->PeakAmplitude();
302  }
303  }
304  }
305  mf::LogInfo("MuonFilter") << "indIon " << indIon * fIonFactor << " colIon " << colIon;
306  if ((indIon * fIonFactor > fMaxIon) && (colIon > fMaxIon))
307  return true;
308  else
309  return false;
310  }
311 
313 
314 } // namespace filt
void reserve(size_type n)
Definition: PtrVector.h:337
bool filter(art::Event &evt) override
Float_t y1[n_points_granero]
Definition: compare.C:5
enum geo::_plane_proj View_t
Enumerate the possible plane projections.
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
Float_t x1[n_points_granero]
Definition: compare.C:5
Declaration of signal hit object.
float StartWire() const
Returns the wire coordinate of the start of the cluster.
Definition: Cluster.h:276
std::vector< double > const fCuts
float EndTick() const
Returns the tick coordinate of the end of the cluster.
Definition: Cluster.h:331
geo::PlaneID Plane() const
Returns the plane ID this cluster lies on.
Definition: Cluster.h:717
Cluster finding and building.
Framework includes.
Float_t y2[n_points_geant4]
Definition: compare.C:26
int const fDeltaWire
allowed differences in wire number between 2 planes
#define a2
PlaneGeo const & Plane(PlaneID const &planeid) const
Returns the specified wire.
std::string const fLineModuleLabel
void hits()
Definition: readHits.C:15
#define DEFINE_ART_MODULE(klass)
Definition: ModuleMacros.h:65
MuonFilter(fhicl::ParameterSet const &)
void push_back(Ptr< U > const &p)
Definition: PtrVector.h:435
std::string const fClusterModuleLabel
The data type to uniquely identify a TPC.
Definition: geo_types.h:381
Declaration of cluster object.
size_type size() const
Definition: PtrVector.h:302
Detector simulation of raw signals on wires.
bool getByLabel(std::string const &label, std::string const &instance, Handle< PROD > &result) const
Encapsulate the construction of a single detector plane.
EDFilter(fhicl::ParameterSet const &pset)
Definition: EDFilter.cc:6
unsigned int Nplanes(TPCID const &tpcid=tpc_zero) const
Returns the total number of planes in the specified TPC.
Definition: GeometryCore.h:977
bool IntersectionPoint(WireID const &wid1, WireID const &wid2, double &y, double &z) const
Returns the intersection point of two wires.
TCEvent evt
Definition: DataStructs.cxx:8
Float_t x2[n_points_geant4]
Definition: compare.C:26
second_as<> second
Type of time stored in seconds, in double precision.
Definition: spacetime.h:82
double sampling_rate(DetectorClocksData const &data)
Returns the period of the TPC readout electronics clock.
float StartTick() const
Returns the tick coordinate of the start of the cluster.
Definition: Cluster.h:287
art framework interface to geometry description
#define a1
float EndWire() const
Returns the wire coordinate of the end of the cluster.
Definition: Cluster.h:318