Belle II Software  release-05-01-25
PXDResultFilterFactory.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/results/PXDResultFilterFactory.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/ChoosableFromVarSetFilter.icc.h>
16 #include <tracking/trackFindingCDC/filters/base/RecordingFilter.icc.h>
17 #include <tracking/trackFindingCDC/filters/base/MVAFilter.icc.h>
18 
19 #include <tracking/trackFindingCDC/varsets/VariadicUnionVarSet.h>
20 
21 #include <tracking/ckf/pxd/filters/results/PXDResultVarSet.h>
22 #include <tracking/ckf/pxd/filters/results/PXDResultTruthVarSet.h>
23 #include <tracking/ckf/pxd/filters/results/SizePXDResultFilter.h>
24 
25 
26 using namespace Belle2;
27 using namespace TrackFindingCDC;
28 
29 namespace {
31  using ChooseableTruthPXDResultFilter = ChoosableFromVarSetFilter<PXDResultTruthVarSet>;
32 
34  using RecordingPXDResultFilter = RecordingFilter<VariadicUnionVarSet<PXDResultTruthVarSet, PXDResultVarSet>>;
35 
37  using MVAPXDResultFilter = MVAFilter<PXDResultVarSet>;
38 }
39 
40 
41 PXDResultFilterFactory::PXDResultFilterFactory(const std::string& defaultFilterName)
42  : Super(defaultFilterName)
43 {
44 }
45 
47 
49 {
50  return "PXDResult";
51 }
52 
54 {
55  return "Reject pxd results";
56 }
57 
58 std::map<std::string, std::string> PXDResultFilterFactory::getValidFilterNamesAndDescriptions() const
59 {
60  return {
61  {"none", "no combination is valid"},
62  {"all", "all combination are valid"},
63  {"recording", "record variables to a TTree"},
64  {"mva", "filter based on the trained MVA method"},
65  {"size", "ordering accoring to size"},
66  {"truth", "monte carlo truth"},
67  {"truth_teacher", "monte carlo truth returning the result of the teacher"},
68  };
69 }
70 
71 std::unique_ptr<BasePXDResultFilter>
72 PXDResultFilterFactory::create(const std::string& filterName) const
73 {
74  if (filterName == "none") {
75  return std::make_unique<TrackFindingCDC::NoneFilter<BasePXDResultFilter>>();
76  } else if (filterName == "all") {
77  return std::make_unique<TrackFindingCDC::AllFilter<BasePXDResultFilter>>();
78  } else if (filterName == "recording") {
79  return std::make_unique<RecordingPXDResultFilter>();
80  } else if (filterName == "mva") {
81  return std::make_unique<MVAPXDResultFilter>("ckf_CDCToPXDResult");
82  } else if (filterName == "truth") {
83  return std::make_unique<ChooseableTruthPXDResultFilter>("truth");
84  } else if (filterName == "truth_teacher") {
85  return std::make_unique<ChooseableTruthPXDResultFilter>("truth_teacher");
86  } else if (filterName == "size") {
87  return std::make_unique<SizePXDResultFilter>();
88  } else {
89  return Super::create(filterName);
90  }
91 }
Belle2::TrackFindingCDC::FilterFactory< BasePXDResultFilter >
Belle2::PXDResultFilterFactory::PXDResultFilterFactory
PXDResultFilterFactory(const std::string &defaultFilterName="all")
Constructor forwarding the default filter name.
Definition: PXDResultFilterFactory.cc:41
Belle2::PXDResultFilterFactory::~PXDResultFilterFactory
~PXDResultFilterFactory()
Default destructor.
Belle2::TrackFindingCDC::FilterFactory< BasePXDResultFilter >::create
virtual std::unique_ptr< BasePXDResultFilter > 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::PXDResultFilterFactory::create
std::unique_ptr< BasePXDResultFilter > create(const std::string &filterName) const override
Create a filter with the given name.
Definition: PXDResultFilterFactory.cc:72
Belle2::PXDResultFilterFactory::getIdentifier
std::string getIdentifier() const override
Getter for a short identifier for the factory.
Definition: PXDResultFilterFactory.cc:48
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::PXDResultFilterFactory::getValidFilterNamesAndDescriptions
std::map< std::string, std::string > getValidFilterNamesAndDescriptions() const override
Getter for valid filter names and a description for each.
Definition: PXDResultFilterFactory.cc:58
Belle2::PXDResultFilterFactory::getFilterPurpose
std::string getFilterPurpose() const override
Getter for a descriptive purpose of the constructed filters.
Definition: PXDResultFilterFactory.cc:53