filters¶

Bindings for protocols::filters namespace

class pyrosetta.rosetta.protocols.filters.CalculatorFilter¶

Bases: Filter

add_constant(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, name: str, value: float) → None¶: C++: protocols::filters::CalculatorFilter::add_constant(const std::string &, double) –> void

add_filter(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, name: str, filter: pyrosetta.rosetta.protocols.filters.Filter) → None¶: C++: protocols::filters::CalculatorFilter::add_filter(const std::string &, class std::shared_ptr<class protocols::filters::Filter>) –> void

add_reported_value(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, name: str, report_key: str) → None¶: C++: protocols::filters::CalculatorFilter::add_reported_value(const std::string &, const std::string &) –> void

apply(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::CalculatorFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::CalculatorFilter::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.filters.CalculatorFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CalculatorFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::CalculatorFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CalculatorFilter::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.filters.CalculatorFilter) → str¶: C++: protocols::filters::CalculatorFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::CalculatorFilter::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::filters::CalculatorFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::CalculatorFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::CalculatorFilter::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

threshold(self: pyrosetta.rosetta.protocols.filters.CalculatorFilter, threshold: float) → None¶: C++: protocols::filters::CalculatorFilter::threshold(double) –> void

class pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator, : pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator) → pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator¶: C++: protocols::filters::CalculatorFilterCreator::operator=(const class protocols::filters::CalculatorFilterCreator &) –> class protocols::filters::CalculatorFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CalculatorFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator) → str¶: C++: protocols::filters::CalculatorFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.CalculatorFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::CalculatorFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.CombinedFilter¶

Bases: Filter

Used to combine multiple seperate filters into a single filter value

add_filter(*args, **kwargs)¶

Overloaded function.

add_filter(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, filter: pyrosetta.rosetta.protocols.filters.Filter, weight: float) -> None
add_filter(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, filter: pyrosetta.rosetta.protocols.filters.Filter, weight: float, clone_filter: bool) -> None

Add a filter/weight pair to the list of filters that this filter combines.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::filters::CombinedFilter::add_filter(class std::shared_ptr<class protocols::filters::Filter>, const double &, const bool) –> void

apply(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::CombinedFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::CombinedFilter::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

clear_reset_filters(self: pyrosetta.rosetta.protocols.filters.CombinedFilter) → None¶: C++: protocols::filters::CombinedFilter::clear_reset_filters() –> void

clone(self: pyrosetta.rosetta.protocols.filters.CombinedFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CombinedFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::CombinedFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.CombinedFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CombinedFilter::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.filters.CombinedFilter) → str¶: C++: protocols::filters::CombinedFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::CombinedFilter::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::filters::CombinedFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::CombinedFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::CombinedFilter::report_sm(const class core::pose::Pose &) const –> double

reset_filters(self: pyrosetta.rosetta.protocols.filters.CombinedFilter) → None¶: C++: protocols::filters::CombinedFilter::reset_filters() –> void

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_reset_filters(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, reset_filters: pyrosetta.rosetta.utility.vector1_std_shared_ptr_protocols_filters_Filter_t) → None¶: C++: protocols::filters::CombinedFilter::set_reset_filters(const class utility::vector1<class std::shared_ptr<class protocols::filters::Filter>, class std::allocator<class std::shared_ptr<class protocols::filters::Filter> > > &) –> void

set_threshold(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, val: float) → None¶

Set the overall filter threshold.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::filters::CombinedFilter::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.filters.CombinedFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.CombinedFilterCreator, : pyrosetta.rosetta.protocols.filters.CombinedFilterCreator) → pyrosetta.rosetta.protocols.filters.CombinedFilterCreator¶: C++: protocols::filters::CombinedFilterCreator::operator=(const class protocols::filters::CombinedFilterCreator &) –> class protocols::filters::CombinedFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.CombinedFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CombinedFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.CombinedFilterCreator) → str¶: C++: protocols::filters::CombinedFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.CombinedFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::CombinedFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.CompoundFilter¶

Bases: Filter, ResId

Used to define a compound logical statement involving other filters with AND, OR and XOR

