Evaluate to a value contingent on the evaluation of another filter. More...

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::IfThenFilter:

Public Member Functions
	IfThenFilter ()
	Evaluate to a value contingent on the evaluation of another filter. More...

virtual	~IfThenFilter ()

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

FilterOP	clone () const

FilterOP	fresh_instance () const

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

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

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

void	threshold (core::Real threshold)

void	set_lower_threshold (bool floor=false)
	Set if threshold is an upper (false/default) or lower (true) limit. More...

void	add_condition (FilterCOP testfilter, FilterCOP valuefilter, core::Real value=0, bool invert=false, core::Real weight=1)
	Add a condition to the test. If testfilter evaluates true, then this filter evaluates to valuefilter. If valuefilter is NULL, then return value instead. Conditions are evaluated in the order they were added. More...

void	set_else (FilterCOP elsefilter, core::Real value=0, core::Real elseweight=1)
	Add evaluation if no conditions trigger If elsefilter is Null, use absolute value value instead. More...

void	parse_my_tag (utility::tag::TagCOP, basic::datacache::DataMap &, Filters_map const &, moves::Movers_map const &, core::pose::Pose const &)

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

	Filter (std::string const &)

	Filter (Filter const &)

virtual	~Filter ()

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 std::string	name () const

Private Attributes
utility::vector1< FilterCOP >	iffilters_

utility::vector1< FilterCOP >	thenfilters_

utility::vector1< core::Real >	values_

utility::vector1< core::Real >	weights_

utility::vector1< bool >	invert_
	If true, invert the sense of the iffilter test. More...

FilterCOP	elsefilter_

core::Real	elsevalue_

core::Real	elseweight_

core::Real	threshold_

bool	floor_
	If true, threshold_ is a lower limit, rather than upper limit. More...

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

Detailed Description

Evaluate to a value contingent on the evaluation of another filter.

Constructor & Destructor Documentation

protocols::filters::IfThenFilter::IfThenFilter ( )

Evaluate to a value contingent on the evaluation of another filter.

Referenced by clone(), and fresh_instance().

protocols::filters::IfThenFilter::~IfThenFilter ( )

virtual

Member Function Documentation

void protocols::filters::IfThenFilter::add_condition	(	FilterCOP	testfilter,
		FilterCOP	valuefilter,
		core::Real	value = `0`,
		bool	invert = `false`,
		core::Real	weight = `1`
	)

Add a condition to the test. If testfilter evaluates true, then this filter evaluates to valuefilter. If valuefilter is NULL, then return value instead. Conditions are evaluated in the order they were added.

References iffilters_, invert_, thenfilters_, values_, and weights_.

Referenced by parse_my_tag().

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

virtual

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

Implements protocols::filters::Filter.

References compute(), floor_, threshold_, and protocols::filters::TR().

Referenced by compute().

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

virtual

Implements protocols::filters::Filter.

References IfThenFilter().

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

References apply(), elsefilter_, elsevalue_, elseweight_, iffilters_, invert_, thenfilters_, protocols::filters::TR(), values_, and weights_.

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

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

virtual

Implements protocols::filters::Filter.

References IfThenFilter().

void protocols::filters::IfThenFilter::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	,
		Filters_map const &	filters,
		moves::Movers_map const &	,
		core::pose::Pose const &
	)