job_summaries

Bindings for protocols::jd3::job_summaries namespace

class pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary

Bases: JobSummary

A JobSummary that simply stores the energy from a job.

assign(self: pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary, : pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary) → pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary

C++: protocols::jd3::job_summaries::EnergyJobSummary::operator=(const class protocols::jd3::job_summaries::EnergyJobSummary &) –> class protocols::jd3::job_summaries::EnergyJobSummary &

energy(*args, **kwargs)

Overloaded function.

  1. energy(self: pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary, setting: float) -> None

Set an energy of the job.

C++: protocols::jd3::job_summaries::EnergyJobSummary::energy(double) –> void

  1. energy(self: pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary) -> float

Get the energy stored in this JobSummary.

C++: protocols::jd3::job_summaries::EnergyJobSummary::energy() const –> double

extract_energy(self: pyrosetta.rosetta.protocols.jd3.job_summaries.EnergyJobSummary, pose: pyrosetta.rosetta.core.pose.Pose) → None

Extract the energy fromt the Energies object of the pose

C++: protocols::jd3::job_summaries::EnergyJobSummary::extract_energy(const class core::pose::Pose &) –> void

class pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary

Bases: JobSummary

A JobSummary that extracts the energy and SimpleMetricData from a pose. The Job object should score the pose and run any SimpleMetrics desired.

assign(self: pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary, : pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary) → pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary

C++: protocols::jd3::job_summaries::StandardPoseJobSummary::operator=(const class protocols::jd3::job_summaries::StandardPoseJobSummary &) –> class protocols::jd3::job_summaries::StandardPoseJobSummary &

energy(self: pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary) → float
Get the energy stored here.

If no energy has been set, the energy is 0.

C++: protocols::jd3::job_summaries::StandardPoseJobSummary::energy() const –> double

extract_summary(self: pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary, pose: pyrosetta.rosetta.core.pose.Pose) → None

  1. Extracts the energy from the Energies object

  1. Extract a clone of the SimpleMetricData from the pose.

C++: protocols::jd3::job_summaries::StandardPoseJobSummary::extract_summary(const class core::pose::Pose &) –> void

metric_data(self: pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary) → pyrosetta.rosetta.core.simple_metrics.SimpleMetricData
Get the SimpleMetric results.

If no simple_metrics have been run, this will be a nullptr.

C++: protocols::jd3::job_summaries::StandardPoseJobSummary::metric_data() const –> class std::shared_ptr<const class core::simple_metrics::SimpleMetricData>

set_energy(self: pyrosetta.rosetta.protocols.jd3.job_summaries.StandardPoseJobSummary, energy: float) → None

Set an arbitrary energy to use for the result.

C++: protocols::jd3::job_summaries::StandardPoseJobSummary::set_energy(double) –> void