Another filter used in Marcos & Basanta et al. 2017 that needs to be updated. More...

#include <StrandHelixGeometryFilter.hh>

Inheritance diagram for protocols::fldsgn::filters::StrandHelixGeometryFilter:

Public Member Functions
	StrandHelixGeometryFilter ()

	~StrandHelixGeometryFilter () override

void	secstruct (std::string const &ss)
	miniimum angle for filtering More...

void	filter_min_orthoangle (core::Real const r)
	miniimum angle for filtering More...

void	filter_max_orthoangle (core::Real const r)
	maximum angle for filtering More...

void	filter_min_planeangle (core::Real const r)
	miniimum angle for filtering More...

void	filter_max_planeangle (core::Real const r)
	maximum angle for filtering More...

void	filter_min_dist (core::Real const r)
	miniimum angle for filtering More...

void	filter_max_dist (core::Real const r)
	maximum angle for filtering More...

void	strand_id1 (core::Size const r)
	miniimum angle for filtering More...

void	strand_id2 (core::Size const r)
	miniimum angle for filtering More...

void	helix_id (core::Size const r)
	maximum angle for filtering More...

void	output_type (std::string const &s)
	set output type More...

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

core::Real	report_sm (core::pose::Pose const &pose) const override
	required for reporting score values More...

void	report (std::ostream &os, core::pose::Pose const &pose) const override
	allows printing data to a stream More...

std::string	name () const override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &data) override
	parse XML tag (to use this Filter in Rosetta Scripts) More...

protocols::filters::FilterOP	fresh_instance () const override
	required in the context of the parser/scripting scheme More...

protocols::filters::FilterOP	clone () const override
	required in the context of the parser/scripting scheme More...

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
std::string	secstruct_

core::Real	filter_min_orthoangle_
	filtered min angle between helix and sheet More...

core::Real	filter_max_orthoangle_
	filtered max angle between helix and sheet More...

core::Real	filter_min_planeangle_
	filtered min angle between helix and sheet More...

core::Real	filter_max_planeangle_
	filtered max angle between helix and sheet More...

core::Real	filter_min_dist_
	filtered min dist between helix and sheet More...

core::Real	filter_max_dist_
	filtered max dist between helix and sheet More...

core::Size	strand_id1_
	strand id More...

core::Size	strand_id2_
	strand id More...

core::Size	helix_id_
	helix_id More...

std::string	output_type_
	output_type More...

core::Real	output_value_
	output value, the result of filterring calculation More...

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

Detailed Description

Another filter used in Marcos & Basanta et al. 2017 that needs to be updated.

Constructor & Destructor Documentation

◆ StrandHelixGeometryFilter()

protocols::fldsgn::filters::StrandHelixGeometryFilter::StrandHelixGeometryFilter ( )

◆ ~StrandHelixGeometryFilter()

protocols::fldsgn::filters::StrandHelixGeometryFilter::~StrandHelixGeometryFilter ( )

overridedefault

Member Function Documentation

◆ apply()

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

overridevirtual

returns true if the structure passes the filter, false otherwise

Implements protocols::filters::Filter.

References protocols::fldsgn::topology::calc_strand_helix_angle(), core::kinematics::distance(), protocols::simple_filters::dssp(), filter_max_dist_, filter_max_orthoangle_, filter_max_planeangle_, helix_id_, protocols::fldsgn::topology::NO_STRANDS, output_type_, output_value_, secstruct_, strand_id1_, strand_id2_, and protocols::fldsgn::TR().

◆ class_name()

std::string protocols::fldsgn::filters::StrandHelixGeometryFilter::class_name ( )

static

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

◆ clone()

protocols::filters::FilterOP protocols::fldsgn::filters::StrandHelixGeometryFilter::clone ( ) const

overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

◆ filter_max_dist()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_dist ( core::Real const r )

maximum angle for filtering

maximum distance for filtering

References filter_max_dist_.

◆ filter_max_orthoangle()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_orthoangle ( core::Real const r )

maximum angle for filtering

References filter_max_orthoangle_.

◆ filter_max_planeangle()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_planeangle ( core::Real const r )

maximum angle for filtering

References filter_max_planeangle_.

◆ filter_min_dist()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_dist ( core::Real const r )

miniimum angle for filtering

minimum distance for filtering

References filter_min_dist_.

◆ filter_min_orthoangle()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_orthoangle ( core::Real const r )

miniimum angle for filtering

minimum angle for filtering

References filter_min_orthoangle_.

◆ filter_min_planeangle()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_planeangle ( core::Real const r )

miniimum angle for filtering

minimum angle for filtering

References filter_min_planeangle_.

◆ fresh_instance()

