Convert the result of a Filter's report_sm() to a SimpleMetric This is intended primarily as a compatibility shim class for making old code compatible. It's not really intended to be used for new work - write a SimpleMetric directly. More...
#include <FilterValueMetric.hh>
Public Member Functions | |
| FilterValueMetric () | |
| Constructors ///. More... | |
| FilterValueMetric (FilterOP filter) | |
| Construct based on a given filter. More... | |
| core::Real | calculate (core::pose::Pose const &pose) const override |
| Metric Methods ///. More... | |
| std::string | name () const override |
| Name of the class. More... | |
| std::string | metric () const override |
| Name of the metric. More... | |
| void | parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override |
| called by parse_my_tag – should not be used directly More... | |
| core::simple_metrics::SimpleMetricOP | clone () const override |
 Public Member Functions inherited from core::simple_metrics::RealMetric | |
| RealMetric () | |
| ~RealMetric () override | |
| RealMetric (RealMetric const &other) | |
| RealMetric & | operator= (RealMetric const &) |
| void | apply (std::string const &out_label, pose::Pose &pose, bool override_existing_data=false) const override |
| Calculate the metric and add it to the pose as a score. labeled as out_label. More... | |
| core::Real | cached_calculate (pose::Pose const &pose, bool use_cache, std::string prefix="", std::string suffix="", bool fail_on_missing_cache=true) const |
| Grab the data from the pose if it exists or calculate the metric. More... | |
| utility::vector1< std::string > | get_metric_names () const override |
| Get the metric name(s) that this Metric will calculate. More... | |
| virtual void | apply (std::string const &out_label, pose::Pose &pose, bool override_existing_data=false) const=0 |
Calculate the metric and add it to the Score, which is output into a scorefile - labeled as label Must be implemented by derived classes. More... | |
| void | apply (pose::Pose &pose, std::string const &prefix="", std::string const &suffix="", bool override_existing_data=false) const |
| Calculate the metric and add it to the Score, which is output into a scorefile - labeled as prefix+metric+suffix. More... | |
| Public Member Functions inherited from core::simple_metrics::SimpleMetric | |
| SimpleMetric (std::string const &simple_metric_type) | |
| ~SimpleMetric () override | |
| SimpleMetric (SimpleMetric const &other) | |
| SimpleMetric & | operator= (SimpleMetric const &) |
| void | apply (pose::Pose &pose, std::string const &prefix="", std::string const &suffix="", bool override_existing_data=false) const |
| Calculate the metric and add it to the Score, which is output into a scorefile - labeled as prefix+metric+suffix. More... | |
| void | set_custom_type (std::string const &custom_type) |
| std::string | get_custom_type () const |
| Additional setting to prefix/suffix. More... | |
| virtual void | parse_base_tag (utility::tag::TagCOP tag) |
| Parse the base class tag. Keep required interface for parse_my_tag. More... | |
| std::string | simple_metric_type () const |
| std::string | get_final_sm_type () const |
| Get the final name of this metric including its simple_metric_type_ name and any set custom type. More... | |
| virtual void | provide_citation_info (basic::citation_manager::CitationCollectionList &) const |
| Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More... | |
Static Public Member Functions | |
| static std::string | name_static () |
| Name of the class for creator. More... | |
| static void | provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd) |
| Static Public Member Functions inherited from core::simple_metrics::SimpleMetric | |
| static utility::tag::XMLSchemaComplexTypeGeneratorOP | complex_type_generator_for_simple_metric (utility::tag::XMLSchemaDefinition &) |
Private Attributes | |
| protocols::filters::FilterOP | filter_ |
Detailed Description
Convert the result of a Filter's report_sm() to a SimpleMetric This is intended primarily as a compatibility shim class for making old code compatible. It's not really intended to be used for new work - write a SimpleMetric directly.
Constructor & Destructor Documentation
◆ FilterValueMetric() [1/2]
| protocols::filters::FilterValueMetric::FilterValueMetric | ( | ) |
Constructors ///.
Default constructor
◆ FilterValueMetric() [2/2]
| protocols::filters::FilterValueMetric::FilterValueMetric | ( | FilterOP | filter | ) |
Construct based on a given filter.
Member Function Documentation
◆ calculate()
|
overridevirtual |
Metric Methods ///.
Defined in RealMetric:
Calculate the metric and add it to the pose as a score. labeled as prefix+metric+suffix.
Score is added through setExtraScorePose and is output into the score tables/file at pose output.
Calculate the metric.
Implements core::simple_metrics::RealMetric.
References filter_.
◆ clone()
|
overridevirtual |
Implements core::simple_metrics::RealMetric.
◆ metric()
|
overridevirtual |
Name of the metric.
Implements core::simple_metrics::RealMetric.
◆ name()
|
overridevirtual |
◆ name_static()
|
static |
Name of the class for creator.
Referenced by protocols::filters::FilterValueMetricCreator::keyname(), name(), and provide_xml_schema().
◆ parse_my_tag()
|
overridevirtual |
called by parse_my_tag – should not be used directly
Implements core::simple_metrics::RealMetric.
References filter_, and protocols::rosetta_scripts::parse_filter().
◆ provide_xml_schema()
|
static |
Member Data Documentation
◆ filter_
|
private |
Referenced by calculate(), and parse_my_tag().
The documentation for this class was generated from the following files:
- src/protocols/filters/FilterValueMetric.hh
- src/protocols/filters/FilterValueMetric.cc
