Belle II Software development
StereoHitFilterFactory.cc
1/**************************************************************************
2 * basf2 (Belle II Analysis Software Framework) *
3 * Author: The Belle II Collaboration *
4 * *
5 * See git log for contributors and copyright holders. *
6 * This file is licensed under LGPL-3.0, see LICENSE.md. *
7 **************************************************************************/
8#include <tracking/trackFindingCDC/filters/stereoHits/StereoHitFilterFactory.h>
9
10#include <tracking/trackFindingCDC/filters/stereoHits/StereoHitTruthVarSet.h>
11#include <tracking/trackFindingCDC/filters/stereoHits/StereoHitVarSet.h>
12
13#include <tracking/trackingUtilities/filters/base/MVAFilter.icc.h>
14
15#include <tracking/trackingUtilities/filters/base/AllFilter.icc.h>
16#include <tracking/trackingUtilities/filters/base/NoneFilter.icc.h>
17#include <tracking/trackingUtilities/filters/base/RandomFilter.icc.h>
18#include <tracking/trackingUtilities/filters/base/ChoosableFromVarSetFilter.icc.h>
19#include <tracking/trackingUtilities/filters/base/TruthVarFilter.icc.h>
20#include <tracking/trackingUtilities/filters/base/RecordingFilter.icc.h>
21
22#include <tracking/trackingUtilities/filters/base/FilterFactory.icc.h>
23
24#include <tracking/trackingUtilities/varsets/VariadicUnionVarSet.h>
25
26using namespace Belle2;
27using namespace TrackFindingCDC;
28using namespace TrackingUtilities;
29
30namespace {
31 using AllStereoHitFilter = AllFilter<BaseStereoHitFilter>;
32 using NoneStereoHitFilter = NoneFilter<BaseStereoHitFilter>;
33 using RandomStereoHitFilter = RandomFilter<BaseStereoHitFilter>;
34 using MCStereoHitFilter = TruthVarFilter<StereoHitTruthVarSet>;
35 using SimpleStereoHitFilter = ChoosableFromVarSetFilter<StereoHitVarSet>;
36 using RecordingStereoHitFilter =
38 using MVAStereoHitFilter = MVAFilter<StereoHitVarSet>;
39}
40
42
43StereoHitFilterFactory::StereoHitFilterFactory(const std::string& defaultFilterName)
44 : Super(defaultFilterName)
45{
46}
47
49{
50 return "StereoHit";
51}
52
54{
55 return "Stereo hit to track combination filter for adding the hit.";
56}
57
58std::map<std::string, std::string>
60{
61 return {
62 {"none", "no hit track combination is valid."},
63 {"all", "set all hits as good."},
64 {"random", "returns a random weight (for testing)."},
65 {"truth", "monte carlo truth."},
66 {"simple", "give back a weight based on very simple variables you can give as a parameter."},
67 {"recording", "record variables to a TTree."},
68 {"mva", "use the trained BDT."},
69 };
70}
71
72std::unique_ptr<BaseStereoHitFilter>
73StereoHitFilterFactory::create(const std::string& filterName) const
74{
75 if (filterName == "none") {
76 return std::make_unique<NoneStereoHitFilter>();
77 // cppcheck-suppress knownConditionTrueFalse
78 } else if (filterName == "all") {
79 return std::make_unique<AllStereoHitFilter>();
80 // cppcheck-suppress knownConditionTrueFalse
81 } else if (filterName == "random") {
82 return std::make_unique<RandomStereoHitFilter>();
83 // cppcheck-suppress knownConditionTrueFalse
84 } else if (filterName == "simple") {
85 return std::make_unique<SimpleStereoHitFilter>();
86 // cppcheck-suppress knownConditionTrueFalse
87 } else if (filterName == "truth") {
88 return std::make_unique<MCStereoHitFilter>();
89 // cppcheck-suppress knownConditionTrueFalse
90 } else if (filterName == "recording") {
91 return std::make_unique<RecordingStereoHitFilter>("StereoHitFilter.root");
92 // cppcheck-suppress knownConditionTrueFalse
93 } else if (filterName == "mva") {
94 return std::make_unique<MVAStereoHitFilter>("trackfindingcdc_StereoHitFilter");
95 } else {
96 return Super::create(filterName);
97 }
98}
TrackingUtilities::FilterFactory< BaseStereoHitFilter > Super
Type of the base class.
StereoHitFilterFactory(const std::string &defaultFilterName="all")
Constructor forwarding the default filter name.
std::map< std::string, std::string > getValidFilterNamesAndDescriptions() const override
Getter for valid filter names and a description for each.
std::unique_ptr< BaseStereoHitFilter > create(const std::string &filterName) const override
Create a filter with the given name.
std::string getIdentifier() const override
Getter for a short identifier for the factory.
std::string getFilterPurpose() const override
Getter for a descriptive purpose of the constructed filters.
Filter adapter type that accepts all items (just for reference).
Convince template to create a filter returning on variable from a set of variables.
Factory that can create appropriate filter instances from a name.
virtual std::unique_ptr< BaseStereoHitFilter > create(const std::string &filterName) const
Convenience template to create a mva filter for a set of variables.
Filter adapter type that rejects all items.
Random filter resulting in a random weight between 0 and 1.
Convenience template to create a recording filter for a set of variables.
MC Filter Type using a VarSet and the truth variable in it.
Abstract base class for different kinds of events.