protocols::filters::FilterOP protocols::fldsgn::filters::StrandHelixGeometryFilter::fresh_instance ( ) const

overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

◆ helix_id()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::helix_id ( core::Size const r )

maximum angle for filtering

Strand id number.

References helix_id_.

◆ name()

std::string protocols::fldsgn::filters::StrandHelixGeometryFilter::name ( ) const

overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

◆ output_type()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::output_type ( std::string const & s )

set output type

References output_type_.

◆ parse_my_tag()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data
	)

overridevirtual

parse XML tag (to use this Filter in Rosetta Scripts)

Reimplemented from protocols::filters::Filter.

References filter_max_dist_, filter_max_orthoangle_, filter_max_planeangle_, filter_min_dist_, filter_min_orthoangle_, filter_min_planeangle_, helix_id_, output_type_, protocols::parser::BluePrint::secstruct(), secstruct_, strand_id1_, and strand_id2_.

◆ provide_xml_schema()

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

static

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

Referenced by protocols::fldsgn::filters::StrandHelixGeometryFilterCreator::provide_xml_schema().

◆ report()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::report	(	std::ostream &	os,
		core::pose::Pose const &	pose
	)		const

overridevirtual

allows printing data to a stream

Reimplemented from protocols::filters::Filter.

◆ report_sm()

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

overridevirtual

required for reporting score values

Reimplemented from protocols::filters::Filter.

References output_value_.

◆ secstruct()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::secstruct ( std::string const & ss )

miniimum angle for filtering

References secstruct_.

◆ strand_id1()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::strand_id1 ( core::Size const r )

miniimum angle for filtering

Strand id number.

References strand_id1_.

◆ strand_id2()

void protocols::fldsgn::filters::StrandHelixGeometryFilter::strand_id2 ( core::Size const r )

miniimum angle for filtering

Strand id number.

References strand_id2_.

Member Data Documentation

◆ filter_max_dist_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_dist_

private

filtered max dist between helix and sheet

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

◆ filter_max_orthoangle_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_orthoangle_

private

filtered max angle between helix and sheet

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

◆ filter_max_planeangle_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_max_planeangle_

private

filtered max angle between helix and sheet

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

◆ filter_min_dist_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_dist_

private

filtered min dist between helix and sheet

Referenced by filter_min_dist(), and parse_my_tag().

◆ filter_min_orthoangle_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_orthoangle_

private

filtered min angle between helix and sheet

Referenced by filter_min_orthoangle(), and parse_my_tag().

◆ filter_min_planeangle_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::filter_min_planeangle_

private

filtered min angle between helix and sheet

Referenced by filter_min_planeangle(), and parse_my_tag().

◆ helix_id_

core::Size protocols::fldsgn::filters::StrandHelixGeometryFilter::helix_id_

private

helix_id

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

◆ output_type_

std::string protocols::fldsgn::filters::StrandHelixGeometryFilter::output_type_

private

output_type

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

◆ output_value_

core::Real protocols::fldsgn::filters::StrandHelixGeometryFilter::output_value_

mutableprivate

output value, the result of filterring calculation

Referenced by apply(), and report_sm().

◆ secstruct_

std::string protocols::fldsgn::filters::StrandHelixGeometryFilter::secstruct_

mutableprivate

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

◆ strand_id1_

core::Size protocols::fldsgn::filters::StrandHelixGeometryFilter::strand_id1_

private

strand id

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

◆ strand_id2_

core::Size protocols::fldsgn::filters::StrandHelixGeometryFilter::strand_id2_

private

strand id

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

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

src/protocols/fldsgn/filters/StrandHelixGeometryFilter.hh
src/protocols/fldsgn/filters/StrandHelixGeometryFilter.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StrandHelixGeometryFilter()

◆ ~StrandHelixGeometryFilter()

Member Function Documentation

◆ apply()

◆ class_name()

◆ clone()

◆ filter_max_dist()

◆ filter_max_orthoangle()

◆ filter_max_planeangle()

◆ filter_min_dist()

◆ filter_min_orthoangle()

◆ filter_min_planeangle()

◆ fresh_instance()

◆ helix_id()

◆ name()

◆ output_type()

◆ parse_my_tag()

◆ provide_xml_schema()

◆ report()

◆ report_sm()

◆ secstruct()

◆ strand_id1()

◆ strand_id2()

Member Data Documentation

◆ filter_max_dist_

◆ filter_max_orthoangle_

◆ filter_max_planeangle_

◆ filter_min_dist_

◆ filter_min_orthoangle_

◆ filter_min_planeangle_

◆ helix_id_

◆ output_type_

◆ output_value_

◆ secstruct_

◆ strand_id1_

◆ strand_id2_