filters¶

Bindings for protocols::filters namespace

class pyrosetta.rosetta.protocols.filters.CombinedFilter¶

Bases: pyrosetta.rosetta.protocols.filters.Filter

Used to combine multiple seperate filters into a single filter value

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.protocols.filters.CombinedFilter) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.CombinedFilter, arg0: pyrosetta.rosetta.protocols.filters.CombinedFilter) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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

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

provide_xml_schema(xsd: pyrosetta.rosetta.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(class std::basic_ostream<char> &, 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 class std::basic_string<char> &) –> void

class pyrosetta.rosetta.protocols.filters.CompoundFilter¶

Bases: pyrosetta.rosetta.protocols.filters.Filter, pyrosetta.rosetta.protocols.moves.ResId

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

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.protocols.filters.CompoundFilter) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, : pyrosetta.rosetta.std.vector_std_pair_std_shared_ptr_protocols_filters_Filter_protocols_filters_boolean_operations_t) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, arg0: pyrosetta.rosetta.protocols.filters.CompoundFilter) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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 &

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) → int¶: C++: protocols::moves::ResId::get_resid() –> 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

provide_xml_schema(xsd: pyrosetta.rosetta.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(class std::basic_ostream<char> &, 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(self: pyrosetta.rosetta.protocols.filters.CompoundFilter, resid: int) → None¶: C++: protocols::filters::CompoundFilter::set_resid(const unsigned long) –> void

set_user_defined_name(self: pyrosetta.rosetta.protocols.filters.Filter, name: str) → None¶: C++: protocols::filters::Filter::set_user_defined_name(const class std::basic_string<char> &) –> void

class pyrosetta.rosetta.protocols.filters.FilterCollection¶

Bases: pybind11_builtins.pybind11_object

Wrapper-class that contains a vector1 of Filters

apply function returns true if all member filters return true

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.protocols.filters.FilterCollection) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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(class std::basic_ostream<char> &, 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_builtins.pybind11_object

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

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.protocols.filters.FilterCreator) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.FilterCreator, arg0: pyrosetta.rosetta.protocols.filters.FilterCreator) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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: pyrosetta.rosetta.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.IfThenFilter¶

Bases: pyrosetta.rosetta.protocols.filters.Filter

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

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.protocols.filters.IfThenFilter) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.IfThenFilter, arg0: pyrosetta.rosetta.protocols.filters.IfThenFilter) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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

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

provide_xml_schema(xsd: pyrosetta.rosetta.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(class std::basic_ostream<char> &, 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 class std::basic_string<char> &) –> void

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

class pyrosetta.rosetta.protocols.filters.MoveBeforeFilter¶

Bases: pyrosetta.rosetta.protocols.filters.Filter

Apply a sub-mover prior to calculating a filter value

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, mover: pyrosetta.rosetta.protocols.moves.Mover, filter: pyrosetta.rosetta.protocols.filters.Filter) -> None
__init__(self: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter, arg0: pyrosetta.rosetta.protocols.filters.MoveBeforeFilter) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

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

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

provide_xml_schema(xsd: pyrosetta.rosetta.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(class std::basic_ostream<char> &, 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 class std::basic_string<char> &) –> void

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

pyrosetta.rosetta.protocols.filters.xsd_type_definition_w_attributes(xsd: pyrosetta.rosetta.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 class std::basic_string<char> &, const class std::basic_string<char> &, 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: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition, filter_type: str, description: str, attributes: pyrosetta.rosetta.std.list_utility_tag_XMLSchemaAttribute_t, subelements: pyrosetta.rosetta.utility.tag.XMLSchemaSimpleSubelementList) → None¶: C++: protocols::filters::xsd_type_definition_w_attributes_and_repeatable_subelements(class utility::tag::XMLSchemaDefinition &, const class std::basic_string<char> &, const class std::basic_string<char> &, const class std::list<class utility::tag::XMLSchemaAttribute, class std::allocator<class utility::tag::XMLSchemaAttribute> > &, const class utility::tag::XMLSchemaSimpleSubelementList &) –> void