rosetta.core.pose.metrics
index
(built-in)

Bindings for core::pose::metrics namespace

 
Modules
       
rosetta.core.pose.metrics.simple_calculators

 
Classes
       
builtins.object
CalculatorFactory
PoseMetricCalculator
EnergyDependentCalculator
StructureDependentCalculator
PoseMetricContainer

 
class CalculatorFactory(builtins.object)
     Methods defined here:
Instance(...) from builtins.PyCapsule
Instance() -> rosetta.core.pose.metrics.CalculatorFactory
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
check_calculator_exists(...) from builtins.PyCapsule
check_calculator_exists(self : rosetta.core.pose.metrics.CalculatorFactory, calculator_name : str) -> bool
clear_calculators(...) from builtins.PyCapsule
clear_calculators(rosetta.core.pose.metrics.CalculatorFactory) -> bool
 
clear all calculators from factory
 
 
 false if no calculators in list, true otherwise
register_calculator(...) from builtins.PyCapsule
register_calculator(self : rosetta.core.pose.metrics.CalculatorFactory, calculator_name : str, new_calculator : rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType
remove_calculator(...) from builtins.PyCapsule
remove_calculator(self : rosetta.core.pose.metrics.CalculatorFactory, calculator_name : str) -> bool
 
remove a calculator from the factory
 
 
 true if calculator removed, false if no such calculator
retrieve_calculator(...) from builtins.PyCapsule
retrieve_calculator(self : rosetta.core.pose.metrics.CalculatorFactory, calculator_name : str) -> rosetta.core.pose.metrics.PoseMetricCalculator

 
class EnergyDependentCalculator(PoseMetricCalculator)
    
Method resolution order:
EnergyDependentCalculator
PoseMetricCalculator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.pose.metrics.EnergyDependentCalculator) -> NoneType
 
2. __init__(rosetta.core.pose.metrics.EnergyDependentCalculator, rosetta.core.pose.metrics.EnergyDependentCalculator) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.core.pose.metrics.EnergyDependentCalculator,  : rosetta.core.pose.metrics.EnergyDependentCalculator) -> rosetta.core.pose.metrics.EnergyDependentCalculator
get(...) from builtins.PyCapsule
get(*args, **kwargs)
Overloaded function.
 
1. get(self : rosetta.core.pose.metrics.EnergyDependentCalculator, key : str, val : rosetta.basic.MetricValueBase, this_pose : rosetta.core.pose.Pose) -> NoneType
 
2. get(self : rosetta.core.pose.metrics.EnergyDependentCalculator, key : str, this_pose : rosetta.core.pose.Pose) -> str
notify_energy_change(...) from builtins.PyCapsule
notify_energy_change(rosetta.core.pose.metrics.EnergyDependentCalculator) -> NoneType