apply(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::CompoundFilter::apply(const class core::pose::Pose &) const –> bool

assign(self: pyrosetta.rosetta.protocols.moves.ResId, : pyrosetta.rosetta.protocols.moves.ResId) → pyrosetta.rosetta.protocols.moves.ResId¶: C++: protocols::moves::ResId::operator=(const class protocols::moves::ResId &) –> class protocols::moves::ResId &

static class_name() → str¶: C++: protocols::filters::CompoundFilter::class_name() –> std::string

clear(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → None¶: C++: protocols::filters::CompoundFilter::clear() –> void

clear_reset_filters(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → None¶: C++: protocols::filters::CompoundFilter::clear_reset_filters() –> void

clone(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CompoundFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::CompoundFilter::compute(const class core::pose::Pose &) const –> bool

fresh_instance(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CompoundFilter::fresh_instance() const –> class std::shared_ptr<class protocols::filters::Filter>

get_resid(self: pyrosetta.rosetta.protocols.moves.ResId, : pyrosetta.rosetta.core.pose.Pose) → int¶: C++: protocols::moves::ResId::get_resid(const class core::pose::Pose &) const –> unsigned long

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

invert(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, inv: bool) → None¶: C++: protocols::filters::CompoundFilter::invert(const bool) –> void

modifiable(*args, **kwargs)¶

Overloaded function.

modifiable(self: pyrosetta.rosetta.protocols.moves.ResId) -> bool

should another method be able to modify resid_. This is used by modify_ResId_based_object as a test

C++: protocols::moves::ResId::modifiable() const –> bool

modifiable(self: pyrosetta.rosetta.protocols.moves.ResId, u: bool) -> None

C++: protocols::moves::ResId::modifiable(const bool) –> void

name(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → str¶: C++: protocols::filters::CompoundFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::CompoundFilter::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::filters::CompoundFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::CompoundFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::CompoundFilter::report_sm(const class core::pose::Pose &) const –> double

reset_filters(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) → None¶: C++: protocols::filters::CompoundFilter::reset_filters() –> void

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_reset_filters(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, reset_filters: pyrosetta.rosetta.utility.vector1_std_shared_ptr_protocols_filters_Filter_t) → None¶: C++: protocols::filters::CompoundFilter::set_reset_filters(const class utility::vector1<class std::shared_ptr<class protocols::filters::Filter>, class std::allocator<class std::shared_ptr<class protocols::filters::Filter> > > &) –> void

set_resid(*args, **kwargs)¶

Overloaded function.

set_resid(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, resid: int) -> None

C++: protocols::filters::CompoundFilter::set_resid(const unsigned long) –> void

set_resid(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, r: pyrosetta.rosetta.core.pose.ResidueIndexDescription) -> None

C++: protocols::filters::CompoundFilter::set_resid(class std::shared_ptr<const class core::pose::ResidueIndexDescription>) –> 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.filters.CompoundFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.CompoundFilterCreator, : pyrosetta.rosetta.protocols.filters.CompoundFilterCreator) → pyrosetta.rosetta.protocols.filters.CompoundFilterCreator¶: C++: protocols::filters::CompoundFilterCreator::operator=(const class protocols::filters::CompoundFilterCreator &) –> class protocols::filters::CompoundFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.CompoundFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::CompoundFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.CompoundFilterCreator) → str¶: C++: protocols::filters::CompoundFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.CompoundFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::CompoundFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.ContingentFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.ContingentFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Constructor with a single target residue

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

static class_name() → str¶: C++: protocols::filters::ContingentFilter::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.filters.ContingentFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ContingentFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.ContingentFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ContingentFilter::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

get_value(self: pyrosetta.rosetta.protocols.filters.ContingentFilter) → bool¶: C++: protocols::filters::ContingentFilter::get_value() const –> bool

name(self: pyrosetta.rosetta.protocols.filters.ContingentFilter) → str¶: C++: protocols::filters::ContingentFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.ContingentFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::ContingentFilter::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::filters::ContingentFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.ContingentFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::ContingentFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.ContingentFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::ContingentFilter::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

set_value(self: pyrosetta.rosetta.protocols.filters.ContingentFilter, value: bool) → None¶: C++: protocols::filters::ContingentFilter::set_value(const bool) –> void

class pyrosetta.rosetta.protocols.filters.ContingentFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.ContingentFilterCreator, : pyrosetta.rosetta.protocols.filters.ContingentFilterCreator) → pyrosetta.rosetta.protocols.filters.ContingentFilterCreator¶: C++: protocols::filters::ContingentFilterCreator::operator=(const class protocols::filters::ContingentFilterCreator &) –> class protocols::filters::ContingentFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.ContingentFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ContingentFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.ContingentFilterCreator) → str¶: C++: protocols::filters::ContingentFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.ContingentFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::ContingentFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.FalseFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.FalseFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::FalseFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::FalseFilter::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.filters.FalseFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::FalseFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.FalseFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::FalseFilter::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.filters.FalseFilter) → str¶: C++: protocols::filters::FalseFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.FalseFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::FalseFilter::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::filters::FalseFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::Filter::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_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.filters.FalseFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.FalseFilterCreator, : pyrosetta.rosetta.protocols.filters.FalseFilterCreator) → pyrosetta.rosetta.protocols.filters.FalseFilterCreator¶: C++: protocols::filters::FalseFilterCreator::operator=(const class protocols::filters::FalseFilterCreator &) –> class protocols::filters::FalseFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.FalseFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::FalseFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.FalseFilterCreator) → str¶: C++: protocols::filters::FalseFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.FalseFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::FalseFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.Filter¶

