Rosetta: protocols::filters::CalculatorFilter Class Reference

Rosetta

#include <CalculatorFilter.hh>

Inheritance diagram for protocols::filters::CalculatorFilter:

Inheritance graph

[legend]

Public Member Functions
	CalculatorFilter ()
	default ctor More...

	CalculatorFilter (std::string const &equation)

bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...

void	report (std::ostream &out, core::pose::Pose const &pose) const override

core::Real	report_sm (core::pose::Pose const &pose) const override
	used to report filter internals through a score or silent file More...

core::Real	compute (core::pose::Pose const &pose) const

protocols::filters::FilterOP	clone () const override

protocols::filters::FilterOP	fresh_instance () const override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing. More...

void	threshold (core::Real threshold)

void	add_filter (std::string const &name, protocols::filters::FilterOP filter)

void	add_reported_value (std::string const &name, std::string const &report_key)

void	add_constant (std::string const &name, core::Real value)

std::string	name () const override

Public Member Functions inherited from protocols::filters::Filter
	Filter ()

	Filter (std::string const &)

	~Filter () override

virtual std::string	get_type () const

std::string	get_user_defined_name () const

void	set_user_defined_name (std::string const &name)

virtual void	clear ()
	used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...

virtual core::Real	score (core::pose::Pose &pose)

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	class_name ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Private Attributes
core::simple_metrics::metrics::CalculatorMetricOP	metric_

core::Real	threshold_

Additional Inherited Members
Protected Attributes inherited from protocols::filters::Filter
std::string	scorename_

Constructor & Destructor Documentation

◆ CalculatorFilter() [1/2]

protocols::filters::CalculatorFilter::CalculatorFilter ( )

default ctor

◆ CalculatorFilter() [2/2]

protocols::filters::CalculatorFilter::CalculatorFilter ( std::string const & equation )

Member Function Documentation

◆ add_constant()

void protocols::filters::CalculatorFilter::add_constant	(	std::string const &	name,
		core::Real	value
	)

References metric_, and name().

Referenced by parse_my_tag().

◆ add_filter()

void protocols::filters::CalculatorFilter::add_filter	(	std::string const &	name,
		protocols::filters::FilterOP	filter
	)

References metric_, and name().

Referenced by parse_my_tag().

◆ add_reported_value()

void protocols::filters::CalculatorFilter::add_reported_value	(	std::string const &	name,
		std::string const &	report_key
	)

References metric_, and name().

Referenced by parse_my_tag().

◆ apply()

bool protocols::filters::CalculatorFilter::apply ( core::pose::Pose const & pose ) const

overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References compute(), and threshold_.

◆ class_name()

std::string protocols::filters::CalculatorFilter::class_name ( )

static

Referenced by protocols::filters::CalculatorFilterCreator::keyname(), name(), and provide_xml_schema().

◆ clone()

protocols::filters::FilterOP protocols::filters::CalculatorFilter::clone ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

core::Real protocols::filters::CalculatorFilter::compute ( core::pose::Pose const & pose ) const

References metric_.

Referenced by apply(), report(), and report_sm().

◆ fresh_instance()

protocols::filters::FilterOP protocols::filters::CalculatorFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

std::string protocols::filters::CalculatorFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

Referenced by add_constant(), add_filter(), add_reported_value(), and parse_my_tag().

◆ parse_my_tag()

void protocols::filters::CalculatorFilter::parse_my_tag	(	utility::tag::TagCOP	,
		basic::datacache::DataMap &
	)

overridevirtual

Called by FilterFactory when constructing new Filter. Takes care of the specific mover's parsing.

Reimplemented from protocols::filters::Filter.

References add_constant(), add_filter(), add_reported_value(), metric_, name(), protocols::rosetta_scripts::parse_filter(), and threshold_.

◆ provide_xml_schema()

void protocols::filters::CalculatorFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References class_name(), and protocols::filters::xsd_type_definition_w_attributes_and_repeatable_subelements().

Referenced by protocols::filters::CalculatorFilterCreator::provide_xml_schema().

◆ report()

void protocols::filters::CalculatorFilter::report	(	std::ostream &	out,
		core::pose::Pose const &	pose
	)		const

overridevirtual

Reimplemented from protocols::filters::Filter.

References compute(), and core::conformation::membrane::out.

◆ report_sm()

core::Real protocols::filters::CalculatorFilter::report_sm ( core::pose::Pose const & ) const

overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

◆ threshold()

void protocols::filters::CalculatorFilter::threshold ( core::Real threshold )

inline

References threshold(), and threshold_.

Referenced by threshold().

Member Data Documentation

◆ metric_

core::simple_metrics::metrics::CalculatorMetricOP protocols::filters::CalculatorFilter::metric_

private

Referenced by add_constant(), add_filter(), add_reported_value(), compute(), and parse_my_tag().

◆ threshold_

core::Real protocols::filters::CalculatorFilter::threshold_

private

Referenced by apply(), parse_my_tag(), and threshold().

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

src/protocols/filters/CalculatorFilter.hh
src/protocols/filters/CalculatorFilter.cc