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::filters::ReplicateFilter Class Reference

#include <ReplicateFilter.hh>

Inheritance diagram for protocols::filters::ReplicateFilter:
Inheritance graph
[legend]

Public Member Functions

 ReplicateFilter ()
 default ctor More...
 
 ReplicateFilter (protocols::filters::FilterOP subfilter, core::Size replicates=1, core::Size upper_trim=0, core::Size lower_trim=0)
 
bool apply (core::pose::Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. 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
 
protocols::filters::FilterOP clone () const override
 
protocols::filters::FilterOP fresh_instance () const override
 
 ~ReplicateFilter () override=default
 
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...
 
void subfilter (protocols::filters::FilterOP subfilter)
 
void median (bool median)
 
void threshold (core::Real threshold)
 
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 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

protocols::filters::FilterOP subfilter_
 
core::Size replicates_
 
core::Size upper_trim_
 
core::Size lower_trim_
 
bool median_
 
core::Real threshold_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

protocols::filters::ReplicateFilter::ReplicateFilter ( )

default ctor

protocols::filters::ReplicateFilter::ReplicateFilter ( protocols::filters::FilterOP  subfilter,
core::Size  replicates = 1,
core::Size  upper_trim = 0,
core::Size  lower_trim = 0 
)
protocols::filters::ReplicateFilter::~ReplicateFilter ( )
overridedefault

Member Function Documentation

bool protocols::filters::ReplicateFilter::apply ( core::pose::Pose const &  pose) const
overridevirtual

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

Implements protocols::filters::Filter.

References compute(), and threshold_.

std::string protocols::filters::ReplicateFilter::class_name ( )
static
protocols::filters::FilterOP protocols::filters::ReplicateFilter::clone ( ) const
inlineoverridevirtual
core::Real protocols::filters::ReplicateFilter::compute ( core::pose::Pose const &  pose) const
protocols::filters::FilterOP protocols::filters::ReplicateFilter::fresh_instance ( ) const
inlineoverridevirtual
void protocols::filters::ReplicateFilter::median ( bool  median)
inline

References median(), and median_.

Referenced by median().

std::string protocols::filters::ReplicateFilter::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::filters::ReplicateFilter::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 lower_trim_, median_, protocols::rosetta_scripts::parse_filter(), replicates_, subfilter_, threshold_, and upper_trim_.

void protocols::filters::ReplicateFilter::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::filters::ReplicateFilter::report ( std::ostream &  out,
core::pose::Pose const &  pose 
) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References compute().

core::Real protocols::filters::ReplicateFilter::report_sm ( core::pose::Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References compute().

void protocols::filters::ReplicateFilter::subfilter ( protocols::filters::FilterOP  subfilter)
inline

References subfilter(), and subfilter_.

Referenced by subfilter().

void protocols::filters::ReplicateFilter::threshold ( core::Real  threshold)
inline

References threshold(), and threshold_.

Referenced by threshold().

Member Data Documentation

core::Size protocols::filters::ReplicateFilter::lower_trim_
private

Referenced by compute(), and parse_my_tag().

bool protocols::filters::ReplicateFilter::median_
private

Referenced by compute(), median(), and parse_my_tag().

core::Size protocols::filters::ReplicateFilter::replicates_
private

Referenced by compute(), and parse_my_tag().

protocols::filters::FilterOP protocols::filters::ReplicateFilter::subfilter_
private

Referenced by compute(), parse_my_tag(), and subfilter().

core::Real protocols::filters::ReplicateFilter::threshold_
private

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

core::Size protocols::filters::ReplicateFilter::upper_trim_
private

Referenced by compute(), and parse_my_tag().


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