Rosetta: pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor Class Reference

Rosetta

Inheritance diagram for pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor:

Inheritance graph

[legend]

Public Member Functions
def	__init__ (self, pose)

def	all (self)

def	string (self)

def	real (self)

def	composite_string (self)

def	composite_real (self)

def	per_residue_string (self)

def	per_residue_real (self)

def	per_residue_probabilities (self)

def	clear (self)

Public Member Functions inherited from pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessorBase
def	__getitem__ (self, key)

def	__setitem__ (self, key, value)

def	__delitem__ (self, key)

def	format_composite_string (self, raw_data)

def	format_composite_real (self, raw_data)

def	format_per_residue_string (self, raw_data)

def	format_per_residue_real (self, raw_data)

def	format_per_residue_probabilities (self, raw_data)

Public Member Functions inherited from pyrosetta.bindings.scores.base.PoseCacheAccessorBase
def	apply (self, metric, key, value)

def	__len__ (self)

def	__iter__ (self)

def	__str__ (self)

Static Private Attributes
tuple	__slots__ = ("pose",)

Additional Inherited Members
Static Public Member Functions inherited from pyrosetta.bindings.scores.serialization.PoseScoreSerializer
def	maybe_encode (value)

def	maybe_decode (value)

Static Public Member Functions inherited from pyrosetta.bindings.scores.serialization.PoseScoreSerializerBase
def	to_pickle (value)

def	from_pickle (value)

def	to_base64 (value)

def	from_base64 (value)

def	to_base64_pickle (value)

def	from_base64_pickle (value)

def	bool_from_str (value)

Public Attributes inherited from pyrosetta.bindings.scores.base.PoseCacheAccessorBase
	pose

	custom_real_value_metric

	custom_string_value_metric

Detailed Description

Accessor wrapper for pose SimpleMetric data.

Constructor & Destructor Documentation

◆ init()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.__init__	(		self,
			pose
	)

Reimplemented from pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessorBase.

Referenced by pyrosetta.distributed.tasks.taskbase.TaskBase.__setstate__().

Member Function Documentation

◆ all()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all ( self )

Get all SimpleMetric data (with clobber warnings).

This method aims to mimic data override precedences used in the legacy `pose.scores` dictionary:
    1. `pose.energies().active_total_energies()`
    2. `ScoreMap.get_arbitrary_score_data_from_pose(pose)`
    3. `ScoreMap.get_arbitrary_string_data_from_pose(pose)`
Data override precedences as defined in `ScoreMap::add_arbitrary_score_data_from_pose`:
    1. Per-residue real metrics
    2. Composite real metrics
    3. Real metrics
Data override precedences as defined in `ScoreMap::add_arbitrary_string_data_from_pose`:
    1. Per-residue probabilities metrics
    2. Per-residue string metrics
    3. Composite string metrics
    4. String metrics

References pyrosetta.bindings.scores.base.PoseCacheAccessorBase._clobber_warning(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.composite_real(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.composite_string(), utility::options::FileOption.operator std::string(), ObjexxFCL::Fstring.operator std::string(), binder::Binder.operator std::string(), utility::file::FileName.operator std::string(), utility::file::PathName.operator std::string(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_probabilities(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_real(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_string(), pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessor.real(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.real(), detail::value< Context >.string, detail::value< format_context >.string, detail::value< basic_printf_context >.string, detail::value< basic_format_context >.string, detail::value< wformat_context >.string, pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessor.string(), and pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.string().

Referenced by pyrosetta.bindings.pose.PoseScoreAccessor.__getitem__(), pyrosetta.bindings.scores.core.PoseCacheAccessor.__getitem__(), pyrosetta.bindings.scores.energies.EnergiesAccessor.__getitem__(), pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessorBase.__getitem__(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessorBase.__getitem__(), pyrosetta.bindings.pose.PoseScoreAccessor.__iter__(), pyrosetta.bindings.scores.base.PoseCacheAccessorBase.__iter__(), pyrosetta.bindings.pose.PoseScoreAccessor.__len__(), pyrosetta.bindings.scores.base.PoseCacheAccessorBase.__len__(), pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessorBase.clear(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessorBase.clear(), pyrosetta.bindings.scores.simple_metrics.SimpleMetricStringDataAccessor.clear(), and pyrosetta.bindings.scores.simple_metrics.SimpleMetricRealDataAccessor.clear().

◆ clear()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.clear ( self )

Clear pose SimpleMetric data.

Reimplemented from pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessorBase.

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor.discard().

◆ composite_real()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.composite_real ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ composite_string()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.composite_string ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ per_residue_probabilities()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_probabilities ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ per_residue_real()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_real ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ per_residue_string()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.per_residue_string ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ real()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.real ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessor.all(), and pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

◆ string()

def pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.string ( self )

References PDB_IOBenchmark.pose, ScoreBenchmark.pose, ShearMoverBenchmark.pose, SmallMoverBenchmark.pose, SamplingManager.pose, apps::pilot::KicSandbox.pose, PoseAndData.pose, PoseWrap.pose, MatchBase.pose, MatchLig.pose, SlideTask.pose(), HIT.pose, WorkDat.pose, pyrosetta.bindings.pose.PoseResidueAccessor.pose, pyrosetta.bindings.pose.PoseResidueLabelAccessor.pose, pyrosetta.bindings.pose.PoseScoreAccessor.pose, pyrosetta.bindings.scores.base.PoseCacheAccessorBase.pose, ui::ui_core::pose_draw::SimplePoseDrawOpenGLWidget.pose(), pyrosetta.distributed.packed_pose.core.PackedPose.pose(), pyrosetta.tests.bindings.core.test_pose.TestPoseCacheAccessor.pose, test.T010_LoadPDB.LoadPDBTest.pose, and test.T300_PyJobDistributor.TestPyJobDistributor.pose.

Referenced by pyrosetta.bindings.scores.extra_scores.ExtraScoresAccessor.all(), and pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.all().

Member Data Documentation

◆ slots

tuple pyrosetta.bindings.scores.simple_metrics.SimpleMetricDataAccessor.__slots__ = ("pose",)

staticprivate

Referenced by pyrosetta.distributed.cluster.io.IO._get_instance_and_metadata().

The documentation for this class was generated from the following file:

src/python/PyRosetta/src/pyrosetta/bindings/scores/simple_metrics.py