protocols::filters::CalculatorFilter Class Reference

#include <CalculatorFilter.hh>

Public Member Functions
	CalculatorFilter ()
	default ctor More...
	CalculatorFilter (std::string equation)
	CalculatorFilter (CalculatorFilter const &other)
virtual	~CalculatorFilter ()
virtual bool	apply (core::pose::Pose const &pose) const
	Returns true if the given pose passes the filter, false otherwise. More...
virtual void	report (std::ostream &out, core::pose::Pose const &pose) const
virtual core::Real	report_sm (core::pose::Pose const &pose) const
	used to report filter internals through a score or silent file More...
core::Real	compute (core::pose::Pose const &pose) const
virtual protocols::filters::FilterOP	clone () const
virtual protocols::filters::FilterOP	fresh_instance () const
void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &)
void	threshold (core::Real threshold)
void	add_filter (std::string name, protocols::filters::FilterOP filter)
void	add_constant (std::string name, core::Real value)
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 void	apply (core::io::serialization::PipeMap &pmap)
virtual void	score (core::io::serialization::PipeMap &pmap)
virtual core::Real	score (core::pose::Pose &pose)
virtual void	parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks)
virtual std::string	name () const

Private Attributes
numeric::CalculatorOP	calc_
std::map< std::string, core::Real >	values_
std::map< std::string, protocols::filters::FilterOP >	filters_
core::Real	threshold_

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

Constructor & Destructor Documentation

protocols::filters::CalculatorFilter::CalculatorFilter

(

)

default ctor

Referenced by clone(), and fresh_instance().

protocols::filters::CalculatorFilter::CalculatorFilter

(

std::string

equation

)

References calc_.

protocols::filters::CalculatorFilter::CalculatorFilter

(

CalculatorFilter const &

other

)

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

virtual

Member Function Documentation

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

References protocols::filters::Filter::name(), and values_.

Referenced by parse_my_tag().

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

References filters_, protocols::filters::Filter::name(), and utility_exit_with_message.

Referenced by parse_my_tag().

bool protocols::filters::CalculatorFilter::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(), and threshold_.

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

inlinevirtual

Implements protocols::filters::Filter.

References CalculatorFilter().

core::Real protocols::filters::CalculatorFilter::compute

(

core::pose::Pose const &

pose

)

const

References calc_, filters_, report_sm(), protocols::filters::TR, values_, and vars.

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

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

inlinevirtual

Implements protocols::filters::Filter.

References CalculatorFilter().

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

virtual

Reimplemented from protocols::filters::Filter.

References add_constant(), add_filter(), calc_, filters_, protocols::rosetta_scripts::parse_filter(), threshold_, numeric::random::uniform(), utility_exit_with_message, values_, and vars.

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

virtual

Reimplemented from protocols::filters::Filter.

References compute().

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

virtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

Referenced by compute().

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

inline

References threshold(), and threshold_.

Referenced by threshold().

Member Data Documentation

numeric::CalculatorOP protocols::filters::CalculatorFilter::calc_

private

Referenced by CalculatorFilter(), compute(), and parse_my_tag().

std::map<std::string, protocols::filters::FilterOP> protocols::filters::CalculatorFilter::filters_

private

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

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

private

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

std::map<std::string, core::Real> protocols::filters::CalculatorFilter::values_

private

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

---

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

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