Rosetta
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::constraint_filters::ConstraintScoreCutoffFilter Class Reference

#include <ConstraintScoreCutoffFilter.hh>

Inheritance diagram for protocols::constraint_filters::ConstraintScoreCutoffFilter:
Inheritance graph
[legend]

Public Types

typedef protocols::filters::Filter parent
 

Public Member Functions

 ConstraintScoreCutoffFilter ()
 c-tor and More...
 
 ConstraintScoreCutoffFilter (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 set_constraints (core::scoring::constraints::ConstraintCOPs cst_in)
 
void set_score_type (core::scoring::ScoreType scotype)
 
virtual core::Real get_score (core::pose::Pose const &pose) const
 
core::Real get_score (core::pose::Pose const &pose_in, core::scoring::constraints::ConstraintCOPs csts) const
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string 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 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...
 

Private Attributes

core::scoring::ScoreType score_type_
 
core::Real cutoff_
 
core::scoring::constraints::ConstraintCOPs constraints_
 

Additional Inherited Members

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

Member Typedef Documentation

◆ parent

Constructor & Destructor Documentation

◆ ConstraintScoreCutoffFilter() [1/2]

protocols::constraint_filters::ConstraintScoreCutoffFilter::ConstraintScoreCutoffFilter ( )

c-tor and

◆ ConstraintScoreCutoffFilter() [2/2]

protocols::constraint_filters::ConstraintScoreCutoffFilter::ConstraintScoreCutoffFilter ( core::Real  cutoff_in)

Member Function Documentation

◆ apply()

bool protocols::constraint_filters::ConstraintScoreCutoffFilter::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 protocols::jd2::add_string_real_pair_to_current_job(), cutoff(), get_score(), protocols::filters::Filter::get_user_defined_name(), and protocols::jd2::jd2_used().

◆ clone()

filters::FilterOP protocols::constraint_filters::ConstraintScoreCutoffFilter::clone ( ) const
inlineoverridevirtual

◆ cutoff()

core::Real protocols::constraint_filters::ConstraintScoreCutoffFilter::cutoff ( ) const
inline

References cutoff_.

Referenced by apply().

◆ fresh_instance()

filters::FilterOP protocols::constraint_filters::ConstraintScoreCutoffFilter::fresh_instance ( ) const
inlineoverridevirtual

◆ get_score() [1/2]

core::Real protocols::constraint_filters::ConstraintScoreCutoffFilter::get_score ( core::pose::Pose const &  pose) const
virtual

◆ get_score() [2/2]

core::Real protocols::constraint_filters::ConstraintScoreCutoffFilter::get_score ( core::pose::Pose const &  pose_in,
core::scoring::constraints::ConstraintCOPs  csts 
) const

◆ name()

std::string protocols::constraint_filters::ConstraintScoreCutoffFilter::name ( ) const
inlineoverridevirtual

◆ parse_my_tag()

void protocols::constraint_filters::ConstraintScoreCutoffFilter::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.

Reimplemented in protocols::protein_interface_design::filters::StubScoreLoopsFilter.

References cutoff_, and protocols::filters::Filter::set_user_defined_name().

◆ report()

void protocols::constraint_filters::ConstraintScoreCutoffFilter::report ( std::ostream &  ostr,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

◆ set_constraints()

void protocols::constraint_filters::ConstraintScoreCutoffFilter::set_constraints ( core::scoring::constraints::ConstraintCOPs  cst_in)

References constraints_.

◆ set_cutoff() [1/2]

void protocols::constraint_filters::ConstraintScoreCutoffFilter::set_cutoff ( core::pose::Pose const &  pose)
inline

References cutoff_, and get_score().

◆ set_cutoff() [2/2]

void protocols::constraint_filters::ConstraintScoreCutoffFilter::set_cutoff ( core::Real  cutoff_in)
inline

References cutoff_.

◆ set_score_type()

void protocols::constraint_filters::ConstraintScoreCutoffFilter::set_score_type ( core::scoring::ScoreType  scotype)

Member Data Documentation

◆ constraints_

core::scoring::constraints::ConstraintCOPs protocols::constraint_filters::ConstraintScoreCutoffFilter::constraints_
private

Referenced by get_score(), and set_constraints().

◆ cutoff_

core::Real protocols::constraint_filters::ConstraintScoreCutoffFilter::cutoff_
private

Referenced by cutoff(), parse_my_tag(), and set_cutoff().

◆ score_type_

core::scoring::ScoreType protocols::constraint_filters::ConstraintScoreCutoffFilter::score_type_
private

Referenced by get_score(), and set_score_type().


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