burial_metrics

Bindings for protocols::analysis::burial_metrics namespace

class pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric

Bases: pyrosetta.rosetta.core.simple_metrics.StringMetric

A string metric that generates a string of PyMol commands to colour a structure’s polar groups based on burial.

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.core.simple_metrics.StringMetric, pose: pyrosetta.rosetta.core.pose.Pose) -> None
  2. apply(self: pyrosetta.rosetta.core.simple_metrics.StringMetric, pose: pyrosetta.rosetta.core.pose.Pose, prefix: str) -> None
  3. apply(self: pyrosetta.rosetta.core.simple_metrics.StringMetric, pose: pyrosetta.rosetta.core.pose.Pose, prefix: str, suffix: str) -> None
Calculate the metric and add it to the pose as a score.
labeled as prefix+metric+suffix.
Score is added through setPoseExtraScore and is output
into the score table/ score file at pose output.

C++: core::simple_metrics::StringMetric::apply(class core::pose::Pose &, class std::basic_string<char>, class std::basic_string<char>) const –> void

assign(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric, : pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric) → pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::operator=(const class protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric &) –> class protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric &

calculate(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric, original_pose: pyrosetta.rosetta.core.pose.Pose) → str

Calculate the metric.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::calculate(const class core::pose::Pose &) const –> std::string

clone(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric) → pyrosetta.rosetta.core.simple_metrics.SimpleMetric

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::clone() const –> class std::shared_ptr<class core::simple_metrics::SimpleMetric>

get_metric_names(self: pyrosetta.rosetta.core.simple_metrics.StringMetric) → pyrosetta.rosetta.utility.vector1_std_string

Get the metric name that this Metric will calculate

C++: core::simple_metrics::StringMetric::get_metric_names() const –> class utility::vector1<std::string, class std::allocator<std::string > >

metric(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric) → str

Name (descriptive) of the metric.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::metric() const –> std::string

name(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric) → str

Name of the class

Calls name_static().

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::name() const –> std::string

name_static() → str

Name of the class for creator.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::name_static() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None

Given an XML tag, configure an instance of this class.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_xml_schema(xsd: pyrosetta.rosetta.utility.tag.XMLSchemaDefinition) → None

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

set_scorefxn(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric, sfxn_in: pyrosetta.rosetta.core.scoring.ScoreFunction) → None

Set the scorefunction.

Used for definition of burial. Input pointer is copied without cloning.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::set_scorefxn(class std::shared_ptr<const class core::scoring::ScoreFunction>) –> void

set_verbose(self: pyrosetta.rosetta.protocols.analysis.burial_metrics.PolarGroupBurialPyMolStringMetric, setting: bool) → None

Set whether this metric should also output to tracer when evaluated.

C++: protocols::analysis::burial_metrics::PolarGroupBurialPyMolStringMetric::set_verbose(const bool) –> void

type(self: pyrosetta.rosetta.core.simple_metrics.SimpleMetric) → str

C++: core::simple_metrics::SimpleMetric::type() const –> std::string