ClusterFilterFactory Class Reference

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

#include <ClusterFilterFactory.h>

Inheritance diagram for ClusterFilterFactory:

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< BaseClusterFilter >	create (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

using Super = FilterFactory<BaseClusterFilter>

private

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.

  : Super(defaultFilterName)
{
}

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.

{
  if (filterName == "all") {
    return std::make_unique<AllClusterFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "unionrecording") {
    return std::make_unique<UnionRecordingClusterFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "mva_bkg") {
    return std::make_unique<MVABackgroundClusterFilter>();
  } else {
    return Super::create(filterName);
  }
}

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.

    {
      // Compose description for the filter names
      std::ostringstream oss;
      oss << this->getFilterPurpose();
      oss << "Allowed values are: ";
      std::vector<std::string> filterNameAndDescriptions;
      for (const auto& filterNameAndDescription : this->getValidFilterNamesAndDescriptions()) {
        const std::string& filterName = filterNameAndDescription.first;
        const std::string& filterDescription = filterNameAndDescription.second;
        filterNameAndDescriptions.push_back(quoted(filterName) + " " + bracketed(filterDescription));
      }
      oss << join(", ", filterNameAndDescriptions);
      return oss.str();
    }

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.

    {
      // Compose description for the filter parameters
      std::ostringstream oss;
      oss << "Key -- value pairs depending on the filter." << std::endl;
      for (const auto& filterNameAndDescription : this->getValidFilterNamesAndDescriptions()) {
 
        const std::string& filterName = filterNameAndDescription.first;
        // const std::string& filterDescription = filterNameAndDescription.second;
 
        std::unique_ptr<AFilter> filter = this->create(filterName);
        if (not filter) {
          B2WARNING("Could not create a filter for name " << filterName);
          continue;
        }
 
        ModuleParamList moduleParamList;
        const std::string prefix = "";
        filter->exposeParameters(&moduleParamList, prefix);
 
        std::map<std::string, std::string> filterParameters;
        for (auto && name : moduleParamList.getParameterNames()) {
          filterParameters[name] = moduleParamList.getParameterDescription(name);
        }
 
        oss << quoted(filterName) << " :\n";
        if (filterParameters.empty()) {
          oss << "(no parameters)";
        } else {
          std::vector<std::string> parameterDescriptions;
          for (const auto& parameterNameAndDescription : filterParameters) {
            const std::string& parameterName = parameterNameAndDescription.first;
            const std::string& parameterDescription = parameterNameAndDescription.second;
            parameterDescriptions.push_back(parameterName + " -- " + parameterDescription);
          }
          oss << join(",\n", parameterDescriptions);
        }
        oss << ";\n";
      }
      return oss.str();
    }

getDefaultFilterName()

const std::string & getDefaultFilterName

inherited

Legacy - Return the default filter suggested by the factory.

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

    {
      return m_defaultFilterName;
    }

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.

{
  return "Cluster filter to reject background";
}

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.

{
  return "Cluster";
}

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.

{
  return {
    {"all", "all cluster are valid"},
    {"unionrecording", "record many multiple choosable variable set"},
    {"mva_bkg", "test clusters for background with a mva method"},
  };
}

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:

• tracking/trackFindingCDC/filters/cluster/include/ClusterFilterFactory.h
• tracking/trackFindingCDC/filters/cluster/src/ClusterFilterFactory.cc