Belle II Software  release-05-01-25
PXDStateFilterFactory.cc
1 /**************************************************************************
2  * BASF2 (Belle Analysis Framework 2) *
3  * Copyright(C) 2017 - Belle II Collaboration *
4  * *
5  * Author: The Belle II Collaboration *
6  * Contributors: Nils Braun *
7  * *
8  * This software is provided "as is" without any warranty. *
9  **************************************************************************/
10 #include <tracking/ckf/pxd/filters/states/PXDStateFilterFactory.h>
11 
12 #include <tracking/trackFindingCDC/filters/base/FilterFactory.icc.h>
13 #include <tracking/trackFindingCDC/filters/base/AllFilter.icc.h>
14 #include <tracking/trackFindingCDC/filters/base/NoneFilter.icc.h>
15 #include <tracking/trackFindingCDC/filters/base/AndFilter.icc.h>
16 #include <tracking/trackFindingCDC/filters/base/NegativeFilter.icc.h>
17 #include <tracking/trackFindingCDC/filters/base/ChoosableFromVarSetFilter.icc.h>
18 #include <tracking/trackFindingCDC/filters/base/RecordingFilter.icc.h>
19 #include <tracking/trackFindingCDC/filters/base/MVAFilter.icc.h>
20 #include <tracking/trackFindingCDC/filters/base/SloppyFilter.icc.h>
21 #include <tracking/trackFindingCDC/filters/base/TruthVarFilter.icc.h>
22 
23 #include <tracking/trackFindingCDC/varsets/VariadicUnionVarSet.h>
24 
25 #include <tracking/ckf/general/filters/AdvanceFilter.h>
26 #include <tracking/ckf/general/filters/KalmanFilter.h>
27 #include <tracking/ckf/pxd/utilities/PXDAdvancer.h>
28 #include <tracking/ckf/pxd/utilities/PXDKalmanStepper.h>
29 
30 #include <tracking/ckf/pxd/filters/states/PXDStateBasicVarSet.h>
31 #include <tracking/ckf/pxd/filters/states/PXDStateTruthVarSet.h>
32 #include <tracking/ckf/pxd/filters/states/SimplePXDStateFilter.h>
33 #include <tracking/ckf/pxd/filters/states/AllPXDStateFilter.h>
34 #include <tracking/ckf/pxd/filters/states/NonIPCrossingPXDStateFilter.h>
35 
36 using namespace Belle2;
37 using namespace TrackFindingCDC;
38 
39 namespace {
41  using MCPXDStateFilter = TruthVarFilter<PXDStateTruthVarSet>;
42 
44  using MCOrderingPXDStateFilter = ChoosableFromVarSetFilter<PXDStateTruthVarSet>;
45 
47  using SloppyMCPXDStateFilter = Sloppy<TruthVarFilter<PXDStateTruthVarSet>>;
48 
50  using RecordingPXDStateFilter = RecordingFilter<VariadicUnionVarSet<PXDStateTruthVarSet, PXDStateBasicVarSet>>;
51 
53  using MVAPXDStateFilter = NegativeFilter<MVAFilter<PXDStateBasicVarSet>>;
54 
56  using AndPXDStateFilter = AndFilter<BasePXDStateFilter>;
57 
59  class SloppyRecordingPXDStateFilter : public RecordingPXDStateFilter {
60  public:
61  explicit SloppyRecordingPXDStateFilter(const std::string& defaultRootFileName) : RecordingPXDStateFilter(defaultRootFileName)
62  {
63  setSkimFilter(std::make_unique<SloppyMCPXDStateFilter>());
64  }
65  };
66 }
67 
68 
69 PXDStateFilterFactory::PXDStateFilterFactory(const std::string& defaultFilterName)
70  : Super(defaultFilterName)
71 {
72 }
73 
75 
77 {
78  return "PXDState";
79 }
80 
82 {
83  return "Reject pxd states";
84 }
85 
86 std::map<std::string, std::string> PXDStateFilterFactory::getValidFilterNamesAndDescriptions() const
87 {
88  return {
89  {"none", "no track combination is valid"},
90  {"all", "set all track combinations as good"},
91  {"advance", "extrapolate the states"},
92  {"fit", "update the mSoP using a Kalman Filter"},
93  {"truth", "monte carlo truth"},
94  {"ordering_truth", "monte carlo truth ordering"},
95  {"sloppy_truth", "sloppy monte carlo truth"},
96  {"simple", "simple filter to be used in pxd"},
97  {"recording", "record variables to a TTree"},
98  {"mva_with_direction_check", "MVA filter with direction check"},
99  {"mva", "MVA filter"},
100  {"sloppy_recording", "record variables to a TTree"},
101  };
102 }
103 
104 std::unique_ptr<BasePXDStateFilter>
105 PXDStateFilterFactory::create(const std::string& filterName) const
106 {
107  if (filterName == "none") {
108  return std::make_unique<TrackFindingCDC::NoneFilter<BasePXDStateFilter>>();
109  } else if (filterName == "all") {
110  return std::make_unique<AllPXDStateFilter>();
111  } else if (filterName == "advance") {
112  return std::make_unique<AdvanceFilter<CKFToPXDState, PXDAdvancer>>();
113  } else if (filterName == "fit") {
114  return std::make_unique<KalmanFilter<CKFToPXDState, PXDKalmanStepper>>();
115  } else if (filterName == "simple") {
116  return std::make_unique<SimplePXDStateFilter>();
117  } else if (filterName == "truth") {
118  return std::make_unique<MCPXDStateFilter>();
119  } else if (filterName == "ordering_truth") {
120  return std::make_unique<MCOrderingPXDStateFilter>("truth_inverted");
121  } else if (filterName == "sloppy_truth") {
122  return std::make_unique<SloppyMCPXDStateFilter>();
123  } else if (filterName == "recording") {
124  return std::make_unique<RecordingPXDStateFilter>("PXDStateFilter.root");
125  } else if (filterName == "mva_with_direction_check") {
126  return std::make_unique<AndPXDStateFilter>(
127  std::make_unique<NonIPCrossingPXDStateFilter>(),
128  std::make_unique<MVAPXDStateFilter>("ckf_CDCPXDStateFilter_1")
129  );
130  } else if (filterName == "mva") {
131  return std::make_unique<AndPXDStateFilter>(
132  std::make_unique<MVAPXDStateFilter>("ckf_CDCPXDStateFilter_1"),
133  std::make_unique<NonIPCrossingPXDStateFilter>());
134  } else if (filterName == "sloppy_recording") {
135  return std::make_unique<SloppyRecordingPXDStateFilter>("PXDStateFilter.root");
136  } else {
137  return Super::create(filterName);
138  }
139 }
Belle2::TrackFindingCDC::FilterFactory< BasePXDStateFilter >
Belle2::PXDStateFilterFactory::getValidFilterNamesAndDescriptions
std::map< std::string, std::string > getValidFilterNamesAndDescriptions() const override
Getter for valid filter names and a description for each.
Definition: PXDStateFilterFactory.cc:86
Belle2::TrackFindingCDC::FilterFactory< BasePXDStateFilter >::create
virtual std::unique_ptr< BasePXDStateFilter > create(const std::string &filterName) const
Create a filter with the given name, does not set filter specific parameters.
Definition: FilterFactory.icc.h:54
Belle2::PXDStateFilterFactory::getIdentifier
std::string getIdentifier() const override
Getter for a short identifier for the factory.
Definition: PXDStateFilterFactory.cc:76
Belle2::PXDStateFilterFactory::PXDStateFilterFactory
PXDStateFilterFactory(const std::string &defaultFilterName="all")
Constructor forwarding the default filter name.
Definition: PXDStateFilterFactory.cc:69
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::PXDStateFilterFactory::getFilterPurpose
std::string getFilterPurpose() const override
Getter for a descriptive purpose of the constructed filters.
Definition: PXDStateFilterFactory.cc:81
Belle2::PXDStateFilterFactory::~PXDStateFilterFactory
~PXDStateFilterFactory()
Default destructor.
Belle2::PXDStateFilterFactory::create
std::unique_ptr< BasePXDStateFilter > create(const std::string &filterName) const override
Create a filter with the given name.
Definition: PXDStateFilterFactory.cc:105