#include <SSamountFilter.hh>

Inheritance diagram for protocols::protein_interface_design::filters::SSamountFilter:

Public Member Functions
	SSamountFilter ()

	SSamountFilter (core::Real const upper_threshold, core::Real const lower_threshold, core::Size target_chain, bool b_target_chain, bool b_discard_lonely_SS)

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

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

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

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

	~SSamountFilter () override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data_map) 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	upper_threshold_

core::Real	lower_threshold_

core::Size	target_chain_

bool	b_target_chain_

bool	b_discard_lonely_SS_

core::pose::PoseOP	reference_pose_

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

Constructor & Destructor Documentation

◆ SSamountFilter() [1/2]

protocols::protein_interface_design::filters::SSamountFilter::SSamountFilter ( )

◆ SSamountFilter() [2/2]

protocols::protein_interface_design::filters::SSamountFilter::SSamountFilter	(	core::Real const	upper_threshold,
		core::Real const	lower_threshold,
		core::Size	target_chain,
		bool	b_target_chain,
		bool	b_discard_lonely_SS
	)

References b_discard_lonely_SS_, b_target_chain_, lower_threshold_, target_chain_, and upper_threshold_.

◆ ~SSamountFilter()

protocols::protein_interface_design::filters::SSamountFilter::~SSamountFilter ( )

overridedefault

Member Function Documentation

◆ apply()

bool protocols::protein_interface_design::filters::SSamountFilter::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(), lower_threshold_, protocols::protein_interface_design::filters::TR(), and upper_threshold_.

◆ class_name()

std::string protocols::protein_interface_design::filters::SSamountFilter::class_name ( )

static

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

◆ clone()

protocols::filters::FilterOP protocols::protein_interface_design::filters::SSamountFilter::clone ( ) const

overridevirtual

Implements protocols::filters::Filter.

◆ compute()

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

References b_discard_lonely_SS_, b_target_chain_, core::pose::Pose::conformation(), core::scoring::dssp::Dssp::get_dssp_secstruct(), core::conformation::Conformation::num_chains(), core::pose::Pose::size(), core::pose::Pose::split_by_chain(), target_chain_, and protocols::protein_interface_design::filters::TR().

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

◆ fresh_instance()

protocols::filters::FilterOP protocols::protein_interface_design::filters::SSamountFilter::fresh_instance ( ) const

inlineoverridevirtual

Implements protocols::filters::Filter.

◆ name()

std::string protocols::protein_interface_design::filters::SSamountFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ parse_my_tag()

void protocols::protein_interface_design::filters::SSamountFilter::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 b_discard_lonely_SS_, b_target_chain_, lower_threshold_, reference_pose_, protocols::rosetta_scripts::saved_reference_pose(), target_chain_, protocols::protein_interface_design::filters::TR(), and upper_threshold_.

◆ provide_xml_schema()

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

static

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

Referenced by protocols::protein_interface_design::filters::SSamountFilterCreator::provide_xml_schema().

◆ report()

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

Member Data Documentation

◆ b_discard_lonely_SS_

bool protocols::protein_interface_design::filters::SSamountFilter::b_discard_lonely_SS_

private

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

◆ b_target_chain_

bool protocols::protein_interface_design::filters::SSamountFilter::b_target_chain_

private

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

◆ lower_threshold_

core::Real protocols::protein_interface_design::filters::SSamountFilter::lower_threshold_

private

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

◆ reference_pose_

core::pose::PoseOP protocols::protein_interface_design::filters::SSamountFilter::reference_pose_

private

Referenced by parse_my_tag().

◆ target_chain_

core::Size protocols::protein_interface_design::filters::SSamountFilter::target_chain_

private

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

◆ upper_threshold_

core::Real protocols::protein_interface_design::filters::SSamountFilter::upper_threshold_

private

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

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

src/protocols/protein_interface_design/filters/SSamountFilter.hh
src/protocols/protein_interface_design/filters/SSamountFilter.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ SSamountFilter() [1/2]

◆ SSamountFilter() [2/2]

◆ ~SSamountFilter()

Member Function Documentation

◆ apply()

◆ class_name()

◆ clone()

◆ compute()

◆ fresh_instance()

◆ name()

◆ parse_my_tag()

◆ provide_xml_schema()

◆ report()

◆ report_sm()

Member Data Documentation

◆ b_discard_lonely_SS_

◆ b_target_chain_

◆ lower_threshold_

◆ reference_pose_

◆ target_chain_

◆ upper_threshold_