SegmentPairRelationFilterFactory Class Reference

Factory that can create appropriate segment pair relation filters from associated names. More...

#include <SegmentPairRelationFilterFactory.h>

Inheritance diagram for SegmentPairRelationFilterFactory:

Public Types
using	CreatedFilter = BaseSegmentPairRelationFilter
	Type of the filter that this factory creates.

Public Member Functions
	SegmentPairRelationFilterFactory (const std::string &defaultFilterName="realistic")
	Constructor forwarding the default filter name.
std::string	getIdentifier () const final
	Getter for a short identifier for the factory.
std::string	getFilterPurpose () const final
	Getter for a descriptive purpose of the constructed filters.
std::map< std::string, std::string >	getValidFilterNamesAndDescriptions () const final
	Getter for valid filter names and a description for each.
std::unique_ptr< BaseSegmentPairRelationFilter >	create (const std::string &filterName) const final
	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< BaseSegmentPairRelationFilter >
	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 segment pair relation filters from associated names.

Definition at line 24 of file SegmentPairRelationFilterFactory.h.

Member Typedef Documentation

CreatedFilter

using CreatedFilter = BaseSegmentPairRelationFilter

inherited

Type of the filter that this factory creates.

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

Super

using Super = FilterFactory<BaseSegmentPairRelationFilter>

private

Type of the base class.

Definition at line 28 of file SegmentPairRelationFilterFactory.h.

Constructor & Destructor Documentation

SegmentPairRelationFilterFactory()

SegmentPairRelationFilterFactory ( const std::string &  defaultFilterName = "realistic" )

explicit

Constructor forwarding the default filter name.

Definition at line 27 of file SegmentPairRelationFilterFactory.cc.

  : Super(defaultFilterName)
{
}

Member Function Documentation

create()

std::unique_ptr< BaseSegmentPairRelationFilter > create ( const std::string &  filterName ) const

finalvirtual

Create a filter with the given name.

Reimplemented from FilterFactory< BaseSegmentPairRelationFilter >.

Definition at line 56 of file SegmentPairRelationFilterFactory.cc.

{
  if (filterName == "none") {
    return std::make_unique<NoneFilter<BaseSegmentPairRelationFilter>>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "all") {
    return std::make_unique<AllSegmentPairRelationFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "truth") {
    return std::make_unique<MCSegmentPairRelationFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "simple") {
    return std::make_unique<SimpleSegmentPairRelationFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "unionrecording") {
    return std::make_unique<UnionRecordingSegmentPairRelationFilter>();
    // cppcheck-suppress knownConditionTrueFalse
  } else if (filterName == "realistic") {
    return std::make_unique<MVARealisticSegmentPairRelationFilter>();
  } 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

finalvirtual

Getter for a descriptive purpose of the constructed filters.

Implements FilterFactory< BaseSegmentPairRelationFilter >.

Definition at line 37 of file SegmentPairRelationFilterFactory.cc.

{
  return "Segment pair relation filter to construct of a segment pair network";
}

getIdentifier()

std::string getIdentifier ( ) const

finalvirtual

Getter for a short identifier for the factory.

Implements FilterFactory< BaseSegmentPairRelationFilter >.

Definition at line 32 of file SegmentPairRelationFilterFactory.cc.

{
  return "SegmentPairRelation";
}

getValidFilterNamesAndDescriptions()

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

finalvirtual

Getter for valid filter names and a description for each.

Implements FilterFactory< BaseSegmentPairRelationFilter >.

Definition at line 43 of file SegmentPairRelationFilterFactory.cc.

{
  return {
    {"none", "no segment pair relation is valid, stop at segment pair creation"},
    {"all", "all segment pair relations are valid"},
    {"truth", "segment pair relations from monte carlo truth"},
    {"simple", "mc free with simple criteria"},
    {"unionrecording", "record multiple choosable variable set"},
    {"realistic", "mc free using 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/segmentPairRelation/include/SegmentPairRelationFilterFactory.h
• tracking/trackFindingCDC/filters/segmentPairRelation/src/SegmentPairRelationFilterFactory.cc