metrics

Bindings for core::pose::metrics namespace

class pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer

Bases: pybind11_builtins.pybind11_object

container for managing PoseMetricCalculators

Attaches to a Pose and listens to Pose signals.
It then notifies stored PoseMetricCalculators to recalculate as-needed.
assign(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, src: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer) → pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer

copy assignment

container keeps observing whatever Pose it was originally observing

C++: core::pose::metrics::PoseMetricContainer::operator=(const class core::pose::metrics::PoseMetricContainer &) –> class core::pose::metrics::PoseMetricContainer &

attach_to(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, pose: pyrosetta.rosetta.core.pose.Pose) → None

attach to a Pose

C++: core::pose::metrics::PoseMetricContainer::attach_to(class core::pose::Pose &) –> void

clear(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer) → None

clear the list of metric calculators, reset flags

C++: core::pose::metrics::PoseMetricContainer::clear() –> void

detach_from(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer) → None

detach from Pose

C++: core::pose::metrics::PoseMetricContainer::detach_from() –> void

get(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, calculator_name: str, key: str, val: pyrosetta.rosetta.basic.MetricValueBase, this_pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: core::pose::metrics::PoseMetricContainer::get(const class std::basic_string<char> &, const class std::basic_string<char> &, class basic::MetricValueBase &, const class core::pose::Pose &) –> void

is_observing(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer) → pyrosetta.rosetta.core.pose.Pose

is observing a Pose?

the Pose if observing, otherwise NULL

C++: core::pose::metrics::PoseMetricContainer::is_observing() –> const class core::pose::Pose *

on_pose_conf_change(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, event: core::pose::signals::ConformationEvent) → None
upon receiving pose::signals::ConformationEvent, sets flag telling
calculators to refresh structure based calculations

C++: core::pose::metrics::PoseMetricContainer::on_pose_conf_change(const struct core::pose::signals::ConformationEvent &) –> void

on_pose_destruction_change(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, event: core::pose::signals::DestructionEvent) → None

upon receiving a pose::signals::DestructionEvent, detaches

C++: core::pose::metrics::PoseMetricContainer::on_pose_destruction_change(const struct core::pose::signals::DestructionEvent &) –> void

on_pose_energy_change(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, event: core::pose::signals::EnergyEvent) → None
upon receiving a pose:signals::EnergyEvent, sets flag telling
calculators to refresh energy based calculations

C++: core::pose::metrics::PoseMetricContainer::on_pose_energy_change(const struct core::pose::signals::EnergyEvent &) –> void

print(self: pyrosetta.rosetta.core.pose.metrics.PoseMetricContainer, calculator_name: str, key: str, this_pose: pyrosetta.rosetta.core.pose.Pose) → str

return a string with the results of a PoseMetricCalculator

C++: core::pose::metrics::PoseMetricContainer::print(const class std::basic_string<char> &, const class std::basic_string<char> &, const class core::pose::Pose &) –> std::string