Rosetta: protocols::simple_filters::MPSpanAngleFilter Class Reference

Rosetta

#include <MPSpanAngleFilter.hh>

Inheritance diagram for protocols::simple_filters::MPSpanAngleFilter:

Inheritance graph

[legend]

Public Member Functions
	MPSpanAngleFilter ()

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

utility::vector1< core::Real >	compute (core::pose::Pose const &pose) const

filters::FilterOP	clone () const override

filters::FilterOP	fresh_instance () const override

	~MPSpanAngleFilter () override

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

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_ = -10.0

std::string	output_ = "TR"

core::Size	tm_num_ = 0

std::string	angle_or_score_ = "angle"

core::Real	ang_max_ = 90

core::Real	ang_min_ = 0

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

Constructor & Destructor Documentation

◆ MPSpanAngleFilter()

protocols::simple_filters::MPSpanAngleFilter::MPSpanAngleFilter ( )

inline

◆ ~MPSpanAngleFilter()

protocols::simple_filters::MPSpanAngleFilter::~MPSpanAngleFilter ( )

override

Member Function Documentation

◆ apply()

bool protocols::simple_filters::MPSpanAngleFilter::apply ( core::pose::Pose const & pose ) const

overridevirtual

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

Implements protocols::filters::Filter.

References ang_max_, ang_min_, angle_or_score_, compute(), threshold_, tm_num_, and protocols::simple_filters::TR().

◆ class_name()

std::string protocols::simple_filters::MPSpanAngleFilter::class_name ( )

static

Referenced by name(), and provide_xml_schema().

◆ clone()

filters::FilterOP protocols::simple_filters::MPSpanAngleFilter::clone ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ compute()

utility::vector1< core::Real > protocols::simple_filters::MPSpanAngleFilter::compute ( core::pose::Pose const & pose ) const

References core::energy_methods::MPSpanAngleEnergy::compute(), protocols::jd2::JobDistributor::current_output_name(), protocols::jd2::JobDistributor::get_instance(), core::conformation::membrane::out, output_, and protocols::simple_filters::TR().

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

◆ fresh_instance()

filters::FilterOP protocols::simple_filters::MPSpanAngleFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

std::string protocols::simple_filters::MPSpanAngleFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::simple_filters::MPSpanAngleFilter::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 ang_max_, ang_min_, angle_or_score_, output_, threshold_, tm_num_, and protocols::simple_filters::TR().

◆ provide_xml_schema()

void protocols::simple_filters::MPSpanAngleFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

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

Referenced by protocols::simple_filters::MPSpanAngleFilterCreator::provide_xml_schema().

◆ report()

void protocols::simple_filters::MPSpanAngleFilter::report	(	std::ostream &	out,
		core::pose::Pose const &	pose
	)		const

overridevirtual

Reimplemented from protocols::filters::Filter.

References ang_max_, ang_min_, angle_or_score_, compute(), core::conformation::membrane::out, threshold_, tm_num_, and protocols::simple_filters::TR().

◆ report_sm()

core::Real protocols::simple_filters::MPSpanAngleFilter::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 ang_max_, ang_min_, angle_or_score_, compute(), threshold_, tm_num_, and protocols::simple_filters::TR().

Member Data Documentation

◆ ang_max_

core::Real protocols::simple_filters::MPSpanAngleFilter::ang_max_ = 90

private

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

◆ ang_min_

core::Real protocols::simple_filters::MPSpanAngleFilter::ang_min_ = 0

private

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

◆ angle_or_score_

std::string protocols::simple_filters::MPSpanAngleFilter::angle_or_score_ = "angle"

private

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

◆ output_

std::string protocols::simple_filters::MPSpanAngleFilter::output_ = "TR"

private

Referenced by compute(), and parse_my_tag().

◆ threshold_

core::Real protocols::simple_filters::MPSpanAngleFilter::threshold_ = -10.0

private

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

◆ tm_num_

core::Size protocols::simple_filters::MPSpanAngleFilter::tm_num_ = 0

private

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

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

src/protocols/simple_filters/MPSpanAngleFilter.hh
src/protocols/simple_filters/MPSpanAngleFilter.cc