Bases: pybind11_object

apply(self: pyrosetta.rosetta.protocols.filters.Filter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

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

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

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.filters.Filter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::Filter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.Filter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::Filter::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.filters.Filter) → str¶: C++: protocols::filters::Filter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by FilterFactory when constructing new Filter. Takes care of the specific mover’s parsing.

C++: protocols::filters::Filter::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

report(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::Filter::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_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.filters.FilterCollection¶

Bases: pybind11_object

Wrapper-class that contains a vector1 of Filters

apply function returns true if all member filters return true

add_filter(self: pyrosetta.rosetta.protocols.filters.FilterCollection, filter_in: pyrosetta.rosetta.protocols.filters.Filter) → None¶: C++: protocols::filters::FilterCollection::add_filter(class std::shared_ptr<const class protocols::filters::Filter>) –> void

apply(self: pyrosetta.rosetta.protocols.filters.FilterCollection, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Returns true if the given pose passes all filters, false otherwise.

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

assign(self: pyrosetta.rosetta.protocols.filters.FilterCollection, : pyrosetta.rosetta.protocols.filters.FilterCollection) → pyrosetta.rosetta.protocols.filters.FilterCollection¶: C++: protocols::filters::FilterCollection::operator=(const class protocols::filters::FilterCollection &) –> class protocols::filters::FilterCollection &

clear(self: pyrosetta.rosetta.protocols.filters.FilterCollection) → None¶: C++: protocols::filters::FilterCollection::clear() –> void

get_filter(self: pyrosetta.rosetta.protocols.filters.FilterCollection, i: int) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::FilterCollection::get_filter(unsigned long) –> class std::shared_ptr<const class protocols::filters::Filter>

remove_last_filter(self: pyrosetta.rosetta.protocols.filters.FilterCollection) → None¶: C++: protocols::filters::FilterCollection::remove_last_filter() –> void

report(self: pyrosetta.rosetta.protocols.filters.FilterCollection, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::FilterCollection::report(std::ostream &, const class core::pose::Pose &) const –> void

size(self: pyrosetta.rosetta.protocols.filters.FilterCollection) → int¶: C++: protocols::filters::FilterCollection::size() –> unsigned long

class pyrosetta.rosetta.protocols.filters.FilterCreator¶

Bases: pybind11_object

Abstract base class for a Filter factory; the Creator class is responsible for creating a particular filter class.

assign(self: pyrosetta.rosetta.protocols.filters.FilterCreator, : pyrosetta.rosetta.protocols.filters.FilterCreator) → pyrosetta.rosetta.protocols.filters.FilterCreator¶: C++: protocols::filters::FilterCreator::operator=(const class protocols::filters::FilterCreator &) –> class protocols::filters::FilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.FilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::FilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.FilterCreator) → str¶: C++: protocols::filters::FilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.FilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶

Describe the schema for the Filter that this Creator is responsible for

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

class pyrosetta.rosetta.protocols.filters.FilterFactory¶

Bases: SingletonBase_protocols_filters_FilterFactory_t

define_filter_xml_schema(self: pyrosetta.rosetta.protocols.filters.FilterFactory, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::FilterFactory::define_filter_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

factory_register(self: pyrosetta.rosetta.protocols.filters.FilterFactory, creator: pyrosetta.rosetta.protocols.filters.FilterCreator) → None¶: C++: protocols::filters::FilterFactory::factory_register(class std::shared_ptr<class protocols::filters::FilterCreator>) –> void

filter_creator_map(self: pyrosetta.rosetta.protocols.filters.FilterFactory) → pyrosetta.rosetta.std.map_std_string_std_shared_ptr_protocols_filters_FilterCreator_t_std_allocator_std_pair_const_std_string_std_shared_ptr_protocols_filters_FilterCreator_t¶

Read access to the set of all FilterCreators; for unit testing purposes

C++: protocols::filters::FilterFactory::filter_creator_map() const –> const class std::map<std::string, class std::shared_ptr<class protocols::filters::FilterCreator>, struct std::less<std::string >, class std::allocator<struct std::pair<const std::string, class std::shared_ptr<class protocols::filters::FilterCreator> > > > &

filter_exists(self: pyrosetta.rosetta.protocols.filters.FilterFactory, filter_name: str) → bool¶

Is there a filter with the given name that’s known to Rosetta?

Vikram K. Mulligan (vmullig.edu)

C++: protocols::filters::FilterFactory::filter_exists(const std::string &) const –> bool

static filter_xml_schema_group_name() → str¶: C++: protocols::filters::FilterFactory::filter_xml_schema_group_name() –> std::string

get_citation_humanreadable(self: pyrosetta.rosetta.protocols.filters.FilterFactory, filter_name: str) → str¶

Get a human-readable listing of the citations for a given filter, by filter name.

Returns an empty string if there are no citations.

Vikram K. Mulligan (vmulligan.org).

C++: protocols::filters::FilterFactory::get_citation_humanreadable(const std::string &) const –> std::string

static get_instance() → protocols::filters::FilterFactory¶: C++: utility::SingletonBase<protocols::filters::FilterFactory>::get_instance() –> class protocols::filters::FilterFactory *

newFilter(*args, **kwargs)¶

Overloaded function.

newFilter(self: pyrosetta.rosetta.protocols.filters.FilterFactory, : str) -> pyrosetta.rosetta.protocols.filters.Filter

Create a filter given its identifying string

C++: protocols::filters::FilterFactory::newFilter(const std::string &) const –> class std::shared_ptr<class protocols::filters::Filter>

newFilter(self: pyrosetta.rosetta.protocols.filters.FilterFactory, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) -> pyrosetta.rosetta.protocols.filters.Filter
newFilter(self: pyrosetta.rosetta.protocols.filters.FilterFactory, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap, user_defined_name: str) -> pyrosetta.rosetta.protocols.filters.Filter

return new Filter by Tag parsing; the identifying string for the Filter is in the Tag

C++: protocols::filters::FilterFactory::newFilter(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &, std::string) const –> class std::shared_ptr<class protocols::filters::Filter>

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.FilterFactory, filter_name: str, xsd: utility::tag::XMLSchemaDefinition) → None¶

Get the XML schema for a given filter.

Throws an error if the filter is unknown to Rosetta.

Vikram K. Mulligan (vmullig.edu)

C++: protocols::filters::FilterFactory::provide_xml_schema(const std::string &, class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.FilterValueMetric¶

Bases: RealMetric

Convert the result of a Filter’s report_sm() to a SimpleMetric This is intended primarily as a compatibility shim class for making old code compatible. It’s not really intended to be used for new work - write a SimpleMetric directly.

apply(*args, **kwargs)¶

Overloaded function.

apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose) -> None
apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, prefix: str) -> None
apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, prefix: str, suffix: str) -> None
apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, prefix: str, suffix: str, override_existing_data: bool) -> None
apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, out_label: str, pose: pyrosetta.rosetta.core.pose.Pose) -> None
apply(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, out_label: str, pose: pyrosetta.rosetta.core.pose.Pose, override_existing_data: bool) -> None

