FilterFactory< AFilter > Class Template Reference

Factory that can create apropriate filter instances from a name. More...

#include <FilterFactory.dcl.h>

Collaboration diagram for FilterFactory< AFilter >:

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

Public Member Functions
	FilterFactory (const std::string &defaultFilterName="")
	Fill the default filter name values.
virtual	~FilterFactory ()
	Make destructor of interface class virtual.
virtual std::string	getIdentifier () const =0
	Getter for a short identifier of the factory. Currently unused.
virtual std::string	getFilterPurpose () const =0
	Getter for a descriptive purpose of the filter.
virtual std::map< std::string, std::string >	getValidFilterNamesAndDescriptions () const =0
	Getter for the valid filter names and a description for each.
virtual std::unique_ptr< AFilter >	create (const std::string &filterName) const
	Create a filter with the given name, does not set filter specific parameters. More...
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 Attributes
std::string	m_defaultFilterName
	Legacy - Default filter name suggested by this factory.

Detailed Description

template<class AFilter>
class Belle2::TrackFindingCDC::FilterFactory< AFilter >

Factory that can create apropriate filter instances from a name.

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

Member Function Documentation

create()

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

virtual

Create a filter with the given name, does not set filter specific parameters.

Always emits an error and returns nullptr

Reimplemented in TrackletFilterFactory, RelationFilterFactory, PathFilterFactory, WireHitFilterFactory, TrackQualityFilterFactory, TrackFilterFactory, StereoHitFilterFactory, SegmentTripleRelationFilterFactory, SegmentTripleFilterFactory, SegmentTrackFilterFactory, SegmentRelationFilterFactory, SegmentFilterFactory, FacetRelationFilterFactory, ClusterFilterFactory, AxialSegmentPairFilterFactory, SVDStateFilterFactory, SVDResultFilterFactory, SVDPairFilterFactory, PXDStateFilterFactory, PXDResultFilterFactory, PXDPairFilterFactory, CDCStateFilterFactory, CDCPathFilterFactory, CDCPathPairFilterFactory, TrackRelationFilterFactory, SegmentPairRelationFilterFactory, SegmentPairFilterFactory, and FacetFilterFactory.

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

    {
      // Check whether false positive or false negative filter are requested
      while (filterName == "false_positive" or filterName == "false_negative") {
        std::string truthFilterName = "truth";
        std::unique_ptr<AFilter> truthFilter = this->create(truthFilterName);
        std::unique_ptr<AFilter> defaultFilter = this->create(m_defaultFilterName);
 
        if (not truthFilter or not defaultFilter) break;
 
        if (filterName == "false_positive") {
          std::unique_ptr<AFilter> notTruthFilter =
            std::make_unique<NotFilter<AFilter>>(std::move(truthFilter));
          return std::make_unique<AndFilter<AFilter>>(std::move(notTruthFilter),
                                                      std::move(defaultFilter));
        }
 
        if (filterName == "false_negative") {
          std::unique_ptr<AFilter> notDefaultFilter =
            std::make_unique<NotFilter<AFilter>>(std::move(defaultFilter));
          return std::make_unique<AndFilter<AFilter>>(std::move(notDefaultFilter),
                                                      std::move(truthFilter));
        }
        break;
      }
 
      // Filter not valid
      B2ERROR("Could not create filter with name " << filterName);
      std::ostringstream message;
      message << "Known filter names are: ";
      std::vector<std::string> quotedFilterNames;
      for (const auto& filterNameAndDescription : getValidFilterNamesAndDescriptions()) {
        const std::string& validFilterName = filterNameAndDescription.first;
        quotedFilterNames.push_back(quoted(validFilterName));
      }
      message << join(", ", quotedFilterNames);
      message << ".";
      B2ERROR(message.str());
      return std::unique_ptr<AFilter>(nullptr);
    }

---

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

• tracking/trackFindingCDC/filters/base/include/FilterFactory.dcl.h
• tracking/trackFindingCDC/filters/base/include/FilterFactory.icc.h