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

#include <ScoreCutoffFilter.hh>

Inheritance diagram for protocols::score_filters::ScoreCutoffFilter:
Inheritance graph
[legend]

Public Types

typedef protocols::filters::Filter parent
 

Public Member Functions

 ScoreCutoffFilter ()
 c-tor and More...
 
 ScoreCutoffFilter (core::Real cutoff_in)
 
filters::FilterOP clone () const override
 
filters::FilterOP fresh_instance () const override
 
void report (std::ostream &ostr, core::pose::Pose const &pose) const 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...
 
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. In this case, the test is the result of the following comparison: sc <= cutoff Where cutoff is the cutoff set for this filter, and sc is the value of the ScoreType from the Pose Energies object. More...
 
void set_cutoff (core::Real cutoff_in)
 
void set_cutoff (core::pose::Pose const &pose)
 
core::Real cutoff () const
 
void add_score_type (core::scoring::ScoreType scotype)
 
void set_score_type (core::scoring::ScoreType scotype)
 
void set_positions (utility::vector1< core::Size > const &positions)
 
void set_unweighted (bool init)
 
core::Real get_score (core::pose::Pose const &pose) const
 
void output_residue_pair_energies (std::ostream &ostr, core::pose::Pose const &pose) const
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
 ~Filter () override
 
virtual core::Real report_sm (core::pose::Pose const &) const
 used to report filter internals through a score or silent file More...
 
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

core::Real cutoff_
 
bool report_residue_pair_energies_
 
bool pdb_numbering_
 
utility::vector1
< core::scoring::ScoreType
score_types_
 
utility::vector1< core::Sizepositions_
 
bool total_score_
 
bool unweighted_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::score_filters::ScoreCutoffFilter::ScoreCutoffFilter ( )

c-tor and

References positions_, score_types_, and core::scoring::total_score.

protocols::score_filters::ScoreCutoffFilter::ScoreCutoffFilter ( core::Real  cutoff_in)

Member Function Documentation

void protocols::score_filters::ScoreCutoffFilter::add_score_type ( core::scoring::ScoreType  scotype)
bool protocols::score_filters::ScoreCutoffFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

Returns true if the given pose passes the filter, false otherwise. In this case, the test is the result of the following comparison: sc <= cutoff Where cutoff is the cutoff set for this filter, and sc is the value of the ScoreType from the Pose Energies object.

Implements protocols::filters::Filter.

References cutoff(), and get_score().

std::string protocols::score_filters::ScoreCutoffFilter::class_name ( )
static
filters::FilterOP protocols::score_filters::ScoreCutoffFilter::clone ( ) const
inlineoverridevirtual
core::Real protocols::score_filters::ScoreCutoffFilter::cutoff ( ) const
inline

References cutoff_.

Referenced by apply().

filters::FilterOP protocols::score_filters::ScoreCutoffFilter::fresh_instance ( ) const
inlineoverridevirtual
core::Real protocols::score_filters::ScoreCutoffFilter::get_score ( core::pose::Pose const &  pose) const
std::string protocols::score_filters::ScoreCutoffFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::score_filters::ScoreCutoffFilter::output_residue_pair_energies ( std::ostream &  ostr,
core::pose::Pose const &  pose 
) const
void protocols::score_filters::ScoreCutoffFilter::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 cutoff_, pdb_numbering_, and report_residue_pair_energies_.

void protocols::score_filters::ScoreCutoffFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::score_filters::ScoreCutoffFilter::report ( std::ostream &  ostr,
core::pose::Pose const &  pose 
) const
overridevirtual
void protocols::score_filters::ScoreCutoffFilter::set_cutoff ( core::Real  cutoff_in)
inline

References cutoff_.

void protocols::score_filters::ScoreCutoffFilter::set_cutoff ( core::pose::Pose const &  pose)
inline

References cutoff_, and get_score().

void protocols::score_filters::ScoreCutoffFilter::set_positions ( utility::vector1< core::Size > const &  positions)
inline

References positions_.

void protocols::score_filters::ScoreCutoffFilter::set_score_type ( core::scoring::ScoreType  scotype)

References add_score_type(), and score_types_.

void protocols::score_filters::ScoreCutoffFilter::set_unweighted ( bool  init)
inline

References core::init::init(), and unweighted_.

Member Data Documentation

core::Real protocols::score_filters::ScoreCutoffFilter::cutoff_
private
bool protocols::score_filters::ScoreCutoffFilter::pdb_numbering_
private
utility::vector1< core::Size > protocols::score_filters::ScoreCutoffFilter::positions_
private
bool protocols::score_filters::ScoreCutoffFilter::report_residue_pair_energies_
private

Referenced by parse_my_tag(), and report().

utility::vector1< core::scoring::ScoreType > protocols::score_filters::ScoreCutoffFilter::score_types_
private
bool protocols::score_filters::ScoreCutoffFilter::total_score_
private

Referenced by add_score_type(), and get_score().

bool protocols::score_filters::ScoreCutoffFilter::unweighted_
private

Referenced by get_score(), and set_unweighted().


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