Methods inherited from PoseMetricCalculator:
clone(...) from builtins.PyCapsule
clone(rosetta.core.pose.metrics.PoseMetricCalculator) -> rosetta.core.pose.metrics.PoseMetricCalculator
notify_structure_change(...) from builtins.PyCapsule
notify_structure_change(rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType

 
class PoseMetricCalculator(builtins.object)
     Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType
 
2. __init__(rosetta.core.pose.metrics.PoseMetricCalculator, rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.core.pose.metrics.PoseMetricCalculator,  : rosetta.core.pose.metrics.PoseMetricCalculator) -> rosetta.core.pose.metrics.PoseMetricCalculator
clone(...) from builtins.PyCapsule
clone(rosetta.core.pose.metrics.PoseMetricCalculator) -> rosetta.core.pose.metrics.PoseMetricCalculator
get(...) from builtins.PyCapsule
get(*args, **kwargs)
Overloaded function.
 
1. get(self : rosetta.core.pose.metrics.PoseMetricCalculator, key : str, val : rosetta.basic.MetricValueBase, this_pose : rosetta.core.pose.Pose) -> NoneType
 
2. get(self : rosetta.core.pose.metrics.PoseMetricCalculator, key : str, this_pose : rosetta.core.pose.Pose) -> str
notify_energy_change(...) from builtins.PyCapsule
notify_energy_change(rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType
notify_structure_change(...) from builtins.PyCapsule
notify_structure_change(rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType

 
class PoseMetricContainer(builtins.object)
    container for managing PoseMetricCalculators
 
 
Attaches to a Pose and listens to Pose signals.
 It then notifies stored PoseMetricCalculators to recalculate as-needed.
 
  Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.pose.metrics.PoseMetricContainer) -> NoneType
 
2. __init__(self : rosetta.core.pose.metrics.PoseMetricContainer, src : rosetta.core.pose.metrics.PoseMetricContainer) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.core.pose.metrics.PoseMetricContainer, src : rosetta.core.pose.metrics.PoseMetricContainer) -> rosetta.core.pose.metrics.PoseMetricContainer
 
copy assignment
 
 
 container keeps observing whatever Pose it was originally observing
attach_to(...) from builtins.PyCapsule
attach_to(self : rosetta.core.pose.metrics.PoseMetricContainer, pose : rosetta.core.pose.Pose) -> NoneType
 
attach to a Pose
clear(...) from builtins.PyCapsule
clear(rosetta.core.pose.metrics.PoseMetricContainer) -> NoneType
 
clear the list of metric calculators, reset flags
detach_from(...) from builtins.PyCapsule
detach_from(rosetta.core.pose.metrics.PoseMetricContainer) -> NoneType
 
detach from Pose
get(...) from builtins.PyCapsule
get(self : rosetta.core.pose.metrics.PoseMetricContainer, calculator_name : str, key : str, val : rosetta.basic.MetricValueBase, this_pose : rosetta.core.pose.Pose) -> NoneType
is_observing(...) from builtins.PyCapsule
is_observing(rosetta.core.pose.metrics.PoseMetricContainer) -> rosetta.core.pose.Pose
 
is observing a Pose?
 
 
 the Pose if observing, otherwise NULL
on_pose_conf_change(...) from builtins.PyCapsule
on_pose_conf_change(self : rosetta.core.pose.metrics.PoseMetricContainer, event : core::pose::signals::ConformationEvent) -> NoneType
 
upon receiving pose::signals::ConformationEvent, sets flag telling
  calculators to refresh structure based calculations
on_pose_destruction_change(...) from builtins.PyCapsule
on_pose_destruction_change(self : rosetta.core.pose.metrics.PoseMetricContainer, event : core::pose::signals::DestructionEvent) -> NoneType
 
upon receiving a pose::signals::DestructionEvent, detaches
on_pose_energy_change(...) from builtins.PyCapsule
on_pose_energy_change(self : rosetta.core.pose.metrics.PoseMetricContainer, event : core::pose::signals::EnergyEvent) -> NoneType
 
upon receiving a pose:signals::EnergyEvent, sets flag telling
  calculators to refresh energy based calculations
print(...) from builtins.PyCapsule
print(self : rosetta.core.pose.metrics.PoseMetricContainer, calculator_name : str, key : str, this_pose : rosetta.core.pose.Pose) -> str
 
return a string with the results of a PoseMetricCalculator

 
class StructureDependentCalculator(PoseMetricCalculator)
    
Method resolution order:
StructureDependentCalculator
PoseMetricCalculator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(rosetta.core.pose.metrics.StructureDependentCalculator) -> NoneType
 
2. __init__(rosetta.core.pose.metrics.StructureDependentCalculator, rosetta.core.pose.metrics.StructureDependentCalculator) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.core.pose.metrics.StructureDependentCalculator,  : rosetta.core.pose.metrics.StructureDependentCalculator) -> rosetta.core.pose.metrics.StructureDependentCalculator
get(...) from builtins.PyCapsule
get(*args, **kwargs)
Overloaded function.
 
1. get(self : rosetta.core.pose.metrics.StructureDependentCalculator, key : str, val : rosetta.basic.MetricValueBase, this_pose : rosetta.core.pose.Pose) -> NoneType
 
2. get(self : rosetta.core.pose.metrics.StructureDependentCalculator, key : str, this_pose : rosetta.core.pose.Pose) -> str
notify_structure_change(...) from builtins.PyCapsule
notify_structure_change(rosetta.core.pose.metrics.StructureDependentCalculator) -> NoneType

Methods inherited from PoseMetricCalculator:
clone(...) from builtins.PyCapsule
clone(rosetta.core.pose.metrics.PoseMetricCalculator) -> rosetta.core.pose.metrics.PoseMetricCalculator
notify_energy_change(...) from builtins.PyCapsule
notify_energy_change(rosetta.core.pose.metrics.PoseMetricCalculator) -> NoneType