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::simple_filters::HolesFilter Class Reference

#include <HolesFilter.hh>

Inheritance diagram for protocols::simple_filters::HolesFilter:
Inheritance graph
[legend]

Public Types

typedef protocols::filters::Filter Super
 
typedef protocols::filters::Filter Filter
 
typedef
protocols::filters::FilterOP 
FilterOP
 
typedef core::Real Real
 
typedef core::pose::Pose Pose
 
typedef std::string String
 
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 

Public Member Functions

 HolesFilter ()
 
 HolesFilter (HolesFilter const &rval)
 
 ~HolesFilter () override=default
 
filters::FilterOP clone () const override
 
filters::FilterOP fresh_instance () const override
 
void filtered_value (Real const &ss)
 
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &data) override
 parse xml More...
 
bool apply (Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
Real report_sm (Pose const &pose) const override
 used to report filter internals through a score or silent file More...
 
void report (std::ostream &out, Pose const &pose) const override
 used to report score More...
 
Real compute (Pose const &pose) const
 
std::string name () const override
 
void set_residue_selector (core::select::residue_selector::ResidueSelectorOP residue_selector)
 
void set_threshold (Real threshold)
 
void set_exclude_bb_atoms (bool exclude_bb_atoms)
 
void set_normalize_per_atom (bool normalize_per_atom)
 
void set_normalize_per_residue (bool normalize_per_residue)
 
- 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

Real filtered_value_
 
String cmd_
 
bool exclude_bb_atoms_
 
bool normalize_per_atom_
 
bool normalize_per_residue_
 
core::select::residue_selector::ResidueSelectorOP residue_selector_
 

Additional Inherited Members

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

Member Typedef Documentation

typedef basic::datacache::DataMap protocols::simple_filters::HolesFilter::DataMap
typedef utility::tag::TagCOP protocols::simple_filters::HolesFilter::TagCOP

Constructor & Destructor Documentation

protocols::simple_filters::HolesFilter::HolesFilter ( )
protocols::simple_filters::HolesFilter::HolesFilter ( HolesFilter const &  rval)
default
protocols::simple_filters::HolesFilter::~HolesFilter ( )
overridedefault

Member Function Documentation

bool protocols::simple_filters::HolesFilter::apply ( Pose const &  pose) const
overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References compute(), filtered_value_, and protocols::simple_filters::tr().

std::string protocols::simple_filters::HolesFilter::class_name ( )
static
filters::FilterOP protocols::simple_filters::HolesFilter::clone ( ) const
inlineoverridevirtual
HolesFilter::Real protocols::simple_filters::HolesFilter::compute ( Pose const &  pose) const
void protocols::simple_filters::HolesFilter::filtered_value ( Real const &  ss)

References filtered_value_.

filters::FilterOP protocols::simple_filters::HolesFilter::fresh_instance ( ) const
inlineoverridevirtual
std::string protocols::simple_filters::HolesFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::simple_filters::HolesFilter::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap &  data 
)
overridevirtual
void protocols::simple_filters::HolesFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::simple_filters::HolesFilter::report ( std::ostream &  out,
Pose const &  pose 
) const
overridevirtual

used to report score

Reimplemented from protocols::filters::Filter.

References compute().

HolesFilter::Real protocols::simple_filters::HolesFilter::report_sm ( Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::simple_filters::HolesFilter::set_exclude_bb_atoms ( bool  exclude_bb_atoms)
inline

References exclude_bb_atoms_.

void protocols::simple_filters::HolesFilter::set_normalize_per_atom ( bool  normalize_per_atom)
inline

References normalize_per_atom_.

void protocols::simple_filters::HolesFilter::set_normalize_per_residue ( bool  normalize_per_residue)
inline
void protocols::simple_filters::HolesFilter::set_residue_selector ( core::select::residue_selector::ResidueSelectorOP  residue_selector)
inline

References residue_selector_.

void protocols::simple_filters::HolesFilter::set_threshold ( Real  threshold)
inline

References filtered_value_.

Member Data Documentation

String protocols::simple_filters::HolesFilter::cmd_
private

Referenced by compute(), and parse_my_tag().

bool protocols::simple_filters::HolesFilter::exclude_bb_atoms_
private
Real protocols::simple_filters::HolesFilter::filtered_value_
private
bool protocols::simple_filters::HolesFilter::normalize_per_atom_
private
bool protocols::simple_filters::HolesFilter::normalize_per_residue_
private
core::select::residue_selector::ResidueSelectorOP protocols::simple_filters::HolesFilter::residue_selector_
private

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