Calculate the metric and add it to the pose as a score.

labeled as out_label.

Score is added to the SimpleMetricData cache: Data is output into the final score file, but can be accessed if needed through the cache.

C++: core::simple_metrics::RealMetric::apply(const std::string &, class core::pose::Pose &, bool) const –> void

assign(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric, : pyrosetta.rosetta.protocols.filters.FilterValueMetric) → pyrosetta.rosetta.protocols.filters.FilterValueMetric¶: C++: protocols::filters::FilterValueMetric::operator=(const class protocols::filters::FilterValueMetric &) –> class protocols::filters::FilterValueMetric &

cached_calculate(*args, **kwargs)¶

Overloaded function.

cached_calculate(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, use_cache: bool) -> float
cached_calculate(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, use_cache: bool, prefix: str) -> float
cached_calculate(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, use_cache: bool, prefix: str, suffix: str) -> float
cached_calculate(self: pyrosetta.rosetta.core.simple_metrics.RealMetric, pose: pyrosetta.rosetta.core.pose.Pose, use_cache: bool, prefix: str, suffix: str, fail_on_missing_cache: bool) -> float

Grab the data from the pose if it exists or calculate the metric

If use_cache is true, we will attempt to pull the data from the pose. If fail_on_missing_cache is true, we will fail, otherwise, we will calculate the metric.

This function is meant to support caching metrics, so values do not need to be calculated twice,
for example in SimpleMetricFilter/Features or code-wise where data takes a while to calculate and can be reused.

C++: core::simple_metrics::RealMetric::cached_calculate(const class core::pose::Pose &, bool, std::string, std::string, bool) const –> double

calculate(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric, pose: pyrosetta.rosetta.core.pose.Pose) → float¶

Calculate the metric.

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

clone(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric) → pyrosetta.rosetta.core.simple_metrics.SimpleMetric¶: C++: protocols::filters::FilterValueMetric::clone() const –> class std::shared_ptr<class core::simple_metrics::SimpleMetric>

static complex_type_generator_for_simple_metric(: utility::tag::XMLSchemaDefinition) → utility::tag::XMLSchemaComplexTypeGenerator¶: C++: core::simple_metrics::SimpleMetric::complex_type_generator_for_simple_metric(class utility::tag::XMLSchemaDefinition &) –> class std::shared_ptr<class utility::tag::XMLSchemaComplexTypeGenerator>

get_custom_type(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric) → str¶

Output data name will be prefix+custom_type+type+suffix

C++: core::simple_metrics::SimpleMetric::get_custom_type() const –> std::string

get_final_sm_type(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric) → str¶

Get the final name of this metric including its simple_metric_type_ name and any set custom type.

C++: core::simple_metrics::SimpleMetric::get_final_sm_type() const –> std::string

get_metric_names(self: pyrosetta.rosetta.core.simple_metrics.RealMetric) → pyrosetta.rosetta.utility.vector1_std_string¶

Get the metric name(s) that this Metric will calculate

C++: core::simple_metrics::RealMetric::get_metric_names() const –> class utility::vector1<std::string, class std::allocator<std::string > >

metric(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric) → str¶

Name of the metric

C++: protocols::filters::FilterValueMetric::metric() const –> std::string

name(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric) → str¶

Name of the class

C++: protocols::filters::FilterValueMetric::name() const –> std::string

static name_static() → str¶

Name of the class for creator.

C++: protocols::filters::FilterValueMetric::name_static() –> std::string

parse_base_tag(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric, tag: utility::tag::Tag) → None¶

Parse the base class tag. Keep required interface for parse_my_tag.

C++: core::simple_metrics::SimpleMetric::parse_base_tag(class std::shared_ptr<const class utility::tag::Tag>) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.FilterValueMetric, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

called by parse_my_tag – should not be used directly

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

provide_citation_info(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric, : 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 simple metrics wishing to provide citation information.

C++: core::simple_metrics::SimpleMetric::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::FilterValueMetric::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

set_custom_type(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric, custom_type: str) → None¶: C++: core::simple_metrics::SimpleMetric::set_custom_type(const std::string &) –> void

simple_metric_type(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric) → str¶: C++: core::simple_metrics::SimpleMetric::simple_metric_type() const –> std::string

class pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator¶

Bases: SimpleMetricCreator

assign(self: pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator, : pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator) → pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator¶: C++: protocols::filters::FilterValueMetricCreator::operator=(const class protocols::filters::FilterValueMetricCreator &) –> class protocols::filters::FilterValueMetricCreator &

create_simple_metric(self: pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator) → pyrosetta.rosetta.core.simple_metrics.SimpleMetric¶

Instantiate a particular SimpleMetric

C++: protocols::filters::FilterValueMetricCreator::create_simple_metric() const –> class std::shared_ptr<class core::simple_metrics::SimpleMetric>

keyname(self: pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator) → str¶

Return a string that will be used to instantiate the particular SimpleMetric

C++: protocols::filters::FilterValueMetricCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.FilterValueMetricCreator, : utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::FilterValueMetricCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.IfThenFilter¶

Bases: Filter

Evaluate to a value contingent on the evaluation of another filter.

add_condition(*args, **kwargs)¶

Overloaded function.

add_condition(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, testfilter: pyrosetta.rosetta.protocols.filters.Filter, valuefilter: pyrosetta.rosetta.protocols.filters.Filter) -> None
add_condition(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, testfilter: pyrosetta.rosetta.protocols.filters.Filter, valuefilter: pyrosetta.rosetta.protocols.filters.Filter, value: float) -> None
add_condition(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, testfilter: pyrosetta.rosetta.protocols.filters.Filter, valuefilter: pyrosetta.rosetta.protocols.filters.Filter, value: float, invert: bool) -> None
add_condition(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, testfilter: pyrosetta.rosetta.protocols.filters.Filter, valuefilter: pyrosetta.rosetta.protocols.filters.Filter, value: float, invert: bool, weight: float) -> None

Add a condition to the test.: If testfilter evaluates true, then this filter evaluates to valuefilter. If valuefilter is NULL, then return value instead. Conditions are evaluated in the order they were added.

C++: protocols::filters::IfThenFilter::add_condition(class std::shared_ptr<const class protocols::filters::Filter>, class std::shared_ptr<const class protocols::filters::Filter>, double, bool, double) –> void

apply(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::IfThenFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::IfThenFilter::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.filters.IfThenFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::IfThenFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::IfThenFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.IfThenFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::IfThenFilter::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.filters.IfThenFilter) → str¶: C++: protocols::filters::IfThenFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::IfThenFilter::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::filters::IfThenFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::IfThenFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::IfThenFilter::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_else(*args, **kwargs)¶

Overloaded function.

set_else(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, elsefilter: pyrosetta.rosetta.protocols.filters.Filter) -> None
set_else(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, elsefilter: pyrosetta.rosetta.protocols.filters.Filter, value: float) -> None
set_else(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, elsefilter: pyrosetta.rosetta.protocols.filters.Filter, value: float, elseweight: float) -> None

Add evaluation if no conditions trigger: If elsefilter is Null, use absolute value value instead.

C++: protocols::filters::IfThenFilter::set_else(class std::shared_ptr<const class protocols::filters::Filter>, double, double) –> void

set_lower_threshold(*args, **kwargs)¶

Overloaded function.

set_lower_threshold(self: pyrosetta.rosetta.protocols.filters.IfThenFilter) -> None
set_lower_threshold(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, floor: bool) -> None

Set if threshold is an upper (false/default) or lower (true) limit

C++: protocols::filters::IfThenFilter::set_lower_threshold(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

threshold(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, threshold: float) → None¶: C++: protocols::filters::IfThenFilter::threshold(double) –> void

class pyrosetta.rosetta.protocols.filters.IfThenFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.IfThenFilterCreator, : pyrosetta.rosetta.protocols.filters.IfThenFilterCreator) → pyrosetta.rosetta.protocols.filters.IfThenFilterCreator¶: C++: protocols::filters::IfThenFilterCreator::operator=(const class protocols::filters::IfThenFilterCreator &) –> class protocols::filters::IfThenFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.IfThenFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::IfThenFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.IfThenFilterCreator) → str¶: C++: protocols::filters::IfThenFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.IfThenFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::IfThenFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.MoveBeforeFilter¶

Bases: Filter

Apply a sub-mover prior to calculating a filter value

apply(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::MoveBeforeFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::MoveBeforeFilter::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.filters.MoveBeforeFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::MoveBeforeFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::MoveBeforeFilter::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.filters.MoveBeforeFilter) → str¶: C++: protocols::filters::MoveBeforeFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::MoveBeforeFilter::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::filters::MoveBeforeFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::MoveBeforeFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, : pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::MoveBeforeFilter::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.filters.MoveBeforeFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator, : pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator) → pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator¶: C++: protocols::filters::MoveBeforeFilterCreator::operator=(const class protocols::filters::MoveBeforeFilterCreator &) –> class protocols::filters::MoveBeforeFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::MoveBeforeFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator) → str¶: C++: protocols::filters::MoveBeforeFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::MoveBeforeFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.ReplicateFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::ReplicateFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::ReplicateFilter::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.filters.ReplicateFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ReplicateFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::ReplicateFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ReplicateFilter::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

median(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, median: bool) → None¶: C++: protocols::filters::ReplicateFilter::median(bool) –> void

name(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter) → str¶: C++: protocols::filters::ReplicateFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::ReplicateFilter::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::filters::ReplicateFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::ReplicateFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::ReplicateFilter::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

subfilter(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, subfilter: pyrosetta.rosetta.protocols.filters.Filter) → None¶: C++: protocols::filters::ReplicateFilter::subfilter(class std::shared_ptr<class protocols::filters::Filter>) –> void

threshold(self: pyrosetta.rosetta.protocols.filters.ReplicateFilter, threshold: float) → None¶: C++: protocols::filters::ReplicateFilter::threshold(double) –> void

class pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator, : pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator) → pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator¶: C++: protocols::filters::ReplicateFilterCreator::operator=(const class protocols::filters::ReplicateFilterCreator &) –> class protocols::filters::ReplicateFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::ReplicateFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator) → str¶: C++: protocols::filters::ReplicateFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.ReplicateFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::ReplicateFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.StochasticFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.StochasticFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::StochasticFilter::apply(const class core::pose::Pose &) const –> bool

calculate(self: pyrosetta.rosetta.protocols.filters.StochasticFilter) → bool¶: C++: protocols::filters::StochasticFilter::calculate() const –> bool

static class_name() → str¶: C++: protocols::filters::StochasticFilter::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.filters.StochasticFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::StochasticFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

confidence(self: pyrosetta.rosetta.protocols.filters.StochasticFilter) → float¶

The confidence is the fraction of the time the Filter will return true

C++: protocols::filters::StochasticFilter::confidence() const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.StochasticFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::StochasticFilter::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.filters.StochasticFilter) → str¶: C++: protocols::filters::StochasticFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.StochasticFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::StochasticFilter::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::filters::StochasticFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.StochasticFilter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶

If subfilter is set, use it’s report, otherwise use the base class’s

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

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

If subfilter is set, use it’s report_sm, otherwise use the base class’s

C++: protocols::filters::StochasticFilter::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

