Belle II Software development
ClusterFilterFactory Class Reference

Factory that can create appropriate cluster filters from associated names. More...

#include <ClusterFilterFactory.h>

Inheritance diagram for ClusterFilterFactory:
FilterFactory< BaseClusterFilter >

Public Types

using CreatedFilter = BaseClusterFilter
 Type of the filter that this factory creates.
 

Public Member Functions

 ClusterFilterFactory (const std::string &defaultFilterName="mva_bkg")
 Constructor forwarding the default filter name.
 
 ~ClusterFilterFactory ()
 Default destructor.
 
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.
 
std::map< std::string, std::string > getValidFilterNamesAndDescriptions () const override
 Getter for valid filter names and a description for each.
 
std::unique_ptr< BaseClusterFiltercreate (const std::string &filterName) const override
 Create a filter with the given name.
 
virtual std::string createFiltersNameDescription () const
 Create a string with a description mentioning the names of the chooseable filter.
 
virtual std::string createFiltersParametersDescription () const
 Create a string with a description mentioning the parameters of the chooseable filter.
 
const std::string & getDefaultFilterName () const
 Legacy - Return the default filter suggested by the factory.
 

Private Types

using Super = FilterFactory< BaseClusterFilter >
 Type of the base class.
 

Private Attributes

std::string m_defaultFilterName
 Legacy - Default filter name suggested by this factory.
 

Detailed Description

Factory that can create appropriate cluster filters from associated names.

Definition at line 24 of file ClusterFilterFactory.h.

Member Typedef Documentation

◆ CreatedFilter

using CreatedFilter = BaseClusterFilter
inherited

Type of the filter that this factory creates.

Definition at line 29 of file FilterFactory.dcl.h.

◆ Super

Type of the base class.

Definition at line 28 of file ClusterFilterFactory.h.

Constructor & Destructor Documentation

◆ ClusterFilterFactory()

ClusterFilterFactory ( const std::string &  defaultFilterName = "mva_bkg")
explicit

Constructor forwarding the default filter name.

Definition at line 23 of file ClusterFilterFactory.cc.

24 : Super(defaultFilterName)
25{
26}
FilterFactory< BaseClusterFilter > Super
Type of the base class.

Member Function Documentation

◆ create()

std::unique_ptr< Filter< CDCWireHitCluster > > create ( const std::string &  filterName) const
overridevirtual

Create a filter with the given name.

Reimplemented from FilterFactory< BaseClusterFilter >.

Definition at line 50 of file ClusterFilterFactory.cc.

51{
52 if (filterName == "all") {
53 return std::make_unique<AllClusterFilter>();
54 // cppcheck-suppress knownConditionTrueFalse
55 } else if (filterName == "unionrecording") {
56 return std::make_unique<UnionRecordingClusterFilter>();
57 // cppcheck-suppress knownConditionTrueFalse
58 } else if (filterName == "mva_bkg") {
59 return std::make_unique<MVABackgroundClusterFilter>();
60 } else {
61 return Super::create(filterName);
62 }
63}
virtual std::unique_ptr< BaseClusterFilter > create(const std::string &filterName) const
Create a filter with the given name, does not set filter specific parameters.

◆ createFiltersNameDescription()

std::string createFiltersNameDescription
virtualinherited

Create a string with a description mentioning the names of the chooseable filter.

Definition at line 56 of file FilterFactory.icc.h.

87 {
88 // Compose description for the filter names
89 std::ostringstream oss;
90 oss << this->getFilterPurpose();
91 oss << "Allowed values are: ";
92 std::vector<std::string> filterNameAndDescriptions;
93 for (const auto& filterNameAndDescription : this->getValidFilterNamesAndDescriptions()) {
94 const std::string& filterName = filterNameAndDescription.first;
95 const std::string& filterDescription = filterNameAndDescription.second;
96 filterNameAndDescriptions.push_back(quoted(filterName) + " " + bracketed(filterDescription));
97 }
98 oss << join(", ", filterNameAndDescriptions);
99 return oss.str();
100 }
virtual std::map< std::string, std::string > getValidFilterNamesAndDescriptions() const=0
Getter for the valid filter names and a description for each.
virtual std::string getFilterPurpose() const=0
Getter for a descriptive purpose of the filter.

◆ createFiltersParametersDescription()

std::string createFiltersParametersDescription
virtualinherited

Create a string with a description mentioning the parameters of the chooseable filter.

Definition at line 59 of file FilterFactory.icc.h.

104 {
105 // Compose description for the filter parameters
106 std::ostringstream oss;
107 oss << "Key -- value pairs depending on the filter." << std::endl;
108 for (const auto& filterNameAndDescription : this->getValidFilterNamesAndDescriptions()) {
109
110 const std::string& filterName = filterNameAndDescription.first;
111 // const std::string& filterDescription = filterNameAndDescription.second;
112
113 std::unique_ptr<AFilter> filter = this->create(filterName);
114 if (not filter) {
115 B2WARNING("Could not create a filter for name " << filterName);
116 continue;
117 }
118
119 ModuleParamList moduleParamList;
120 const std::string prefix = "";
121 filter->exposeParameters(&moduleParamList, prefix);
122
123 std::map<std::string, std::string> filterParameters;
124 for (auto && name : moduleParamList.getParameterNames()) {
125 filterParameters[name] = moduleParamList.getParameterDescription(name);
126 }
127
128 oss << quoted(filterName) << " :\n";
129 if (filterParameters.empty()) {
130 oss << "(no parameters)";
131 } else {
132 std::vector<std::string> parameterDescriptions;
133 for (const auto& parameterNameAndDescription : filterParameters) {
134 const std::string& parameterName = parameterNameAndDescription.first;
135 const std::string& parameterDescription = parameterNameAndDescription.second;
136 parameterDescriptions.push_back(parameterName + " -- " + parameterDescription);
137 }
138 oss << join(",\n", parameterDescriptions);
139 }
140 oss << ";\n";
141 }
142 return oss.str();
143 }

◆ getDefaultFilterName()

const std::string & getDefaultFilterName
inherited

Legacy - Return the default filter suggested by the factory.

Definition at line 63 of file FilterFactory.icc.h.

147 {
148 return m_defaultFilterName;
149 }
std::string m_defaultFilterName
Legacy - Default filter name suggested by this factory.

◆ getFilterPurpose()

std::string getFilterPurpose ( ) const
overridevirtual

Getter for a descriptive purpose of the constructed filters.

Implements FilterFactory< BaseClusterFilter >.

Definition at line 35 of file ClusterFilterFactory.cc.

36{
37 return "Cluster filter to reject background";
38}

◆ getIdentifier()

std::string getIdentifier ( ) const
overridevirtual

Getter for a short identifier for the factory.

Implements FilterFactory< BaseClusterFilter >.

Definition at line 30 of file ClusterFilterFactory.cc.

31{
32 return "Cluster";
33}

◆ getValidFilterNamesAndDescriptions()

std::map< std::string, std::string > getValidFilterNamesAndDescriptions ( ) const
overridevirtual

Getter for valid filter names and a description for each.

Implements FilterFactory< BaseClusterFilter >.

Definition at line 40 of file ClusterFilterFactory.cc.

41{
42 return {
43 {"all", "all cluster are valid"},
44 {"unionrecording", "record many multiple choosable variable set"},
45 {"mva_bkg", "test clusters for background with a mva method"},
46 };
47}

Member Data Documentation

◆ m_defaultFilterName

std::string m_defaultFilterName
privateinherited

Legacy - Default filter name suggested by this factory.

Definition at line 67 of file FilterFactory.dcl.h.


The documentation for this class was generated from the following files: