protocols::filters::CombinedFilter Class Reference

Used to combine multiple seperate filters into a single filter value. More...

#include <BasicFilters.hh>

Public Types
typedef std::pair< FilterOP, core::Real >	FilterWeightPair
typedef utility::vector1 < FilterWeightPair >	FilterList

Public Member Functions
	CombinedFilter ()
virtual	~CombinedFilter ()
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	set_reset_filters (utility::vector1< FilterOP > const reset_filters)
void	reset_filters ()
void	clear_reset_filters ()
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 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
core::Real	threshold_
FilterList	filterlist_
utility::vector1< FilterOP >	reset_filters_

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

Detailed Description

Used to combine multiple seperate filters into a single filter value.

Member Typedef Documentation

typedef utility::vector1< FilterWeightPair > protocols::filters::CombinedFilter::FilterList

typedef std::pair< FilterOP, core::Real > protocols::filters::CombinedFilter::FilterWeightPair

Constructor & Destructor Documentation

protocols::filters::CombinedFilter::CombinedFilter

(

)

Referenced by clone(), and fresh_instance().

protocols::filters::CombinedFilter::~CombinedFilter ( )

virtual

Member Function Documentation

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

void protocols::filters::CombinedFilter::clear_reset_filters

(

)

References reset_filters_.

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

virtual

Implements protocols::filters::Filter.

References CombinedFilter().

core::Real protocols::filters::CombinedFilter::compute

(

core::pose::Pose const &

pose

)

const

References filterlist_.

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

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

virtual

Implements protocols::filters::Filter.

References CombinedFilter().

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

virtual

Reimplemented from protocols::filters::Filter.

References protocols::filters::Filter::clone(), filter, filterlist_, threshold_, protocols::filters::TR, and weight.

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

virtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::filters::CombinedFilter::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().

void protocols::filters::CombinedFilter::reset_filters

(

)

References protocols::filters::Filter::clone(), filter, filterlist_, protocols::filters::Filter::get_user_defined_name(), and reset_filters_.

Referenced by set_reset_filters().

void protocols::filters::CombinedFilter::set_reset_filters

(

utility::vector1< FilterOP > const

reset_filters

)

References reset_filters(), and reset_filters_.

Member Data Documentation

FilterList protocols::filters::CombinedFilter::filterlist_

private

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

utility::vector1<FilterOP> protocols::filters::CombinedFilter::reset_filters_

private

Referenced by clear_reset_filters(), reset_filters(), and set_reset_filters().

core::Real protocols::filters::CombinedFilter::threshold_

private

Referenced by apply(), and parse_my_tag().

---

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

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