protocols::filters::StochasticFilter Class Reference

#include <BasicFilters.hh>

Inheritance diagram for protocols::filters::StochasticFilter:

Public Member Functions
	StochasticFilter ()
	~StochasticFilter () override
	StochasticFilter (core::Real const confidence, FilterOP subfilter=nullptr, bool run_subfilter_on=true)
FilterOP	clone () const override
FilterOP	fresh_instance () const override
bool	calculate () const
bool	apply (core::pose::Pose const &pose) const override
	Returns true if the given pose passes the filter, false otherwise. More...
core::Real	report_sm (core::pose::Pose const &) const override
	If subfilter is set, use it's report_sm, otherwise use the base class's. More...
void	report (std::ostream &, core::pose::Pose const &) const override
	If subfilter is set, use it's report, otherwise use the base class's. More...
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...
core::Real	confidence () const
	The confidence is the fraction of the time the Filter will return true More...
FilterCOP	subfilter () const
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	confidence_ = 1.0
FilterOP	subfilter_ = nullptr
bool	run_subfilter_on_ = true

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

Constructor & Destructor Documentation

StochasticFilter() [1/2]

protocols::filters::StochasticFilter::StochasticFilter

(

)

~StochasticFilter()

protocols::filters::StochasticFilter::~StochasticFilter ( )

overridedefault

StochasticFilter() [2/2]

protocols::filters::StochasticFilter::StochasticFilter	(	core::Real const	confidence,
		FilterOP	subfilter = nullptr,
		bool	run_subfilter_on = true
	)

The confidence is the fraction of the time the Filter will return true If subfilter is not null, it will be called when the core calculation matched run_subfilter_on

Member Function Documentation

apply()

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

overridevirtual

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

Implements protocols::filters::Filter.

References calculate(), run_subfilter_on_, and subfilter_.

calculate()

bool protocols::filters::StochasticFilter::calculate

(

)

const

References confidence_, and core::scoring::rg.

Referenced by apply().

class_name()

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

static

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

clone()

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

overridevirtual

Implements protocols::filters::Filter.

confidence()

core::Real protocols::filters::StochasticFilter::confidence ( ) const

inline

The confidence is the fraction of the time the Filter will return true

References confidence_.

fresh_instance()

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

overridevirtual

Implements protocols::filters::Filter.

name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

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

parse_my_tag()

void protocols::filters::StochasticFilter::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 confidence_, and protocols::filters::TR().

provide_xml_schema()

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

static

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

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

report()

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

overridevirtual

If subfilter is set, use it's report, otherwise use the base class's.

Reimplemented from protocols::filters::Filter.

References subfilter_.

report_sm()

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

overridevirtual

If subfilter is set, use it's report_sm, otherwise use the base class's.

Reimplemented from protocols::filters::Filter.

References protocols::filters::Filter::report_sm(), and subfilter_.

subfilter()

FilterCOP protocols::filters::StochasticFilter::subfilter ( ) const

inline

References subfilter_.

Member Data Documentation

confidence_

core::Real protocols::filters::StochasticFilter::confidence_ = 1.0

private

Referenced by calculate(), confidence(), and parse_my_tag().

run_subfilter_on_

bool protocols::filters::StochasticFilter::run_subfilter_on_ = true

private

Referenced by apply().

subfilter_

FilterOP protocols::filters::StochasticFilter::subfilter_ = nullptr

private

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

---

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

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