subfilter(self: pyrosetta.rosetta.protocols.filters.StochasticFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::StochasticFilter::subfilter() const –> class std::shared_ptr<const class protocols::filters::Filter>

class pyrosetta.rosetta.protocols.filters.StochasticFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.StochasticFilterCreator, : pyrosetta.rosetta.protocols.filters.StochasticFilterCreator) → pyrosetta.rosetta.protocols.filters.StochasticFilterCreator¶: C++: protocols::filters::StochasticFilterCreator::operator=(const class protocols::filters::StochasticFilterCreator &) –> class protocols::filters::StochasticFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.StochasticFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::StochasticFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.StochasticFilterCreator) → str¶: C++: protocols::filters::StochasticFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.StochasticFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::StochasticFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.TimeFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.TimeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::TimeFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::TimeFilter::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.filters.TimeFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TimeFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

compute(self: pyrosetta.rosetta.protocols.filters.TimeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::TimeFilter::compute(const class core::pose::Pose &) const –> double

fresh_instance(self: pyrosetta.rosetta.protocols.filters.TimeFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TimeFilter::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.filters.TimeFilter) → str¶: C++: protocols::filters::TimeFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.TimeFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::TimeFilter::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::filters::TimeFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.TimeFilter, out: pyrosetta.rosetta.std.ostream, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::TimeFilter::report(std::ostream &, const class core::pose::Pose &) const –> void

report_sm(self: pyrosetta.rosetta.protocols.filters.TimeFilter, pose: pyrosetta.rosetta.core.pose.Pose) → float¶: C++: protocols::filters::TimeFilter::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.filters.TimeFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.TimeFilterCreator, : pyrosetta.rosetta.protocols.filters.TimeFilterCreator) → pyrosetta.rosetta.protocols.filters.TimeFilterCreator¶: C++: protocols::filters::TimeFilterCreator::operator=(const class protocols::filters::TimeFilterCreator &) –> class protocols::filters::TimeFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.TimeFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TimeFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.TimeFilterCreator) → str¶: C++: protocols::filters::TimeFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.TimeFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::TimeFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.TrueFalseFilter¶

Bases: Filter

A filter that can be set to either return true or false - useful in RS.

apply(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::TrueFalseFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::TrueFalseFilter::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.filters.TrueFalseFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFalseFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFalseFilter::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.filters.TrueFalseFilter) → str¶: C++: protocols::filters::TrueFalseFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::TrueFalseFilter::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::filters::TrueFalseFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::Filter::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_action(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilter, action: bool) → None¶

Set the action that this filter will return.

C++: protocols::filters::TrueFalseFilter::set_action(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.filters.TrueFalseFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator, : pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator) → pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator¶: C++: protocols::filters::TrueFalseFilterCreator::operator=(const class protocols::filters::TrueFalseFilterCreator &) –> class protocols::filters::TrueFalseFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFalseFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator) → str¶: C++: protocols::filters::TrueFalseFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.TrueFalseFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::TrueFalseFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.TrueFilter¶

Bases: Filter

apply(self: pyrosetta.rosetta.protocols.filters.TrueFilter, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::TrueFilter::apply(const class core::pose::Pose &) const –> bool

static class_name() → str¶: C++: protocols::filters::TrueFilter::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.filters.TrueFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFilter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.TrueFilter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFilter::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.filters.TrueFilter) → str¶: C++: protocols::filters::TrueFilter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.TrueFilter, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::filters::TrueFilter::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::filters::TrueFilter::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

