Rosetta: protocols::filters::ReplicateFilter Class Reference

Rosetta

#include <ReplicateFilter.hh>

Inheritance diagram for protocols::filters::ReplicateFilter:

Inheritance graph

[legend]

Public Member Functions
	ReplicateFilter ()
	default ctor More...

	ReplicateFilter (protocols::filters::FilterOP subfilter, core::Size replicates=1, core::Size upper_trim=0, core::Size lower_trim=0)

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

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

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

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

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

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

	~ReplicateFilter () override=default

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

void	subfilter (protocols::filters::FilterOP subfilter)

void	median (bool median)

void	threshold (core::Real threshold)

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
protocols::filters::FilterOP	subfilter_

core::Size	replicates_

core::Size	upper_trim_

core::Size	lower_trim_

bool	median_

core::Real	threshold_

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

Constructor & Destructor Documentation

◆ ReplicateFilter() [1/2]

protocols::filters::ReplicateFilter::ReplicateFilter ( )

default ctor

◆ ReplicateFilter() [2/2]

protocols::filters::ReplicateFilter::ReplicateFilter	(	protocols::filters::FilterOP	subfilter,
		core::Size	replicates = `1`,
		core::Size	upper_trim = `0`,
		core::Size	lower_trim = `0`
	)

◆ ~ReplicateFilter()

protocols::filters::ReplicateFilter::~ReplicateFilter ( )

overridedefault

Member Function Documentation

◆ apply()

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

◆ class_name()

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

static

Referenced by protocols::filters::ReplicateFilterCreator::keyname(), name(), and provide_xml_schema().

◆ clone()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References lower_trim_, core::simple_metrics::metrics::mean, median_, replicates_, subfilter_, protocols::filters::TR(), and upper_trim_.

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

◆ fresh_instance()

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

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ median()

void protocols::filters::ReplicateFilter::median ( bool median )

inline

References median(), and median_.

Referenced by median().

◆ name()

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

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::filters::ReplicateFilter::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 lower_trim_, median_, protocols::rosetta_scripts::parse_filter(), replicates_, subfilter_, threshold_, and upper_trim_.

◆ provide_xml_schema()

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

static

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

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

◆ report()

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

◆ subfilter()

void protocols::filters::ReplicateFilter::subfilter ( protocols::filters::FilterOP subfilter )

inline

References subfilter(), and subfilter_.

Referenced by subfilter().

◆ threshold()

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

inline

References threshold(), and threshold_.

Referenced by threshold().

Member Data Documentation

◆ lower_trim_

core::Size protocols::filters::ReplicateFilter::lower_trim_

private

Referenced by compute(), and parse_my_tag().

◆ median_

bool protocols::filters::ReplicateFilter::median_

private

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

◆ replicates_

core::Size protocols::filters::ReplicateFilter::replicates_

private

Referenced by compute(), and parse_my_tag().

◆ subfilter_

protocols::filters::FilterOP protocols::filters::ReplicateFilter::subfilter_

private

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

◆ threshold_

core::Real protocols::filters::ReplicateFilter::threshold_

private

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

◆ upper_trim_

core::Size protocols::filters::ReplicateFilter::upper_trim_

private

Referenced by compute(), and parse_my_tag().

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

src/protocols/filters/ReplicateFilter.hh
src/protocols/filters/ReplicateFilter.cc