Rosetta: protocols::filters::CombinedFilter Class Reference

Rosetta

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

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::CombinedFilter:

Inheritance graph

[legend]

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

typedef utility::vector1< FilterWeightPair >	FilterList

Public Member Functions
	CombinedFilter ()

	~CombinedFilter () override

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

FilterOP	clone () const override

FilterOP	fresh_instance () const override

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

core::Real	report_sm (core::pose::Pose const &) const override
	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	set_threshold (core::Real const &val)
	Set the overall filter threshold. More...

void	add_filter (FilterOP filter, core::Real const &weight, bool const clone_filter=true)
	Add a filter/weight pair to the list of filters that this filter combines. More...

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

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::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

◆ FilterList

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

◆ FilterWeightPair

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

Constructor & Destructor Documentation

◆ CombinedFilter()

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

◆ ~CombinedFilter()

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

overridedefault

Member Function Documentation

◆ add_filter()

void protocols::filters::CombinedFilter::add_filter	(	FilterOP	filter,
		core::Real const &	weight,
		bool const	clone_filter = `true`
	)

inline

Add a filter/weight pair to the list of filters that this filter combines.

Author: Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References filterlist_.

Referenced by parse_my_tag().

◆ apply()

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

◆ class_name()

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

static

Referenced by protocols::filters::CombinedFilterCreator::keyname().

◆ clear_reset_filters()

void protocols::filters::CombinedFilter::clear_reset_filters ( )

References reset_filters_.

◆ clone()

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

overridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References filterlist_.

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

◆ fresh_instance()

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

overridevirtual

Implements protocols::filters::Filter.

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References protocols::filters::TrueFilter::class_name().

◆ parse_my_tag()

void protocols::filters::CombinedFilter::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_filter(), protocols::rosetta_scripts::parse_filter_or_null(), set_threshold(), and protocols::filters::TR().

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

◆ reset_filters()

void protocols::filters::CombinedFilter::reset_filters ( )

References filterlist_, and reset_filters_.

Referenced by set_reset_filters().

◆ set_reset_filters()

void protocols::filters::CombinedFilter::set_reset_filters ( utility::vector1< FilterOP > const & reset_filters )

References reset_filters(), and reset_filters_.

◆ set_threshold()

void protocols::filters::CombinedFilter::set_threshold ( core::Real const & val )

inline

Set the overall filter threshold.

Author: Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu)

References threshold_, and protocols::hybridization::val.

Referenced by parse_my_tag().

Member Data Documentation

◆ filterlist_

FilterList protocols::filters::CombinedFilter::filterlist_

private

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

◆ reset_filters_

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

private

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

◆ threshold_

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

private

Referenced by apply(), and set_threshold().

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

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