report(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::Filter::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_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.filters.TrueFilterCreator¶

Bases: FilterCreator

assign(self: pyrosetta.rosetta.protocols.filters.TrueFilterCreator, : pyrosetta.rosetta.protocols.filters.TrueFilterCreator) → pyrosetta.rosetta.protocols.filters.TrueFilterCreator¶: C++: protocols::filters::TrueFilterCreator::operator=(const class protocols::filters::TrueFilterCreator &) –> class protocols::filters::TrueFilterCreator &

create_filter(self: pyrosetta.rosetta.protocols.filters.TrueFilterCreator) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::TrueFilterCreator::create_filter() const –> class std::shared_ptr<class protocols::filters::Filter>

keyname(self: pyrosetta.rosetta.protocols.filters.TrueFilterCreator) → str¶: C++: protocols::filters::TrueFilterCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.filters.TrueFilterCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::filters::TrueFilterCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.filters.VectorPoseFilter¶

Bases: Filter

Designates a filter that can be passed multiple poses by the VectorPoseJobDistributor Any filters deriving from this subclass can then act on all of the input poses simultaneously Only accessible through recon application.

apply(self: pyrosetta.rosetta.protocols.filters.VectorPoseFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: protocols::filters::VectorPoseFilter::apply(const class core::pose::Pose &) const –> bool

apply_mpi(self: pyrosetta.rosetta.protocols.filters.VectorPoseFilter, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Apply function to run under MPI

C++: protocols::filters::VectorPoseFilter::apply_mpi(const class core::pose::Pose &) const –> bool

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.filters.Filter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::Filter::clone() const –> class std::shared_ptr<class protocols::filters::Filter>

fresh_instance(self: pyrosetta.rosetta.protocols.filters.Filter) → pyrosetta.rosetta.protocols.filters.Filter¶: C++: protocols::filters::Filter::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.filters.Filter) → str¶: C++: protocols::filters::Filter::name() const –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by FilterFactory when constructing new Filter. Takes care of the specific mover’s parsing.

C++: protocols::filters::Filter::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

report(self: pyrosetta.rosetta.protocols.filters.Filter, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::filters::Filter::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_poses(self: pyrosetta.rosetta.protocols.filters.VectorPoseFilter, poses: pyrosetta.rosetta.utility.vector1_std_shared_ptr_core_pose_Pose_t) → None¶

Set the vector of poses for the mover to act upon

C++: protocols::filters::VectorPoseFilter::set_poses(const class utility::vector1<class std::shared_ptr<class core::pose::Pose>, class std::allocator<class std::shared_ptr<class core::pose::Pose> > > &) –> 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.filters.boolean_operations¶

Bases: pybind11_object

Members:

AND

OR

XOR

NOR

NAND

ORNOT

ANDNOT

NOT

AND = <boolean_operations.AND: 1>¶

ANDNOT = <boolean_operations.ANDNOT: 7>¶

NAND = <boolean_operations.NAND: 5>¶

NOR = <boolean_operations.NOR: 4>¶

NOT = <boolean_operations.NOT: 8>¶

OR = <boolean_operations.OR: 2>¶

ORNOT = <boolean_operations.ORNOT: 6>¶

XOR = <boolean_operations.XOR: 3>¶

property name¶

property value¶

pyrosetta.rosetta.protocols.filters.complex_type_name_for_filter(filter_name: str) → str¶: C++: protocols::filters::complex_type_name_for_filter(const std::string &) –> std::string

pyrosetta.rosetta.protocols.filters.create_compound_statement_from_logic(name: str, data: pyrosetta.rosetta.basic.datacache.DataMap) → pyrosetta.rosetta.std.vector_std_pair_std_shared_ptr_protocols_filters_Filter_protocols_filters_boolean_operations_t¶: C++: protocols::filters::create_compound_statement_from_logic(const std::string &, const class basic::datacache::DataMap &) –> class std::vector<struct std::pair<class std::shared_ptr<class protocols::filters::Filter>, enum protocols::filters::boolean_operations>, class std::allocator<struct std::pair<class std::shared_ptr<class protocols::filters::Filter>, enum protocols::filters::boolean_operations> > >

pyrosetta.rosetta.protocols.filters.parse_filter_with_logic(name: str, data: pyrosetta.rosetta.basic.datacache.DataMap) → pyrosetta.rosetta.protocols.filters.Filter¶

Parses a name and splits it into a basic CompoundFilter OR returns the found filter.

C++: protocols::filters::parse_filter_with_logic(const std::string &, const class basic::datacache::DataMap &) –> class std::shared_ptr<class protocols::filters::Filter>

pyrosetta.rosetta.protocols.filters.xsd_type_definition_w_attributes(xsd: utility::tag::XMLSchemaDefinition, filter_type: str, description: str, attributes: pyrosetta.rosetta.std.list_utility_tag_XMLSchemaAttribute_t) → None¶

Define the XML schema definition for a Filter that: contains no subtags but may contain any number of attributes (aka options).

C++: protocols::filters::xsd_type_definition_w_attributes(class utility::tag::XMLSchemaDefinition &, const std::string &, const std::string &, const class std::list<class utility::tag::XMLSchemaAttribute, class std::allocator<class utility::tag::XMLSchemaAttribute> > &) –> void

pyrosetta.rosetta.protocols.filters.xsd_type_definition_w_attributes_and_repeatable_subelements(xsd: utility::tag::XMLSchemaDefinition, filter_type: str, description: str, attributes: pyrosetta.rosetta.std.list_utility_tag_XMLSchemaAttribute_t, subelements: utility::tag::XMLSchemaSimpleSubelementList) → None¶: C++: protocols::filters::xsd_type_definition_w_attributes_and_repeatable_subelements(class utility::tag::XMLSchemaDefinition &, const std::string &, const std::string &, const class std::list<class utility::tag::XMLSchemaAttribute, class std::allocator<class utility::tag::XMLSchemaAttribute> > &, const class utility::tag::XMLSchemaSimpleSubelementList &) –> void