SVDStateFilterFactory Class Reference

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

#include <SVDStateFilterFactory.h>

Inheritance diagram for SVDStateFilterFactory:

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

Public Member Functions
	SVDStateFilterFactory (const std::string &defaultFilterName="all")
	Constructor forwarding the default filter name.
	~SVDStateFilterFactory ()
	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< BaseSVDStateFilter >	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 = TrackFindingCDC::FilterFactory< BaseSVDStateFilter >
	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 20 of file SVDStateFilterFactory.h.

Member Typedef Documentation

CreatedFilter

using CreatedFilter = BaseSVDStateFilter

inherited

Type of the filter that this factory creates.

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

Super

using Super = TrackFindingCDC::FilterFactory<BaseSVDStateFilter>

private

Type of the base class.

Definition at line 24 of file SVDStateFilterFactory.h.

Constructor & Destructor Documentation

SVDStateFilterFactory()

SVDStateFilterFactory ( const std::string &  defaultFilterName = "all" )

explicit

Constructor forwarding the default filter name.

Definition at line 68 of file SVDStateFilterFactory.cc.

  : Super(defaultFilterName)
{
}

Member Function Documentation

create()

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

overridevirtual

Create a filter with the given name.

Reimplemented from FilterFactory< BaseSVDStateFilter >.

Definition at line 109 of file SVDStateFilterFactory.cc.

{
  if (filterName == "none") {
    return std::make_unique<TrackFindingCDC::NoneFilter<BaseSVDStateFilter>>();
  } else if (filterName == "all") {
    return std::make_unique<AllSVDStateFilter>();
  } else if (filterName == "non_ip_crossing") {
    return std::make_unique<NonIPCrossingSVDStateFilter>();
  } else if (filterName == "advance") {
    return std::make_unique<AdvanceFilter<CKFToSVDState, SVDAdvancer>>();
  } else if (filterName == "fit") {
    return std::make_unique<KalmanFilter<CKFToSVDState, SVDKalmanStepper>>();
  } else if (filterName == "simple") {
    return std::make_unique<SimpleSVDStateFilter>();
  } else if (filterName == "residual") {
    return std::make_unique<ResidualSVDStateFilter>();
  } else if (filterName == "truth") {
    return std::make_unique<MCSVDStateFilter>();
  } else if (filterName == "ordering_truth") {
    return std::make_unique<MCOrderingSVDStateFilter>("truth_inverted");
  } else if (filterName == "sloppy_truth") {
    return std::make_unique<SloppyMCSVDStateFilter>();
  } else if (filterName == "recording") {
    return std::make_unique<RecordingSVDStateFilter>("SVDStateFilter.root");
    // This filter causes trouble with the parameters added to the SVDStateTruthVarSet, as both the RecordingSVDStateFilter
    // AND the MCSVDStateFilter internally use the SVDStateTruthVarSet, so the parameters are added twice for the same filter
    // causing an error. Currently this filter isn't actively used, but to keep it in the code in some way, even if it would
    // not work currently, it's commented.
    // } else if (filterName == "recording_and_truth") {
    //   return std::make_unique<AndSVDStateFilter>(
    //            std::make_unique<RecordingSVDStateFilter>("SVDStateFilter.root"),
    //            std::make_unique<MCSVDStateFilter>());
  } else if (filterName == "recording_with_direction_check") {
    return std::make_unique<AndSVDStateFilter>(
             std::make_unique<NonIPCrossingSVDStateFilter>(),
             std::make_unique<RecordingSVDStateFilter>("SVDStateFilter.root"));
  } else if (filterName == "mva") {
    return std::make_unique<MVASVDStateFilter>("ckf_CDCSVDStateFilter_1");
  } else if (filterName == "mva_with_direction_check") {
    return std::make_unique<AndSVDStateFilter>(
             std::make_unique<NonIPCrossingSVDStateFilter>(),
             std::make_unique<MVASVDStateFilter>("ckf_CDCSVDStateFilter_1"));
  } else if (filterName == "sloppy_recording") {
    return std::make_unique<SloppyRecordingSVDStateFilter>("SVDStateFilter.root");
  } 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< BaseSVDStateFilter >.

Definition at line 80 of file SVDStateFilterFactory.cc.

{
  return "Reject SVD CKF states. ";
}

getIdentifier()

std::string getIdentifier ( ) const

overridevirtual

Getter for a short identifier for the factory.

Implements FilterFactory< BaseSVDStateFilter >.

Definition at line 75 of file SVDStateFilterFactory.cc.

{
  return "SVDState";
}

getValidFilterNamesAndDescriptions()

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

overridevirtual

Getter for valid filter names and a description for each.

Implements FilterFactory< BaseSVDStateFilter >.

Definition at line 85 of file SVDStateFilterFactory.cc.

{
  return {
    {"none", "no track combination is valid"},
    {"all", "set all track combinations as good"},
    {"non_ip_crossing", "all combinations are fine, except for crossing IPs"},
    {"advance", "extrapolate the states"},
    {"fit", "update the mSoP using a Kalman Filter"},
    {"truth", "monte carlo truth"},
    {"ordering_truth", "monte carlo truth ordering"},
    {"sloppy_truth", "sloppy monte carlo truth"},
    {"simple", "simple filter to be used in svd"},
    {"residual", "residual filter to be used in svd"},
    {"recording", "record variables to a TTree"},
    // For details on why the "recording_and_truth" filter option is commented please see the comment below in ::create()
    // {"recording_and_truth", "record variables to a TTree and store truth information"},
    {"recording_with_direction_check", "record variables to a TTree with direction check"},
    {"mva", "MVA filter"},
    {"mva_with_direction_check", "MVA filter with direction check"},
    {"sloppy_recording", "record variables to a TTree"},
  };
}

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/ckf/svd/filters/states/include/SVDStateFilterFactory.h
• tracking/ckf/svd/filters/states/src/SVDStateFilterFactory.cc