Rosetta  2021.16
 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::score_filters::ScoreTypeFilter Class Reference

#include <ScoreTypeFilter.hh>

Inheritance diagram for protocols::score_filters::ScoreTypeFilter:
Inheritance graph

Public Member Functions

 ScoreTypeFilter ()
 Constructor. More...
 ScoreTypeFilter (ScoreTypeFilter const &src)
 Copy constructor. More...
 ScoreTypeFilter (core::scoring::ScoreFunctionCOP scorefxn, core::scoring::ScoreType const score_type, core::Real const score_type_threshold)
 Constructor with parameters. More...
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
filters::FilterOP clone () const override
filters::FilterOP fresh_instance () const override
void set_scorefxn (core::scoring::ScoreFunctionCOP sfxn_in)
 Sets the scorefunction. More...
void set_score_type (core::scoring::ScoreType const scoretype_in)
 Sets the score term that will be used for scoring. More...
void set_threshold (core::Real const &thresh_in)
 Sets the energy threshold used for filtering. 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...
core::Real compute (core::pose::Pose const &pose) const
 ~ScoreTypeFilter () 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 (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 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 score_type_threshold_
core::scoring::ScoreType score_type_
core::scoring::ScoreFunctionOP scorefxn_

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::score_filters::ScoreTypeFilter::ScoreTypeFilter ( )


protocols::score_filters::ScoreTypeFilter::ScoreTypeFilter ( ScoreTypeFilter const &  src)

Copy constructor.

protocols::score_filters::ScoreTypeFilter::ScoreTypeFilter ( core::scoring::ScoreFunctionCOP  scorefxn,
core::scoring::ScoreType const  score_type,
core::Real const  score_type_threshold 

Constructor with parameters.

References score_type_, score_type_threshold_, and scorefxn_.

protocols::score_filters::ScoreTypeFilter::~ScoreTypeFilter ( )

Member Function Documentation

bool protocols::score_filters::ScoreTypeFilter::apply ( core::pose::Pose const &  pose) const
std::string protocols::score_filters::ScoreTypeFilter::class_name ( )
filters::FilterOP protocols::score_filters::ScoreTypeFilter::clone ( ) const
core::Real protocols::score_filters::ScoreTypeFilter::compute ( core::pose::Pose const &  pose) const
filters::FilterOP protocols::score_filters::ScoreTypeFilter::fresh_instance ( ) const
std::string protocols::score_filters::ScoreTypeFilter::name ( ) const

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::score_filters::ScoreTypeFilter::parse_my_tag ( utility::tag::TagCOP  ,
basic::datacache::DataMap &   
void protocols::score_filters::ScoreTypeFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
void protocols::score_filters::ScoreTypeFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
core::Real protocols::score_filters::ScoreTypeFilter::report_sm ( core::pose::Pose const &  ) const

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::score_filters::ScoreTypeFilter::set_score_type ( core::scoring::ScoreType const  scoretype_in)

Sets the score term that will be used for scoring.

Vikram K. Mulligan (

References score_type_.

Referenced by parse_my_tag().

void protocols::score_filters::ScoreTypeFilter::set_scorefxn ( core::scoring::ScoreFunctionCOP  sfxn_in)

Sets the scorefunction.

Note that this filter stores a clone of the scorefunction.

Vikram K. Mulligan (

References scorefxn_.

Referenced by parse_my_tag().

void protocols::score_filters::ScoreTypeFilter::set_threshold ( core::Real const &  thresh_in)

Sets the energy threshold used for filtering.

Vikram K. Mulligan (

References score_type_threshold_.

Referenced by parse_my_tag().

Member Data Documentation

core::scoring::ScoreType protocols::score_filters::ScoreTypeFilter::score_type_
core::Real protocols::score_filters::ScoreTypeFilter::score_type_threshold_
core::scoring::ScoreFunctionOP protocols::score_filters::ScoreTypeFilter::scorefxn_

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