score_filters

Bindings for protocols::score_filters namespace

class pyrosetta.rosetta.protocols.score_filters.GeometryFilter

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool

C++: protocols::score_filters::GeometryFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str

C++: protocols::score_filters::GeometryFilter::class_name() –> std::string

clear(self: pyrosetta.rosetta.protocols.filters.Filter) → None

used to clear internal variables if needed. Using fresh_instance is preferred since it’s a pure virtual

C++: protocols::filters::Filter::clear() –> void

clone(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::GeometryFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter, pose: pyrosetta.rosetta.core.pose.Pose) → int

C++: protocols::score_filters::GeometryFilter::compute(const class core::pose::Pose &) const –> unsigned long

fresh_instance(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::GeometryFilter::fresh_instance() const –> class std::shared_ptr<class protocols::filters::Filter>

get_type(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_type() const –> std::string

get_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_user_defined_name() const –> std::string

name(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter) → str

C++: protocols::score_filters::GeometryFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None

C++: protocols::score_filters::GeometryFilter::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_citation_info(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by filters wishing to provide citation information.

C++: protocols::filters::Filter::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::score_filters::GeometryFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: protocols::score_filters::GeometryFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::score_filters::GeometryFilter::report_sm(const class core::pose::Pose &) const –> double

score(self: pyrosetta.rosetta.protocols.filters.Filter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::filters::Filter::score(class core::pose::Pose &) –> double

set_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter, name: str) → None

C++: protocols::filters::Filter::set_user_defined_name(const std::string &) –> void

class pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator, : pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator) → pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator

C++: protocols::score_filters::GeometryFilterCreator::operator=(const class protocols::score_filters::GeometryFilterCreator &) –> class protocols::score_filters::GeometryFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::GeometryFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator) → str

C++: protocols::score_filters::GeometryFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.score_filters.GeometryFilterCreator, xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::score_filters::GeometryFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter

Bases: Filter

add_score_type(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, scotype: pyrosetta.rosetta.core.scoring.ScoreType) → None

C++: protocols::score_filters::ScoreCutoffFilter::add_score_type(enum core::scoring::ScoreType) –> void

apply(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool

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.

C++: protocols::score_filters::ScoreCutoffFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str

C++: protocols::score_filters::ScoreCutoffFilter::class_name() –> std::string

clear(self: pyrosetta.rosetta.protocols.filters.Filter) → None

used to clear internal variables if needed. Using fresh_instance is preferred since it’s a pure virtual

C++: protocols::filters::Filter::clear() –> void

clone(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreCutoffFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

cutoff(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter) → float

C++: protocols::score_filters::ScoreCutoffFilter::cutoff() const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreCutoffFilter::fresh_instance() const –> class std::shared_ptr<class protocols::filters::Filter>

get_score(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::score_filters::ScoreCutoffFilter::get_score(const class core::pose::Pose &) const –> double

get_type(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_type() const –> std::string

get_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_user_defined_name() const –> std::string

name(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter) → str

C++: protocols::score_filters::ScoreCutoffFilter::name() const –> std::string

output_residue_pair_energies(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, ostr: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: protocols::score_filters::ScoreCutoffFilter::output_residue_pair_energies(std::ostream &, const class core::pose::Pose &) const –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None

C++: protocols::score_filters::ScoreCutoffFilter::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_citation_info(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by filters wishing to provide citation information.

C++: protocols::filters::Filter::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None

C++: protocols::score_filters::ScoreCutoffFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, ostr: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: protocols::score_filters::ScoreCutoffFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::filters::Filter::report_sm(const class core::pose::Pose &) const –> double

score(self: pyrosetta.rosetta.protocols.filters.Filter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::filters::Filter::score(class core::pose::Pose &) –> double

set_cutoff(*args, **kwargs)

Overloaded function.

1. set_cutoff(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, cutoff_in: float) -> None

C++: protocols::score_filters::ScoreCutoffFilter::set_cutoff(double) –> void

2. set_cutoff(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, pose: pyrosetta.rosetta.core.pose.Pose) -> None

C++: protocols::score_filters::ScoreCutoffFilter::set_cutoff(const class core::pose::Pose &) –> void

set_positions(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, positions: pyrosetta.rosetta.utility.vector1_unsigned_long) → None

C++: protocols::score_filters::ScoreCutoffFilter::set_positions(const class utility::vector1<unsigned long, class std::allocator<unsigned long> > &) –> void

set_score_type(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, scotype: pyrosetta.rosetta.core.scoring.ScoreType) → None

C++: protocols::score_filters::ScoreCutoffFilter::set_score_type(enum core::scoring::ScoreType) –> void

set_unweighted(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilter, init: bool) → None

C++: protocols::score_filters::ScoreCutoffFilter::set_unweighted(bool) –> void

set_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter, name: str) → None

C++: protocols::filters::Filter::set_user_defined_name(const std::string &) –> void

class pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator, : pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator) → pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator

C++: protocols::score_filters::ScoreCutoffFilterCreator::operator=(const class protocols::score_filters::ScoreCutoffFilterCreator &) –> class protocols::score_filters::ScoreCutoffFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreCutoffFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator) → str

C++: protocols::score_filters::ScoreCutoffFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.score_filters.ScoreCutoffFilterCreator, xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::score_filters::ScoreCutoffFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool

C++: protocols::score_filters::ScoreTypeFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str

C++: protocols::score_filters::ScoreTypeFilter::class_name() –> std::string

clear(self: pyrosetta.rosetta.protocols.filters.Filter) → None

used to clear internal variables if needed. Using fresh_instance is preferred since it’s a pure virtual

C++: protocols::filters::Filter::clear() –> void

clone(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreTypeFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::score_filters::ScoreTypeFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreTypeFilter::fresh_instance() const –> class std::shared_ptr<class protocols::filters::Filter>

get_type(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_type() const –> std::string

get_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter) → str

C++: protocols::filters::Filter::get_user_defined_name() const –> std::string

name(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter) → str

C++: protocols::score_filters::ScoreTypeFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None

C++: protocols::score_filters::ScoreTypeFilter::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_citation_info(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by filters wishing to provide citation information.

C++: protocols::filters::Filter::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::score_filters::ScoreTypeFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: protocols::score_filters::ScoreTypeFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::score_filters::ScoreTypeFilter::report_sm(const class core::pose::Pose &) const –> double

score(self: pyrosetta.rosetta.protocols.filters.Filter, pose: pyrosetta.rosetta.core.pose.Pose) → float

C++: protocols::filters::Filter::score(class core::pose::Pose &) –> double

set_score_type(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, scoretype_in: pyrosetta.rosetta.core.scoring.ScoreType) → None

Sets the score term that will be used for scoring.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::score_filters::ScoreTypeFilter::set_score_type(const enum core::scoring::ScoreType) –> void

set_scorefxn(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, sfxn_in: pyrosetta.rosetta.core.scoring.ScoreFunction) → None

Sets the scorefunction.

Note that this filter stores a clone of the scorefunction.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::score_filters::ScoreTypeFilter::set_scorefxn(class std::shared_ptr<const class core::scoring::ScoreFunction>) –> void

set_threshold(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilter, thresh_in: float) → None

Sets the energy threshold used for filtering.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::score_filters::ScoreTypeFilter::set_threshold(const double &) –> void

set_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter, name: str) → None

C++: protocols::filters::Filter::set_user_defined_name(const std::string &) –> void

class pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator, : pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator) → pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator

C++: protocols::score_filters::ScoreTypeFilterCreator::operator=(const class protocols::score_filters::ScoreTypeFilterCreator &) –> class protocols::score_filters::ScoreTypeFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter

C++: protocols::score_filters::ScoreTypeFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator) → str

C++: protocols::score_filters::ScoreTypeFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.score_filters.ScoreTypeFilterCreator, xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::score_filters::ScoreTypeFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void