Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::fldsgn::filters::StrandHelixGeometryFilter Class Reference

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:
Inheritance graph
[legend]

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 (Filter 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 bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. 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

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

Member Function Documentation

bool protocols::fldsgn::filters::StrandHelixGeometryFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual
std::string protocols::fldsgn::filters::StrandHelixGeometryFilter::class_name ( )
static
protocols::filters::FilterOP protocols::fldsgn::filters::StrandHelixGeometryFilter::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

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

maximum angle for filtering

maximum distance for filtering

References filter_max_dist_.

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

maximum angle for filtering

References filter_max_orthoangle_.

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

maximum angle for filtering

References filter_max_planeangle_.

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

miniimum angle for filtering

minimum distance for filtering

References filter_min_dist_.

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

miniimum angle for filtering

minimum angle for filtering

References filter_min_orthoangle_.

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

miniimum angle for filtering

minimum angle for filtering

References filter_min_planeangle_.

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

required in the context of the parser/scripting scheme

Implements protocols::filters::Filter.

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

maximum angle for filtering

Strand id number.

References helix_id_.

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

Reimplemented from protocols::filters::Filter.

References class_name().

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

set output type

References output_type_.

void protocols::fldsgn::filters::StrandHelixGeometryFilter::parse_my_tag ( utility::tag::TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual
void protocols::fldsgn::filters::StrandHelixGeometryFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
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.

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

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

miniimum angle for filtering

References secstruct_.

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

miniimum angle for filtering

Strand id number.

References strand_id1_.

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

miniimum angle for filtering

Strand id number.

References strand_id2_.

Member Data Documentation

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

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

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

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

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

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

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

helix_id

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

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

output_type

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

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

output value, the result of filterring calculation

Referenced by apply(), and report_sm().

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

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

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

strand id

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

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: