methods¶

Bindings for core::scoring::methods namespace

class pyrosetta.rosetta.core.scoring.methods.BranchEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

BranchEnergy class iterates across all residues in finalize() and determines a penalty between residues i and i+1 across a cutpoint by how much their virtual atoms do not align.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.BranchEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy, : pyrosetta.rosetta.core.scoring.methods.BranchEnergy) → pyrosetta.rosetta.core.scoring.methods.BranchEnergy¶: C++: core::scoring::methods::BranchEnergy::operator=(const class core::scoring::methods::BranchEnergy &) –> class core::scoring::methods::BranchEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶: C++: core::scoring::methods::BranchEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Called during gradient-based minimization inside dfunc.

C++: core::scoring::methods::BranchEnergy::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, totals: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Called at the end of the energy evaluation.

C++: core::scoring::methods::BranchEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::BranchEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.BranchEnergy) → int¶: C++: core::scoring::methods::BranchEnergy::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.ContextIndependentLRTwoBodyEnergy

the energy method

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, options: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy) → pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy¶: C++: core::scoring::methods::CartesianBondedEnergy::operator=(const class core::scoring::methods::CartesianBondedEnergy &) –> class core::scoring::methods::CartesianBondedEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy) → float¶: C++: core::scoring::methods::CartesianBondedEnergy::atomic_interaction_cutoff() const –> double

backbone_backbone_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the backbone of rsd1 and the: backbone of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the weighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::backbone_backbone_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

backbone_sidechain_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the backbone of rsd1 and the: sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::backbone_sidechain_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

bump_energy_backbone(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::TwoBodyEnergy::bump_energy_backbone(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

bump_energy_full(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::TwoBodyEnergy::bump_energy_full(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

clone(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::CartesianBondedEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

defines_intrares_dof_derivatives(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: core::scoring::methods::CartesianBondedEnergy::defines_intrares_dof_derivatives(const class core::pose::Pose &) const –> bool

defines_intrares_energy(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.core.scoring.EMapVector) → bool¶: C++: core::scoring::methods::CartesianBondedEnergy::defines_intrares_energy(const class core::scoring::EMapVector &) const –> bool

defines_intrares_energy_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, res: pyrosetta.rosetta.core.conformation.Residue) → bool¶

If a score function defines no intra-residue scores for a particular: residue, then it may opt-out of being asked during minimization to evaluate the score for this residue.

C++: core::scoring::methods::TwoBodyEnergy::defines_intrares_energy_for_residue(const class core::conformation::Residue &) const –> bool

defines_residue_pair_energy(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, pose: pyrosetta.rosetta.core.pose.Pose, res1: int, res2: int) → bool¶: C++: core::scoring::methods::CartesianBondedEnergy::defines_residue_pair_energy(const class core::pose::Pose &, unsigned long, unsigned long) const –> bool

defines_score_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, res1: pyrosetta.rosetta.core.conformation.Residue, res2: pyrosetta.rosetta.core.conformation.Residue, res_moving_wrt_eachother: bool) → bool¶

During minimization, energy methods are allowed to decide that they say nothing: about a particular residue pair (e.g. no non-zero energy) and as a result they will not be queried for a derivative or an energy. The default implementation returns “true” for all residue pairs. Context-dependent two-body energies have the option of behaving as if they are context-independent by returning “false” for residue pairs that do no move wrt each other.

C++: core::scoring::methods::TwoBodyEnergy::defines_score_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, bool) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

eval_intrares_derivatives(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, res_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, weights: pyrosetta.rosetta.core.scoring.EMapVector, atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::eval_intrares_derivatives(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &) const –> void

eval_intrares_energy(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::eval_intrares_energy(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

eval_intrares_energy_ext(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the intra-residue energy for a given residue using the data held within the: ResSingleMinimizationData object. This function should be invoked only on derived instances of this class if they return “true” in a call to their use_extended_intrares_energy_interface method. This base class provides a noop implementation for classes that do not implement this interface, or that do not define intrares energies.

C++: core::scoring::methods::TwoBodyEnergy::eval_intrares_energy_ext(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

eval_intraresidue_dof_derivative(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, dof_id: pyrosetta.rosetta.core.id.DOF_ID, torsion_id: pyrosetta.rosetta.core.id.TorsionID, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector) → float¶: C++: core::scoring::methods::CartesianBondedEnergy::eval_intraresidue_dof_derivative(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::id::DOF_ID &, const class core::id::TorsionID &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &) const –> double

eval_residue_pair_derivatives(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, min_data: pyrosetta.rosetta.core.scoring.ResPairMinimizationData, : pyrosetta.rosetta.core.pose.Pose, weights: pyrosetta.rosetta.core.scoring.EMapVector, r1_atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair, r2_atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::eval_residue_pair_derivatives(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResPairMinimizationData &, const class core::pose::Pose &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &) const –> void

eval_residue_pair_derivatives_sorted(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, min_data: pyrosetta.rosetta.core.scoring.ResPairMinimizationData, : pyrosetta.rosetta.core.pose.Pose, weights: pyrosetta.rosetta.core.scoring.EMapVector, r1_atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair, r2_atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::eval_residue_pair_derivatives_sorted(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResPairMinimizationData &, const class core::pose::Pose &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &) const –> void

evaluate_rotamer_background_energies(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, residue: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, energy_vector: pyrosetta.rosetta.utility.vector1_float) → None¶

Batch computation of rotamer/background energies. Need not be overriden: in derived class – by default, iterates over all rotamers in the set, and calls derived class’s residue_pair_energy method for each one against the background rotamr

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_background_energies(const class core::conformation::RotamerSetBase &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class utility::vector1<float, class std::allocator<float> > &) const –> void

evaluate_rotamer_background_energy_maps(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, residue: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, emaps: pyrosetta.rosetta.utility.vector1_core_scoring_EMapVector) → None¶

Batch computation of rotamer/background energies. Need not be overriden: in derived class – by default, iterates over all rotamers in the set, and calls derived class’s residue_pair_energy method for each one against the background rotamr

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_background_energy_maps(const class core::conformation::RotamerSetBase &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::EMapVector, class std::allocator<class core::scoring::EMapVector> > &) const –> void

evaluate_rotamer_intrares_energies(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, energies: pyrosetta.rosetta.utility.vector1_float) → None¶

Batch computation of rotamer intrares energies. Need not be overriden in: derived class – by default, iterates over all rotamers, and calls derived class’s intrares _energy method.

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_intrares_energies(const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class utility::vector1<float, class std::allocator<float> > &) const –> void

evaluate_rotamer_intrares_energy_maps(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emaps: pyrosetta.rosetta.utility.vector1_core_scoring_EMapVector) → None¶

Batch computation of rotamer intrares energy map. Need not be overriden in: derived class – by default, iterates over all rotamers, and calls derived class’s intrares _energy method.

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_intrares_energy_maps(const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class utility::vector1<class core::scoring::EMapVector, class std::allocator<class core::scoring::EMapVector> > &) const –> void

evaluate_rotamer_pair_energies(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set1: pyrosetta.rosetta.core.conformation.RotamerSetBase, set2: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, energy_table: ObjexxFCL::FArray2D<float>) → None¶

Batch computation of rotamer pair energies. Need not be overriden in: derived class – by default, iterates over all pairs of rotamers, and calls the derived class’s residue_pair_energy method.

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_pair_energies(const class core::conformation::RotamerSetBase &, const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class ObjexxFCL::FArray2D<float> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, total_energy: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called by the ScoreFunction at the end of energy evaluation.: The derived class has the opportunity to accumulate a score into the pose’s total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.

C++: core::scoring::methods::EnergyMethod::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

idealize_proline_nvs(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

Idealize the virtual NV atom of every proline in the pose. This prevents innacurate pro-close scores when switching between cartesian and non-cartesian score functions.

C++: core::scoring::methods::CartesianBondedEnergy::idealize_proline_nvs(class core::pose::Pose &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

long_range_type(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy) → pyrosetta.rosetta.core.scoring.methods.LongRangeEnergyType¶: C++: core::scoring::methods::CartesianBondedEnergy::long_range_type() const –> enum core::scoring::methods::LongRangeEnergyType

method_type(self: pyrosetta.rosetta.core.scoring.methods.ContextIndependentLRTwoBodyEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::ContextIndependentLRTwoBodyEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: core::scoring::methods::CartesianBondedEnergy::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_derivatives_for_residue_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue before derivative evaluation begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_derivatives_for_residue_opportunity(const class core::pose::Pose &) const –> bool

requires_a_setup_for_derivatives_for_residue_pair_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue pair before derivative evaluation begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_derivatives_for_residue_pair_opportunity(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_opportunity_during_minimization(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_scoring_for_residue_opportunity_during_minimization(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_pair_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue pair before scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_scoring_for_residue_pair_opportunity(const class core::pose::Pose &) const –> bool

residue_pair_energy(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::residue_pair_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

residue_pair_energy_ext(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, min_data: pyrosetta.rosetta.core.scoring.ResPairMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the two-body energies for a particular residue, in the context of a: given Pose, and with the help of a piece of cached data for minimization, increment those two body energies into the input EnergyMap. The calling function must guarantee that this EnergyMethod has had the opportunity to update the input ResPairMinimizationData object for the given residues in a call to setup_for_minimizing_for_residue_pair before this function is invoked. This function should not be called unless the use_extended_residue_pair_energy_interface() method returns “true”. Default implementation provided by this base class calls utility::exit().

C++: core::scoring::methods::TwoBodyEnergy::residue_pair_energy_ext(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResPairMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_derivatives_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, res_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work necessary before evaluating the derivatives for this residue

C++: core::scoring::methods::TwoBodyEnergy::setup_for_derivatives_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResSingleMinimizationData &, class basic::datacache::BasicDataCache &) const –> void

setup_for_derivatives_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, minsingle_data1: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, minsingle_data2: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Do any setup work necessary before evaluating the derivatives for this residue pair

C++: core::scoring::methods::TwoBodyEnergy::setup_for_derivatives_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResPairMinimizationData &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_minimizing_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, minmap: pyrosetta.rosetta.core.kinematics.MinimizerMapBase, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache, res_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData) → None¶

Called at the beginning of minimization, allowing this energy method to cache data: pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase.

C++: core::scoring::methods::TwoBodyEnergy::setup_for_minimizing_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &, class basic::datacache::BasicDataCache &, class core::scoring::ResSingleMinimizationData &) const –> void

setup_for_minimizing_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, minmap: pyrosetta.rosetta.core.kinematics.MinimizerMapBase, res1_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, res2_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Called at the beginning of minimization, allowing this energy method to cache data: pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase.

C++: core::scoring::methods::TwoBodyEnergy::setup_for_minimizing_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, class core::scoring::ResPairMinimizationData &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.CartesianBondedEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶: C++: core::scoring::methods::CartesianBondedEnergy::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(*args, **kwargs)¶

Overloaded function.

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) -> None
setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData) -> None

Do any setup work should the coordinates of this residue (who is still guaranteed to be: of the same residue type as when setup_for_minimizing_for_residue was called) have changed so dramatically as to possibly require some amount of setup work before scoring should proceed. This function is used for both intra-residue setup and pre-inter-residue setup

C++: core::scoring::methods::TwoBodyEnergy::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResSingleMinimizationData &) const –> void

setup_for_scoring_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, minsingle_data1: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, minsingle_data2: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Do any setup work should the coordinates of a pair of residues, who are still guaranteed to be: of the same residue type as when setup_for_minimizing_for_residue was called, have changed so dramatically as to possibly require some amount of setup work before scoring should proceed

C++: core::scoring::methods::TwoBodyEnergy::setup_for_scoring_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResPairMinimizationData &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

sidechain_sidechain_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the sidechain of rsd1 and the: sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::sidechain_sidechain_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

use_extended_intrares_energy_interface(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy) → bool¶

Derived classes wishing to invoke the alternate, extended interface for eval_intrares_energy: during minimization routines should return “true” when this function is invoked on them. This class provides a default “return false” implementation so that classes not desiring to take advantage of this alternate interface need to do nothing.

C++: core::scoring::methods::TwoBodyEnergy::use_extended_intrares_energy_interface() const –> bool

use_extended_residue_pair_energy_interface(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy) → bool¶

Rely on the extended version of the residue_pair_energy function during score-function: evaluation in minimization? The extended version (below) takes a ResPairMinimizationData in which the derived base class has (or should have) cached a piece of data that will make residue-pair energy evaluation faster than its absense (e.g. a neighbor list). Derived energy methods should return ‘true’ from this function to use the extended interface. The default method implemented in this class returns ‘false’

C++: core::scoring::methods::TwoBodyEnergy::use_extended_residue_pair_energy_interface() const –> bool

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

ChainbreakEnergy class iterates across all residues in finalize() and determines a penalty between residues i and i+1 across a cutpoint by how much their virtual atoms do not align.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy, : pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy¶: C++: core::scoring::methods::ChainbreakEnergy::operator=(const class core::scoring::methods::ChainbreakEnergy &) –> class core::scoring::methods::ChainbreakEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶: C++: core::scoring::methods::ChainbreakEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Called during gradient-based minimization inside dfunc.

C++: core::scoring::methods::ChainbreakEnergy::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, totals: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Called at the end of the energy evaluation.

C++: core::scoring::methods::ChainbreakEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::ChainbreakEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.ChainbreakEnergy) → int¶: C++: core::scoring::methods::ChainbreakEnergy::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

Implementation of env and pair terms for protein-DNA interactions

Could be a CI2B, but centroid atom is not currently the nbr atom for dna so intxn threshold tricky

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy, : pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy¶: C++: core::scoring::methods::WholeStructureEnergy::operator=(const class core::scoring::methods::WholeStructureEnergy &) –> class core::scoring::methods::WholeStructureEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::DNA_EnvPairEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy, pose: pyrosetta.rosetta.core.pose.Pose, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

All the work happens here

C++: core::scoring::methods::DNA_EnvPairEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶

No graphs required.

C++: core::scoring::methods::DNA_EnvPairEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.DNA_EnvPairEnergy) → int¶: C++: core::scoring::methods::DNA_EnvPairEnergy::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

Implementation of Kono and Sarai’s knowledge-based protein-DNA interaction energy

Could be a CI2B, but interaction threshold is large, so in the short term defining as

WholeStructure energy.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy, : pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy¶: C++: core::scoring::methods::WholeStructureEnergy::operator=(const class core::scoring::methods::WholeStructureEnergy &) –> class core::scoring::methods::WholeStructureEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::DirectReadoutEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(*args, **kwargs)¶

Overloaded function.

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, total_energy: pyrosetta.rosetta.core.scoring.EMapVector) -> None
finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy, pose: pyrosetta.rosetta.core.pose.Pose, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) -> None

All the work happens here

C++: core::scoring::methods::DirectReadoutEnergy::finalize_total_energy(const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶

No graphs required.

C++: core::scoring::methods::DirectReadoutEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

my_residue_pair_energy(self: pyrosetta.rosetta.core.scoring.methods.DirectReadoutEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Implementation which is currently not used

C++: core::scoring::methods::DirectReadoutEnergy::my_residue_pair_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

DistanceChainbreakEnergy class iterates across all residues in finalize() and determines the penalty between residues i and i+1 by how far apart their N and C atom are

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy, : pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy¶: C++: core::scoring::methods::DistanceChainbreakEnergy::operator=(const class core::scoring::methods::DistanceChainbreakEnergy &) –> class core::scoring::methods::DistanceChainbreakEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::DistanceChainbreakEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, totals: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called at the end of energy evaluation

C++: core::scoring::methods::DistanceChainbreakEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::DistanceChainbreakEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.DistanceChainbreakEnergy) → int¶: C++: core::scoring::methods::DistanceChainbreakEnergy::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

Bases: pybind11_builtins.pybind11_object

base class for the energy method hierarchy

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, creator: core::scoring::methods::EnergyMethodCreator) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, arg0: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶: C++: core::scoring::methods::EnergyMethod::operator=(const class core::scoring::methods::EnergyMethod &) –> class core::scoring::methods::EnergyMethod &

clone(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶: C++: core::scoring::methods::EnergyMethod::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, total_energy: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called by the ScoreFunction at the end of energy evaluation.: The derived class has the opportunity to accumulate a score into the pose’s total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.

C++: core::scoring::methods::EnergyMethod::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, context_graphs_required: pyrosetta.rosetta.utility.vector1_bool) → None¶

Indicate in the context-graphs-required list which: context-graphs this energy method requires that the Pose maintain when doing neighbor evaluation. Context graphs are allowed

C++: core::scoring::methods::EnergyMethod::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶

Return one of the 7 kinds of energy methods that exist:: e.g. context-dependent-one-body vs whole-structure.

C++: core::scoring::methods::EnergyMethod::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator¶

Bases: pybind11_builtins.pybind11_object

The EnergyMethodCreator class’s responsibilities are to create on demand a new EnergyMethod class, and to tell the ScoringManager singleton which ScoreTypes the EnergyMethod it creates is responsible for. The EnergyMethodCreator must register itself with the ScoringManager at load time (before main() begins) so that the ScoringManager is ready to start creating EnergyMethods by the time the first ScoreFunction requests one.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator, arg0: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator, : pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator¶: C++: core::scoring::methods::EnergyMethodCreator::operator=(const class core::scoring::methods::EnergyMethodCreator &) –> class core::scoring::methods::EnergyMethodCreator &

create_energy_method(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator, options: core::scoring::methods::EnergyMethodOptions) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

Instantiate a new EnergyMethod given a set of energy-method options

C++: core::scoring::methods::EnergyMethodCreator::create_energy_method(const class core::scoring::methods::EnergyMethodOptions &) const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

score_types_for_method(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Return the set of score types claimed by the EnergyMethod: this EnergyMethodCreator creates in its create_energy_method() function

C++: core::scoring::methods::EnergyMethodCreator::score_types_for_method() const –> class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> >

class pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions¶

Bases: pybind11_builtins.pybind11_object

add more options here NOTE: If you add an option, make sure you also update the constructor, the assignment operator, the == comparison operator, and the show method in the .cc file! right now this class should be pretty light-weight since a copy is held inside ScoreFunctionInfo

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, options: pyrosetta.rosetta.utility.options.OptionCollection) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, arg0: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → str¶

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

aa_composition_setup_file(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, index: int) → str¶

Get the nth aa_composition setup file name from the list of setup files.

C++: core::scoring::methods::EnergyMethodOptions::aa_composition_setup_file(const unsigned long) const –> const std::string &

aa_composition_setup_file_count(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → int¶

Get the number of aa_composition setup files.

C++: core::scoring::methods::EnergyMethodOptions::aa_composition_setup_file_count() const –> unsigned long

analytic_etable_evaluation(*args, **kwargs)¶

Overloaded function.

analytic_etable_evaluation(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::analytic_etable_evaluation() const –> bool

analytic_etable_evaluation(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::analytic_etable_evaluation(bool) –> void

append_aa_composition_setup_files(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, input_filenames: pyrosetta.rosetta.utility.vector1_std_string) → None¶

Appends additional files to the aa_composition setup file names.

Does not override existing.

C++: core::scoring::methods::EnergyMethodOptions::append_aa_composition_setup_files(const class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > > &) –> void

aspartimide_penalty_value(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → float¶

Get the penalty for each aspartimide-forming two-residue sequence.

Used by the aspartimide_penalty score term.

C++: core::scoring::methods::EnergyMethodOptions::aspartimide_penalty_value() const –> const double &

assign(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, src: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions¶

copy operator

C++: core::scoring::methods::EnergyMethodOptions::operator=(const class core::scoring::methods::EnergyMethodOptions &) –> class core::scoring::methods::EnergyMethodOptions &

atom_vdw_atom_type_set_name(*args, **kwargs)¶

Overloaded function.

atom_vdw_atom_type_set_name(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

This is used in the construction of the VDW_Energy’s AtomVDW object

C++: core::scoring::methods::EnergyMethodOptions::atom_vdw_atom_type_set_name() const –> const std::string &

atom_vdw_atom_type_set_name(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::atom_vdw_atom_type_set_name(const class std::basic_string<char> &) –> void

bond_angle_central_atoms_to_score(*args, **kwargs)¶

Overloaded function.

bond_angle_central_atoms_to_score(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> pyrosetta.rosetta.utility.vector1_std_string

deprecated

C++: core::scoring::methods::EnergyMethodOptions::bond_angle_central_atoms_to_score() const –> const class utility::vector1<std::string, class std::allocator<std::string > > &

bond_angle_central_atoms_to_score(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, atom_names: pyrosetta.rosetta.utility.vector1_std_string) -> None

depricated

C++: core::scoring::methods::EnergyMethodOptions::bond_angle_central_atoms_to_score(const class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > > &) –> void

bond_angle_residue_type_param_set(*args, **kwargs)¶

Overloaded function.

bond_angle_residue_type_param_set(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> core::scoring::mm::MMBondAngleResidueTypeParamSet

C++: core::scoring::methods::EnergyMethodOptions::bond_angle_residue_type_param_set() –> class std::shared_ptr<class core::scoring::mm::MMBondAngleResidueTypeParamSet>

bond_angle_residue_type_param_set(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, param_set: core::scoring::mm::MMBondAngleResidueTypeParamSet) -> None

C++: core::scoring::methods::EnergyMethodOptions::bond_angle_residue_type_param_set(class std::shared_ptr<class core::scoring::mm::MMBondAngleResidueTypeParamSet>) –> void

clone(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions¶

clone

C++: core::scoring::methods::EnergyMethodOptions::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethodOptions>

cst_max_seq_sep(*args, **kwargs)¶

Overloaded function.

cst_max_seq_sep(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> int

C++: core::scoring::methods::EnergyMethodOptions::cst_max_seq_sep() const –> unsigned long

cst_max_seq_sep(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: int) -> None

C++: core::scoring::methods::EnergyMethodOptions::cst_max_seq_sep(const unsigned long) –> void

elec_die(*args, **kwargs)¶

Overloaded function.

elec_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

The dielectric used for the fa_elec term

C++: core::scoring::methods::EnergyMethodOptions::elec_die() const –> double

elec_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_die(double) –> void

elec_group_file(*args, **kwargs)¶

Overloaded function.

elec_group_file(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::elec_group_file() const –> std::string

elec_group_file(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_group_file(class std::basic_string<char>) –> void

elec_max_dis(*args, **kwargs)¶

Overloaded function.

elec_max_dis(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

The maximum (all atom) distance at which fa_elec is non-zero

C++: core::scoring::methods::EnergyMethodOptions::elec_max_dis() const –> double

elec_max_dis(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_max_dis(double) –> void

elec_min_dis(*args, **kwargs)¶

Overloaded function.

elec_min_dis(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

The minimium (all atom) distance for which fa_elec changes with distances

C++: core::scoring::methods::EnergyMethodOptions::elec_min_dis() const –> double

elec_min_dis(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_min_dis(double) –> void

elec_no_dis_dep_die(*args, **kwargs)¶

Overloaded function.

elec_no_dis_dep_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

Should fa_elec use a constant (non-distance dependant) dielectric?

C++: core::scoring::methods::EnergyMethodOptions::elec_no_dis_dep_die() const –> bool

elec_no_dis_dep_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_no_dis_dep_die(bool) –> void

elec_sigmoidal_die(*args, **kwargs)¶

Overloaded function.

elec_sigmoidal_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

Should fa_elec/gpelec use a sigmoidal dielectric?

C++: core::scoring::methods::EnergyMethodOptions::elec_sigmoidal_die() const –> bool

elec_sigmoidal_die(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::elec_sigmoidal_die(const bool) –> void

elec_sigmoidal_die_params(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, D: float, D0: float, S: float) → None¶: C++: core::scoring::methods::EnergyMethodOptions::elec_sigmoidal_die_params(double &, double &, double &) const –> void

envsmooth_zero_negatives(*args, **kwargs)¶

Overloaded function.

envsmooth_zero_negatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::envsmooth_zero_negatives() const –> bool

envsmooth_zero_negatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::envsmooth_zero_negatives(const bool) –> void

etable_options(*args, **kwargs)¶

Overloaded function.

etable_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> pyrosetta.rosetta.core.scoring.etable.EtableOptions

non-const access to the etable options object

C++: core::scoring::methods::EnergyMethodOptions::etable_options() –> class core::scoring::etable::EtableOptions &

etable_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, opts: pyrosetta.rosetta.core.scoring.etable.EtableOptions) -> None

Set the etable options object – makes a deep copy

C++: core::scoring::methods::EnergyMethodOptions::etable_options(const class core::scoring::etable::EtableOptions &) –> void

etable_type(*args, **kwargs)¶

Overloaded function.

etable_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::etable_type() const –> const std::string &

etable_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, type: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::etable_type(const class std::basic_string<char> &) –> void

eval_intrares_elec_ST_only(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → bool¶: C++: core::scoring::methods::EnergyMethodOptions::eval_intrares_elec_ST_only() const –> bool

eval_intrsres_elec_ST_only(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) → None¶: C++: core::scoring::methods::EnergyMethodOptions::eval_intrsres_elec_ST_only(bool) –> void

exclude_DNA_DNA(*args, **kwargs)¶

Overloaded function.

exclude_DNA_DNA(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::exclude_DNA_DNA() const –> bool

exclude_DNA_DNA(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::exclude_DNA_DNA(const bool) –> void

exclude_intra_res_protein(*args, **kwargs)¶

Overloaded function.

exclude_intra_res_protein(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::exclude_intra_res_protein() const –> bool

exclude_intra_res_protein(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::exclude_intra_res_protein(const bool) –> void

exclude_monomer_fa_elec(*args, **kwargs)¶

Overloaded function.

exclude_monomer_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::exclude_monomer_fa_elec() const –> bool

exclude_monomer_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::exclude_monomer_fa_elec(const bool) –> void

exclude_protein_protein_fa_elec(*args, **kwargs)¶

Overloaded function.

exclude_protein_protein_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::exclude_protein_protein_fa_elec() const –> bool

exclude_protein_protein_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::exclude_protein_protein_fa_elec(const bool) –> void

fa_stack_base_all(*args, **kwargs)¶

Overloaded function.

fa_stack_base_all(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::fa_stack_base_all() const –> bool

fa_stack_base_all(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::fa_stack_base_all(const bool) –> void

free_dof_options(*args, **kwargs)¶

Overloaded function.

free_dof_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> core::scoring::methods::FreeDOF_Options

non-const access to the FreeDOF options object

C++: core::scoring::methods::EnergyMethodOptions::free_dof_options() –> class core::scoring::methods::FreeDOF_Options &

free_dof_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, opts: core::scoring::methods::FreeDOF_Options) -> None

Set the FreeDOF options object – makes a deep copy

C++: core::scoring::methods::EnergyMethodOptions::free_dof_options(const class core::scoring::methods::FreeDOF_Options &) –> void

geom_sol_interres_path_distance_cutoff(*args, **kwargs)¶

Overloaded function.

geom_sol_interres_path_distance_cutoff(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> int

C++: core::scoring::methods::EnergyMethodOptions::geom_sol_interres_path_distance_cutoff() const –> unsigned long

geom_sol_interres_path_distance_cutoff(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: int) -> None

C++: core::scoring::methods::EnergyMethodOptions::geom_sol_interres_path_distance_cutoff(const unsigned long) –> void

geom_sol_intrares_path_distance_cutoff(*args, **kwargs)¶

Overloaded function.

geom_sol_intrares_path_distance_cutoff(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> int

C++: core::scoring::methods::EnergyMethodOptions::geom_sol_intrares_path_distance_cutoff() const –> unsigned long

geom_sol_intrares_path_distance_cutoff(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: int) -> None

C++: core::scoring::methods::EnergyMethodOptions::geom_sol_intrares_path_distance_cutoff(const unsigned long) –> void

get_cartesian_bonded_linear(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → bool¶

get the harmonic bond angle and bond-length spring constants

C++: core::scoring::methods::EnergyMethodOptions::get_cartesian_bonded_linear() const –> bool

get_cartesian_bonded_parameters(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, len: float, ang: float, tors: float, proton: float, imp: float) → None¶

get the harmonic bond angle and bond-length spring constants

C++: core::scoring::methods::EnergyMethodOptions::get_cartesian_bonded_parameters(double &, double &, double &, double &, double &) const –> void

get_density_sc_scale_byres(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → pyrosetta.rosetta.utility.vector1_double¶: C++: core::scoring::methods::EnergyMethodOptions::get_density_sc_scale_byres() const –> const class utility::vector1<double, class std::allocator<double> > &

grp_cpfxn(*args, **kwargs)¶

Overloaded function.

grp_cpfxn(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::grp_cpfxn() const –> bool

grp_cpfxn(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::grp_cpfxn(bool) –> void

grpelec_context_dependent(*args, **kwargs)¶

Overloaded function.

grpelec_context_dependent(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::grpelec_context_dependent() const –> bool

grpelec_context_dependent(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::grpelec_context_dependent(bool) –> void

grpelec_fade_hbond(*args, **kwargs)¶

Overloaded function.

grpelec_fade_hbond(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_hbond() const –> bool

grpelec_fade_hbond(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_hbond(bool) –> void

grpelec_fade_param1(*args, **kwargs)¶

Overloaded function.

grpelec_fade_param1(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_param1() const –> double

grpelec_fade_param1(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_param1(double) –> void

grpelec_fade_param2(*args, **kwargs)¶

Overloaded function.

grpelec_fade_param2(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_param2() const –> double

grpelec_fade_param2(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_param2(double) –> void

grpelec_fade_type(*args, **kwargs)¶

Overloaded function.

grpelec_fade_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_type() const –> std::string

grpelec_fade_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::grpelec_fade_type(class std::basic_string<char>) –> void

has_method_weights(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, type: pyrosetta.rosetta.core.scoring.ScoreType) → bool¶: C++: core::scoring::methods::EnergyMethodOptions::has_method_weights(const enum core::scoring::ScoreType &) const –> bool

hbond_options(*args, **kwargs)¶

Overloaded function.

hbond_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> pyrosetta.rosetta.core.scoring.hbonds.HBondOptions

non-const access to the hbond options object

C++: core::scoring::methods::EnergyMethodOptions::hbond_options() –> class core::scoring::hbonds::HBondOptions &

hbond_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, opts: pyrosetta.rosetta.core.scoring.hbonds.HBondOptions) -> None

Set the hbond options object – makes a deep copy

C++: core::scoring::methods::EnergyMethodOptions::hbond_options(const class core::scoring::hbonds::HBondOptions &) –> void

initialize_from_options(*args, **kwargs)¶

Overloaded function.

initialize_from_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> None

Initialize a new EnergyMethodOptions with defaults from the global option collection

C++: core::scoring::methods::EnergyMethodOptions::initialize_from_options() –> void

initialize_from_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, options: pyrosetta.rosetta.utility.options.OptionCollection) -> None

Initialize a new EnergyMethodOptions with defaults from a (possibly local) option collection

C++: core::scoring::methods::EnergyMethodOptions::initialize_from_options(const class utility::options::OptionCollection &) –> void

insert_score_function_method_options_rows(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, batch_id: int, score_function_name: str, db_session: pyrosetta.rosetta.utility.sql_database.session) → None¶: C++: core::scoring::methods::EnergyMethodOptions::insert_score_function_method_options_rows(unsigned long, const class std::basic_string<char> &, class std::shared_ptr<class utility::sql_database::session>) const –> void

loop_close_use_6D_potential(*args, **kwargs)¶

Overloaded function.

loop_close_use_6D_potential(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::loop_close_use_6D_potential() const –> bool

loop_close_use_6D_potential(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::loop_close_use_6D_potential(const bool) –> void

method_weights(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, type: pyrosetta.rosetta.core.scoring.ScoreType) → pyrosetta.rosetta.utility.vector1_double¶: C++: core::scoring::methods::EnergyMethodOptions::method_weights(const enum core::scoring::ScoreType &) const –> const class utility::vector1<double, class std::allocator<double> > &

pb_bound_tag(*args, **kwargs)¶

Overloaded function.

pb_bound_tag(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::pb_bound_tag() –> std::string &

pb_bound_tag(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, tag: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::pb_bound_tag(const class std::basic_string<char> &) –> void

pb_unbound_tag(*args, **kwargs)¶

Overloaded function.

pb_unbound_tag(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::pb_unbound_tag() –> std::string &

pb_unbound_tag(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, tag: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::pb_unbound_tag(const class std::basic_string<char> &) –> void

protein_dielectric(*args, **kwargs)¶

Overloaded function.

protein_dielectric(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

C++: core::scoring::methods::EnergyMethodOptions::protein_dielectric() const –> double

protein_dielectric(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::protein_dielectric(double) –> void

put_intra_into_total(*args, **kwargs)¶

Overloaded function.

put_intra_into_total(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::put_intra_into_total() const –> bool

put_intra_into_total(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::put_intra_into_total(const bool) –> void

rna_options(*args, **kwargs)¶

Overloaded function.

rna_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> core::scoring::rna::RNA_EnergyMethodOptions

non-const access to the RNA options object

C++: core::scoring::methods::EnergyMethodOptions::rna_options() –> class core::scoring::rna::RNA_EnergyMethodOptions &

rna_options(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, opts: core::scoring::rna::RNA_EnergyMethodOptions) -> None

Set the FreeDOF options object – makes a deep copy

C++: core::scoring::methods::EnergyMethodOptions::rna_options(const class core::scoring::rna::RNA_EnergyMethodOptions &) –> void

secondary_structure_weights(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) → pyrosetta.rosetta.core.scoring.SecondaryStructureWeights¶: C++: core::scoring::methods::EnergyMethodOptions::secondary_structure_weights() –> class core::scoring::SecondaryStructureWeights &

set_aa_composition_setup_files(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, input_filenames: pyrosetta.rosetta.utility.vector1_std_string) → None¶

Set the aa_composition setup file names.

Overrides existing.

C++: core::scoring::methods::EnergyMethodOptions::set_aa_composition_setup_files(const class utility::vector1<class std::basic_string<char>, class std::allocator<class std::basic_string<char> > > &) –> void

set_cartesian_bonded_linear(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, lin_in: bool) → None¶

set the harmonic bond angle and bond-length spring constants

C++: core::scoring::methods::EnergyMethodOptions::set_cartesian_bonded_linear(bool) –> void

set_cartesian_bonded_parameters(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, len: float, ang: float, tors: float, proton: float, imp: float) → None¶

set the harmonic bond angle and bond-length spring constants

C++: core::scoring::methods::EnergyMethodOptions::set_cartesian_bonded_parameters(double, double, double, double, double) –> void

set_density_sc_scale_byres(*args, **kwargs)¶

Overloaded function.

set_density_sc_scale_byres(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, newscscale: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::set_density_sc_scale_byres(double) –> void

set_density_sc_scale_byres(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, aa: pyrosetta.rosetta.core.chemical.AA, newscscale: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::set_density_sc_scale_byres(enum core::chemical::AA, double) –> void

set_elec_sigmoidal_die_params(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, D: float, D0: float, S: float) → None¶: C++: core::scoring::methods::EnergyMethodOptions::set_elec_sigmoidal_die_params(double, double, double) –> void

set_method_weights(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, type: pyrosetta.rosetta.core.scoring.ScoreType, wts: pyrosetta.rosetta.utility.vector1_double) → None¶: C++: core::scoring::methods::EnergyMethodOptions::set_method_weights(const enum core::scoring::ScoreType &, const class utility::vector1<double, class std::allocator<double> > &) –> void

set_strand_strand_weights(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, ss_lowstrand: int, ss_cutoff: int) → None¶: C++: core::scoring::methods::EnergyMethodOptions::set_strand_strand_weights(int, int) –> void

show(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, out: pyrosetta.rosetta.std.ostream) → None¶: C++: core::scoring::methods::EnergyMethodOptions::show(class std::basic_ostream<char> &) const –> void

smooth_fa_elec(*args, **kwargs)¶

Overloaded function.

smooth_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::smooth_fa_elec() const –> bool

smooth_fa_elec(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::smooth_fa_elec(bool) –> void

split_unfolded_label_type(*args, **kwargs)¶

Overloaded function.

split_unfolded_label_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::split_unfolded_label_type() const –> const std::string &

split_unfolded_label_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, label_type: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::split_unfolded_label_type(const class std::basic_string<char> &) –> void

split_unfolded_value_type(*args, **kwargs)¶

Overloaded function.

split_unfolded_value_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::split_unfolded_value_type() const –> const std::string &

split_unfolded_value_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, value_type: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::split_unfolded_value_type(const class std::basic_string<char> &) –> void

symmetric_gly_tables(*args, **kwargs)¶

Overloaded function.

symmetric_gly_tables(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

Should glyceine’s Ramachandran and P_AA_PP tables be symmetrized (e.g. for scoring in a mixed D/L context)?

Default false.

Vikram K. Mulligan (vmullig.edu)

C++: core::scoring::methods::EnergyMethodOptions::symmetric_gly_tables() const –> bool

symmetric_gly_tables(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

Set whether glyceine’s Ramachandran and P_AA_PP tables should be symmetrized (e.g. for scoring in a mixed D/L context).

Vikram K. Mulligan (vmullig.edu)

C++: core::scoring::methods::EnergyMethodOptions::symmetric_gly_tables(const bool) –> void

unfolded_energies_type(*args, **kwargs)¶

Overloaded function.

unfolded_energies_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> str

C++: core::scoring::methods::EnergyMethodOptions::unfolded_energies_type() const –> const std::string &

unfolded_energies_type(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, type: str) -> None

C++: core::scoring::methods::EnergyMethodOptions::unfolded_energies_type(const class std::basic_string<char> &) –> void

use_gen_kirkwood(*args, **kwargs)¶

Overloaded function.

use_gen_kirkwood(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::use_gen_kirkwood() const –> bool

use_gen_kirkwood(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::use_gen_kirkwood(bool) –> void

use_polarization(*args, **kwargs)¶

Overloaded function.

use_polarization(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> bool

C++: core::scoring::methods::EnergyMethodOptions::use_polarization() const –> bool

use_polarization(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: bool) -> None

C++: core::scoring::methods::EnergyMethodOptions::use_polarization(bool) –> void

water_dielectric(*args, **kwargs)¶

Overloaded function.

water_dielectric(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> float

C++: core::scoring::methods::EnergyMethodOptions::water_dielectric() const –> double

water_dielectric(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions, setting: float) -> None

C++: core::scoring::methods::EnergyMethodOptions::water_dielectric(double) –> void

write_score_function_method_options_table_schema(db_session: pyrosetta.rosetta.utility.sql_database.session) → None¶: C++: core::scoring::methods::EnergyMethodOptions::write_score_function_method_options_table_schema(class std::shared_ptr<class utility::sql_database::session>) –> void

class pyrosetta.rosetta.core.scoring.methods.GoapEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.ContextIndependentTwoBodyEnergy

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, options: pyrosetta.rosetta.core.scoring.methods.EnergyMethodOptions) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → pyrosetta.rosetta.core.scoring.methods.GoapEnergy¶: C++: core::scoring::methods::GoapEnergy::operator=(const class core::scoring::methods::GoapEnergy &) –> class core::scoring::methods::GoapEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → float¶: C++: core::scoring::methods::GoapEnergy::atomic_interaction_cutoff() const –> double

backbone_backbone_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the backbone of rsd1 and the: backbone of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the weighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::backbone_backbone_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

backbone_sidechain_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the backbone of rsd1 and the: sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::backbone_sidechain_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

bump_energy_backbone(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::TwoBodyEnergy::bump_energy_backbone(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

bump_energy_full(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::TwoBodyEnergy::bump_energy_full(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

clone(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::GoapEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

continuous(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → bool¶: C++: core::scoring::methods::GoapEnergy::continuous() const –> bool

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

defines_intrares_dof_derivatives(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, p: pyrosetta.rosetta.core.pose.Pose) → bool¶

Use the dof_derivative interface for this energy method when: calculating derivatives? It is possible to define both dof_derivatives and atom-derivatives; they are not mutually exclusive.

C++: core::scoring::methods::TwoBodyEnergy::defines_intrares_dof_derivatives(const class core::pose::Pose &) const –> bool

defines_intrares_energy(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.scoring.EMapVector) → bool¶: C++: core::scoring::methods::GoapEnergy::defines_intrares_energy(const class core::scoring::EMapVector &) const –> bool

defines_intrares_energy_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, res: pyrosetta.rosetta.core.conformation.Residue) → bool¶

If a score function defines no intra-residue scores for a particular: residue, then it may opt-out of being asked during minimization to evaluate the score for this residue.

C++: core::scoring::methods::TwoBodyEnergy::defines_intrares_energy_for_residue(const class core::conformation::Residue &) const –> bool

defines_score_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, res1: pyrosetta.rosetta.core.conformation.Residue, res2: pyrosetta.rosetta.core.conformation.Residue, res_moving_wrt_eachother: bool) → bool¶

During minimization, energy methods are allowed to decide that they say nothing: about a particular residue pair (e.g. no non-zero energy) and as a result they will not be queried for a derivative or an energy. The default implementation returns “true” for all residue pairs. Context-dependent two-body energies have the option of behaving as if they are context-independent by returning “false” for residue pairs that do no move wrt each other.

C++: core::scoring::methods::TwoBodyEnergy::defines_score_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, bool) const –> bool

distbin_map(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, i: int) → int¶: C++: core::scoring::methods::GoapEnergy::distbin_map(unsigned long) const –> unsigned long

divides_backbone_and_sidechain_energetics(self: pyrosetta.rosetta.core.scoring.methods.ShortRangeTwoBodyEnergy) → bool¶

A derived class should return true for this function if it implements its own: versions of the backbone_backbone_energy, backbone_sidechain_energy and sidechain_sidechain_energy functions. The default sidechain_sidechain_energy implemented by the TwoBodyEnergy base class calls residue_pair_energy. If the derived class implements its own versions of these functions, then calling code may avoid calling it on pairs of residues that are “provably distant” based on a pair of bounding spheres for a sidechains and backbones and this method’s atomic_interaction_cutoff energy method.

C++: core::scoring::methods::ShortRangeTwoBodyEnergy::divides_backbone_and_sidechain_energetics() const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

eval_intrares_derivatives(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, weights: pyrosetta.rosetta.core.scoring.EMapVector, atom_derivs: pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair) → None¶

Evaluate the derivative for the intra-residue component of this energy method: for all the atoms in a residue in the context of a particular pose, and increment the F1 and F2 vectors held in the atom_derivs vector1. This base class provides a default noop implementation of this function. The calling function must guarantee that this EnergyMethod has had the opportunity to update the input ResSingleMinimizationData object for the given residue in a call to prepare_for_minimization before this function is invoked. The calling function must also guarantee that there are at least as many entries in the atom_derivs vector1 as there are atoms in the input rsd.

C++: core::scoring::methods::TwoBodyEnergy::eval_intrares_derivatives(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &) const –> void

eval_intrares_energy(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::GoapEnergy::eval_intrares_energy(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

eval_intrares_energy_ext(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the intra-residue energy for a given residue using the data held within the: ResSingleMinimizationData object. This function should be invoked only on derived instances of this class if they return “true” in a call to their use_extended_intrares_energy_interface method. This base class provides a noop implementation for classes that do not implement this interface, or that do not define intrares energies.

C++: core::scoring::methods::TwoBodyEnergy::eval_intrares_energy_ext(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

eval_intraresidue_dof_derivative(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, dof_id: pyrosetta.rosetta.core.id.DOF_ID, torsion_id: pyrosetta.rosetta.core.id.TorsionID, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector) → float¶

Evaluate the DOF derivative for a particular residue. The Pose merely serves as context,: and the input residue is not required to be a member of the Pose.

C++: core::scoring::methods::TwoBodyEnergy::eval_intraresidue_dof_derivative(const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::id::DOF_ID &, const class core::id::TorsionID &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &) const –> double

eval_res(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, resno: int) → bool¶: C++: core::scoring::methods::GoapEnergy::eval_res(const unsigned long) const –> bool

eval_residue_pair_derivatives(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, : pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, : pyrosetta.rosetta.core.scoring.ResPairMinimizationData, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.EMapVector, : pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair, : pyrosetta.rosetta.utility.vector1_core_scoring_DerivVectorPair) → None¶: C++: core::scoring::methods::GoapEnergy::eval_residue_pair_derivatives(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResPairMinimizationData &, const class core::pose::Pose &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &, class utility::vector1<class core::scoring::DerivVectorPair, class std::allocator<class core::scoring::DerivVectorPair> > &) const –> void

evaluate_rotamer_background_energies(self: pyrosetta.rosetta.core.scoring.methods.ShortRangeTwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, residue: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, energy_vector: pyrosetta.rosetta.utility.vector1_float) → None¶

Batch computation of rotamer/background energies. Need not be overriden: in derived class – by default, iterates over all rotamers in the set, and calls derived class’s residue_pair_energy method for each one against the background rotamer Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range

C++: core::scoring::methods::ShortRangeTwoBodyEnergy::evaluate_rotamer_background_energies(const class core::conformation::RotamerSetBase &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class utility::vector1<float, class std::allocator<float> > &) const –> void

evaluate_rotamer_background_energy_maps(self: pyrosetta.rosetta.core.scoring.methods.ShortRangeTwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, residue: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, emaps: pyrosetta.rosetta.utility.vector1_core_scoring_EMapVector) → None¶

Batch computation of rotamer/background energies. Need not be overriden: in derived class – by default, iterates over all rotamers in the set, and calls derived class’s residue_pair_energy method for each one against the background rotamer Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range

C++: core::scoring::methods::ShortRangeTwoBodyEnergy::evaluate_rotamer_background_energy_maps(const class core::conformation::RotamerSetBase &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class utility::vector1<class core::scoring::EMapVector, class std::allocator<class core::scoring::EMapVector> > &) const –> void

evaluate_rotamer_intrares_energies(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, energies: pyrosetta.rosetta.utility.vector1_float) → None¶

Batch computation of rotamer intrares energies. Need not be overriden in: derived class – by default, iterates over all rotamers, and calls derived class’s intrares _energy method.

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_intrares_energies(const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class utility::vector1<float, class std::allocator<float> > &) const –> void

evaluate_rotamer_intrares_energy_maps(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, set: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emaps: pyrosetta.rosetta.utility.vector1_core_scoring_EMapVector) → None¶

Batch computation of rotamer intrares energy map. Need not be overriden in: derived class – by default, iterates over all rotamers, and calls derived class’s intrares _energy method.

C++: core::scoring::methods::TwoBodyEnergy::evaluate_rotamer_intrares_energy_maps(const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class utility::vector1<class core::scoring::EMapVector, class std::allocator<class core::scoring::EMapVector> > &) const –> void

evaluate_rotamer_pair_energies(self: pyrosetta.rosetta.core.scoring.methods.ShortRangeTwoBodyEnergy, set1: pyrosetta.rosetta.core.conformation.RotamerSetBase, set2: pyrosetta.rosetta.core.conformation.RotamerSetBase, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, energy_table: ObjexxFCL::FArray2D<float>) → None¶

Batch computation of rotamer pair energies. Need not be overriden in: derived class – by default, iterates over all pairs of rotamers, and calls derived class’s residue_pair_energy method. Since short range rotamer pairs may not need calculation, the default method looks at blocks of residue type pairs and only calls the residue_pair_energy method if the rotamer pairs are within range

C++: core::scoring::methods::ShortRangeTwoBodyEnergy::evaluate_rotamer_pair_energies(const class core::conformation::RotamerSetBase &, const class core::conformation::RotamerSetBase &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class ObjexxFCL::FArray2D<float> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, total_energy: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called by the ScoreFunction at the end of energy evaluation.: The derived class has the opportunity to accumulate a score into the pose’s total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.

C++: core::scoring::methods::EnergyMethod::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::GoapEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

max_dis(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → float¶: C++: core::scoring::methods::GoapEnergy::max_dis() const –> double

method_type(self: pyrosetta.rosetta.core.scoring.methods.ContextIndependentTwoBodyEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::ContextIndependentTwoBodyEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: core::scoring::methods::GoapEnergy::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_derivatives_for_residue_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue before derivative evaluation begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_derivatives_for_residue_opportunity(const class core::pose::Pose &) const –> bool

requires_a_setup_for_derivatives_for_residue_pair_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue pair before derivative evaluation begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_derivatives_for_residue_pair_opportunity(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_opportunity_during_minimization(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_scoring_for_residue_opportunity_during_minimization(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

requires_a_setup_for_scoring_for_residue_pair_opportunity(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine each residue pair before scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residue pairs that are uninterested in doing so.

C++: core::scoring::methods::TwoBodyEnergy::requires_a_setup_for_scoring_for_residue_pair_opportunity(const class core::pose::Pose &) const –> bool

residue_pair_energy(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶: C++: core::scoring::methods::GoapEnergy::residue_pair_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

residue_pair_energy_ext(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, min_data: pyrosetta.rosetta.core.scoring.ResPairMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the two-body energies for a particular residue, in the context of a: given Pose, and with the help of a piece of cached data for minimization, increment those two body energies into the input EnergyMap. The calling function must guarantee that this EnergyMethod has had the opportunity to update the input ResPairMinimizationData object for the given residues in a call to setup_for_minimizing_for_residue_pair before this function is invoked. This function should not be called unless the use_extended_residue_pair_energy_interface() method returns “true”. Default implementation provided by this base class calls utility::exit().

C++: core::scoring::methods::TwoBodyEnergy::residue_pair_energy_ext(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResPairMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶: C++: core::scoring::methods::GoapEnergy::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_derivatives_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, res_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work necessary before evaluating the derivatives for this residue

C++: core::scoring::methods::TwoBodyEnergy::setup_for_derivatives_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResSingleMinimizationData &, class basic::datacache::BasicDataCache &) const –> void

setup_for_derivatives_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, minsingle_data1: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, minsingle_data2: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Do any setup work necessary before evaluating the derivatives for this residue pair

C++: core::scoring::methods::TwoBodyEnergy::setup_for_derivatives_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResPairMinimizationData &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_minimizing_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, minmap: pyrosetta.rosetta.core.kinematics.MinimizerMapBase, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache, res_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData) → None¶

Called at the beginning of minimization, allowing this energy method to cache data: pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase.

C++: core::scoring::methods::TwoBodyEnergy::setup_for_minimizing_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &, class basic::datacache::BasicDataCache &, class core::scoring::ResSingleMinimizationData &) const –> void

setup_for_minimizing_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, minmap: pyrosetta.rosetta.core.kinematics.MinimizerMapBase, res1_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, res2_data_cache: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Called at the beginning of minimization, allowing this energy method to cache data: pertinent for a single residue in the the ResPairMinimizationData that is used for a particular residue in the context of a particular Pose. This base class provides a noop implementation for this function if there is nothing that the derived class needs to perform in this setup phase.

C++: core::scoring::methods::TwoBodyEnergy::setup_for_minimizing_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, class core::scoring::ResPairMinimizationData &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::GoapEnergy::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶: C++: core::scoring::methods::GoapEnergy::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(*args, **kwargs)¶

Overloaded function.

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) -> None
setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, min_data: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData) -> None

Do any setup work should the coordinates of this residue (who is still guaranteed to be: of the same residue type as when setup_for_minimizing_for_residue was called) have changed so dramatically as to possibly require some amount of setup work before scoring should proceed. This function is used for both intra-residue setup and pre-inter-residue setup

C++: core::scoring::methods::TwoBodyEnergy::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResSingleMinimizationData &) const –> void

setup_for_scoring_for_residue_pair(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, minsingle_data1: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, minsingle_data2: pyrosetta.rosetta.core.scoring.ResSingleMinimizationData, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, data_cache: pyrosetta.rosetta.core.scoring.ResPairMinimizationData) → None¶

Do any setup work should the coordinates of a pair of residues, who are still guaranteed to be: of the same residue type as when setup_for_minimizing_for_residue was called, have changed so dramatically as to possibly require some amount of setup work before scoring should proceed

C++: core::scoring::methods::TwoBodyEnergy::setup_for_scoring_for_residue_pair(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::scoring::ResSingleMinimizationData &, const class core::scoring::ResSingleMinimizationData &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::ResPairMinimizationData &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

sidechain_sidechain_energy(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy, rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

Evaluate the interaction between the sidechain of rsd1 and the: sidechain of rsd2 and accumulate the unweighted energies. The sum bb_bb(r1,r2) + bb_sc(r1,r2) + bb_sc(r2,r1) + sc_sc( r1,r2) must equal the unweighted result of a call to residue_pair_energy. By default, bb_bb & bb_sc return 0 and sc_sc returns residue pair energy.

C++: core::scoring::methods::TwoBodyEnergy::sidechain_sidechain_energy(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

use_extended_intrares_energy_interface(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy) → bool¶

Derived classes wishing to invoke the alternate, extended interface for eval_intrares_energy: during minimization routines should return “true” when this function is invoked on them. This class provides a default “return false” implementation so that classes not desiring to take advantage of this alternate interface need to do nothing.

C++: core::scoring::methods::TwoBodyEnergy::use_extended_intrares_energy_interface() const –> bool

use_extended_residue_pair_energy_interface(self: pyrosetta.rosetta.core.scoring.methods.TwoBodyEnergy) → bool¶

Rely on the extended version of the residue_pair_energy function during score-function: evaluation in minimization? The extended version (below) takes a ResPairMinimizationData in which the derived base class has (or should have) cached a piece of data that will make residue-pair energy evaluation faster than its absense (e.g. a neighbor list). Derived energy methods should return ‘true’ from this function to use the extended interface. The default method implemented in this class returns ‘false’

C++: core::scoring::methods::TwoBodyEnergy::use_extended_residue_pair_energy_interface() const –> bool

version(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy) → int¶: C++: core::scoring::methods::GoapEnergy::version() const –> unsigned long

xd(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, resno: int, atmno: int) → pyrosetta.rosetta.numeric.xyzVector_double_t¶: C++: core::scoring::methods::GoapEnergy::xd(const unsigned long, const unsigned long) const –> class numeric::xyzVector<double>

xn(self: pyrosetta.rosetta.core.scoring.methods.GoapEnergy, resno: int, atmno: int) → pyrosetta.rosetta.numeric.xyzVector_double_t¶: C++: core::scoring::methods::GoapEnergy::xn(const unsigned long, const unsigned long) const –> class numeric::xyzVector<double>

class pyrosetta.rosetta.core.scoring.methods.GoapRsdType¶

Bases: pybind11_builtins.pybind11_object

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, arg0: pyrosetta.rosetta.core.scoring.methods.GoapRsdType) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_atmname_using(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, str: str) → None¶: C++: core::scoring::methods::GoapRsdType::add_atmname_using(const class std::basic_string<char> &) –> void

assign(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, : pyrosetta.rosetta.core.scoring.methods.GoapRsdType) → pyrosetta.rosetta.core.scoring.methods.GoapRsdType¶: C++: core::scoring::methods::GoapRsdType::operator=(const class core::scoring::methods::GoapRsdType &) –> class core::scoring::methods::GoapRsdType &

atmid(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → int¶: C++: core::scoring::methods::GoapRsdType::atmid(const unsigned long) const –> unsigned long

atmname_using(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → str¶: C++: core::scoring::methods::GoapRsdType::atmname_using(const unsigned long) const –> std::string

connected_by_twobonds(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → bool¶: C++: core::scoring::methods::GoapRsdType::connected_by_twobonds(const unsigned long) const –> bool

i2(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → int¶: C++: core::scoring::methods::GoapRsdType::i2(const unsigned long) const –> unsigned long

i3(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → int¶: C++: core::scoring::methods::GoapRsdType::i3(const unsigned long) const –> unsigned long

is_using(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int) → bool¶: C++: core::scoring::methods::GoapRsdType::is_using(const unsigned long) const –> bool

name(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType) → str¶: C++: core::scoring::methods::GoapRsdType::name() const –> std::string

natom(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType) → int¶: C++: core::scoring::methods::GoapRsdType::natom() const –> unsigned long

nusing(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType) → int¶: C++: core::scoring::methods::GoapRsdType::nusing() const –> unsigned long

set_angle_atom(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int, j: int) → None¶: C++: core::scoring::methods::GoapRsdType::set_angle_atom(const unsigned long, const unsigned long) –> void

set_atmid(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int, j: int) → None¶: C++: core::scoring::methods::GoapRsdType::set_atmid(const unsigned long, const unsigned long) –> void

set_branch_atom(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int, j: int) → None¶: C++: core::scoring::methods::GoapRsdType::set_branch_atom(const unsigned long, const unsigned long) –> void

set_root_atom(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int, j: int) → None¶: C++: core::scoring::methods::GoapRsdType::set_root_atom(const unsigned long, const unsigned long) –> void

set_using(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, i: int, val: bool) → None¶: C++: core::scoring::methods::GoapRsdType::set_using(const unsigned long, const bool) –> void

setup_connectivity(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, rsd: pyrosetta.rosetta.core.chemical.ResidueType) → None¶: C++: core::scoring::methods::GoapRsdType::setup_connectivity(const class core::chemical::ResidueType &) –> void

setup_rsdtype(self: pyrosetta.rosetta.core.scoring.methods.GoapRsdType, rsd: pyrosetta.rosetta.core.chemical.ResidueType) → None¶: C++: core::scoring::methods::GoapRsdType::setup_rsdtype(class std::shared_ptr<const class core::chemical::ResidueType>) –> void

class pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase¶

Bases: pybind11_builtins.pybind11_object

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, k_len: float, k_ang: float, k_tors: float, k_tors_prot: float, k_tors_improper: float) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

bbdep_bond_devs(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → bool¶: C++: core::scoring::methods::IdealParametersDatabase::bbdep_bond_devs() const –> bool

bbdep_bond_params(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → bool¶: C++: core::scoring::methods::IdealParametersDatabase::bbdep_bond_params() const –> bool

k_angle(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → float¶: C++: core::scoring::methods::IdealParametersDatabase::k_angle() const –> double

k_length(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → float¶: C++: core::scoring::methods::IdealParametersDatabase::k_length() const –> double

k_torsion(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → float¶: C++: core::scoring::methods::IdealParametersDatabase::k_torsion() const –> double

k_torsion_improper(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → float¶: C++: core::scoring::methods::IdealParametersDatabase::k_torsion_improper() const –> double

k_torsion_proton(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase) → float¶: C++: core::scoring::methods::IdealParametersDatabase::k_torsion_proton() const –> double

lookup_angle(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, rsd_type: pyrosetta.rosetta.core.chemical.ResidueType, pre_proline: bool, atm1_name: str, atm2_name: str, atm3_name: str, atm1idx: int, atm2idx: int, atm3idx: int) → pyrosetta.rosetta.core.scoring.methods.CartBondedParameters¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_angle(const class core::chemical::ResidueType &, bool, const class std::basic_string<char> &, const class std::basic_string<char> &, const class std::basic_string<char> &, int, int, int) –> class std::shared_ptr<const class core::scoring::methods::CartBondedParameters>

lookup_angle_legacy(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, pose: pyrosetta.rosetta.core.pose.Pose, res: pyrosetta.rosetta.core.conformation.Residue, atm1: int, atm2: int, atm3: int, Ktheta: float, d0: float) → None¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_angle_legacy(const class core::pose::Pose &, const class core::conformation::Residue &, int, int, int, double &, double &) const –> void

lookup_improper(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, rsd_type: pyrosetta.rosetta.core.chemical.ResidueType, atm1_name: str, atm2_name: str, atm3_name: str, atm4_name: str) → pyrosetta.rosetta.core.scoring.methods.CartBondedParameters¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_improper(const class core::chemical::ResidueType &, const class std::basic_string<char> &, const class std::basic_string<char> &, const class std::basic_string<char> &, const class std::basic_string<char> &) –> class std::shared_ptr<const class core::scoring::methods::CartBondedParameters>

lookup_length(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, rsd_type: pyrosetta.rosetta.core.chemical.ResidueType, pre_proline: bool, atm1_name: str, atm2_name: str, atm1idx: int, atm2idx: int) → pyrosetta.rosetta.core.scoring.methods.CartBondedParameters¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_length(const class core::chemical::ResidueType &, bool, const class std::basic_string<char> &, const class std::basic_string<char> &, int, int) –> class std::shared_ptr<const class core::scoring::methods::CartBondedParameters>

lookup_length_legacy(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, pose: pyrosetta.rosetta.core.pose.Pose, res: pyrosetta.rosetta.core.conformation.Residue, atm1: int, atm2: int, Kd: float, d0: float) → None¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_length_legacy(const class core::pose::Pose &, const class core::conformation::Residue &, int, int, double &, double &) const –> void

lookup_torsion_legacy(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, restype: pyrosetta.rosetta.core.chemical.ResidueType, atm1: int, atm2: int, atm3: int, atm4: int, Kphi: float, phi0: float, phi_step: float) → None¶: C++: core::scoring::methods::IdealParametersDatabase::lookup_torsion_legacy(const class core::chemical::ResidueType &, int, int, int, int, double &, double &, double &) const –> void

parameters_for_restype(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, restype: pyrosetta.rosetta.core.chemical.ResidueType, prepro: bool) → pyrosetta.rosetta.core.scoring.methods.ResidueCartBondedParameters¶

Return a list of all the bond lengths, bond angles, and bond torsions: for a single residue type. This list is constructed lazily as required.

C++: core::scoring::methods::IdealParametersDatabase::parameters_for_restype(const class core::chemical::ResidueType &, bool) –> const class core::scoring::methods::ResidueCartBondedParameters &

restype_destruction_observer(self: pyrosetta.rosetta.core.scoring.methods.IdealParametersDatabase, event: pyrosetta.rosetta.core.chemical.RestypeDestructionEvent) → None¶: C++: core::scoring::methods::IdealParametersDatabase::restype_destruction_observer(const struct core::chemical::RestypeDestructionEvent &) –> void

class pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

LinearBranchEnergy class iterates across all residues in finalize() and determines the penalty between branch-connected residues by how much their psueduo atoms do not align (if they have them).

Calculates linear_branch_conn.

linear_branch_conn measures 3 distances (branch variants with cutpoint-like atoms must be added to pose)

For ideal poses, this score should be very close to 0. Real PDBs, however have bond length and angle: deviations that will cause this score to be fairly high.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy, : pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy) → pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy¶

The auto-generated operator=() method does not properly handle pointer types.

C++: core::scoring::methods::LinearBranchEnergy::operator=(const class core::scoring::methods::LinearBranchEnergy &) –> class core::scoring::methods::LinearBranchEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::LinearBranchEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

called during gradient-based minimization inside dfunc

F1 and F2 are not zeroed – contributions from this atom are just summed in

C++: core::scoring::methods::LinearBranchEnergy::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, totals: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called at the end of energy evaluation

C++: core::scoring::methods::LinearBranchEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.LinearBranchEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::LinearBranchEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy

LinearChainbreakEnergy class iterates across all residues in finalize() and determines the penalty between residues i and i+1 by how much their psueduo atoms do not align.

Calculates both linear_chainbreak and overlap_chainbreak terms.

linear_chainbreak measures 3 distances (cutpoint variants must be added to pose):

virt CA res1 -> CA res2
virt C res1 -> C res2
N res1 -> virt N res2

score = 1 + 2+ 3 /3

For ideal poses, this score should be very close to 0. Real PDBs, however have bond length and angle

deviations that will cause this score to be fairly high.

See Also: protocols/forge/chainbreak_eval.hh

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, allowable_sequence_sep: int) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, : pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy¶

The auto-generated operator=() method does not properly handle pointer types.

C++: core::scoring::methods::LinearChainbreakEnergy::operator=(const class core::scoring::methods::LinearChainbreakEnergy &) –> class core::scoring::methods::LinearChainbreakEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶

clone

C++: core::scoring::methods::LinearChainbreakEnergy::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, weights: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

called during gradient-based minimization inside dfunc

F1 and F2 are not zeroed – contributions from this atom are just summed in

C++: core::scoring::methods::LinearChainbreakEnergy::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, pose: pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, totals: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called at the end of energy evaluation

C++: core::scoring::methods::LinearChainbreakEnergy::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.LinearChainbreakEnergy, : pyrosetta.rosetta.utility.vector1_bool) → None¶: C++: core::scoring::methods::LinearChainbreakEnergy::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

class pyrosetta.rosetta.core.scoring.methods.PyEnergyMethodRegistrator¶

Bases: pybind11_builtins.pybind11_object

This class will register an instance of an EnergyMethodCreator (class T) with the ScoringManager. It will ensure that no energy method creator is registered twice, and, centralizes this registration logic so that thread safety issues can be handled in one place

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(self: pyrosetta.rosetta.core.scoring.methods.PyEnergyMethodRegistrator, CreatorOP: pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) → None¶

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

class pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy¶

Bases: pyrosetta.rosetta.core.scoring.methods.EnergyMethod

Base class for EnergyMethods which are meaningful only on entire structures, for example, the Radius of Gyration. These EnergyMethods do all of their work in the “finalize_total_energy” section of score function evaluation.

__delattr__¶: Implement delattr(self, name).

__dir__() → list¶: default dir() implementation

__eq__¶: Return self==value.

__format__()¶: default object formatter

__ge__¶: Return self>=value.

__getattribute__¶: Return getattr(self, name).

__gt__¶: Return self>value.

__hash__¶: Return hash(self).

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy, : pyrosetta.rosetta.core.scoring.methods.EnergyMethodCreator) -> None
__init__(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy, arg0: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) -> None

__init_subclass__()¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__¶: Return self<=value.

__lt__¶: Return self<value.

__ne__¶: Return self!=value.

__new__()¶: Create and return a new object. See help(type) for accurate signature.

__reduce__()¶: helper for pickle

__reduce_ex__()¶: helper for pickle

__repr__¶: Return repr(self).

__setattr__¶: Implement setattr(self, name, value).

__sizeof__() → int¶: size of object in memory, in bytes

__str__¶: Return str(self).

__subclasshook__()¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

assign(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy, : pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy¶: C++: core::scoring::methods::WholeStructureEnergy::operator=(const class core::scoring::methods::WholeStructureEnergy &) –> class core::scoring::methods::WholeStructureEnergy &

atomic_interaction_cutoff(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → float¶

how far apart must two heavy atoms be to have a zero interaction energy?

If hydrogen atoms interact at the same range as heavy atoms, then this distance should build-in a 2 * max-bound-h-distance-cutoff buffer. There is an improper mixing here between run-time aquired chemical knowledge (max-bound-h-distance-cutoff) and compile time aquired scoring knowledge (max atom cutoff); this could be resolved by adding a boolean uses_hydrogen_interaction_distance() to the SRTBEnergy class along with a method of the ChemicalManager max_bound_h_distance_cutoff().

This method allows the WholeStructureEnergy class to define which edges should be included in the EnergyGraph so that during the finalize() method the Energy class can iterate across the EnergyGraph. This iteration occurrs in the SecondaryStructureEnergy class, where the edges must span 12 angstroms between the centroids. Arguably, the SecondaryStructureEnergy class could use the TwelveANeighborGraph (a context graph) and not require that the EnergyGraph span such long distances.

C++: core::scoring::methods::WholeStructureEnergy::atomic_interaction_cutoff() const –> double

clone(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.core.scoring.methods.EnergyMethod¶: C++: core::scoring::methods::EnergyMethod::clone() const –> class std::shared_ptr<class core::scoring::methods::EnergyMethod>

defines_high_order_terms(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated both in the context of the whole Pose and in the context of residue or residue-pairs? This covers scoring terms like env-smooth wherein the CBeta’s get derivatives for increasing the neighbor counts for surrounding residues, and terms like constraints, which are definable on arbitrary number of residues (e.g. more than 2); both of these terms could be used in RTMin, and both should use the residue and residue-pair evaluation scheme with the MinimizationGraph for the majority of the work they do. (Now, high-order constraints (3-body or above) will not be properly evaluated within RTMin.). The default implementation returns “false”.

C++: core::scoring::methods::EnergyMethod::defines_high_order_terms(const class core::pose::Pose &) const –> bool

eval_atom_derivative(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, id: pyrosetta.rosetta.core.id.AtomID, pose: pyrosetta.rosetta.core.pose.Pose, domain_map: ObjexxFCL::FArray1D<int>, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, emap: pyrosetta.rosetta.core.scoring.EMapVector, F1: pyrosetta.rosetta.numeric.xyzVector_double_t, F2: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Evaluate the XYZ derivative for an atom in the pose.

Called during the atomtree derivative calculation, atom_tree_minimize.cc, through the ScoreFunction::eval_atom_derivative intermediary. F1 and F2 should not zeroed, rather, this class should accumulate its contribution from this atom’s XYZ derivative

The derivative scheme is based on that of Abe, Braun, Noguti and Go (1984) “Rapid Calculation of First and Second Derivatives of Conformational Energy with Respect to Dihedral Angles for Proteins. General Recurrent Equations” Computers & Chemistry 8(4) pp. 239-247. F1 and F2 correspond roughly to Fa and Ga, respectively, of equations 7a & 7b in that paper.

C++: core::scoring::methods::EnergyMethod::eval_atom_derivative(const class core::id::AtomID &, const class core::pose::Pose &, const class ObjexxFCL::FArray1D<int> &, const class core::scoring::ScoreFunction &, const class core::scoring::EMapVector &, class numeric::xyzVector<double> &, class numeric::xyzVector<double> &) const –> void

finalize_after_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

called at the end of derivatives evaluation

C++: core::scoring::methods::EnergyMethod::finalize_after_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

finalize_total_energy(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, total_energy: pyrosetta.rosetta.core.scoring.EMapVector) → None¶

called by the ScoreFunction at the end of energy evaluation.: The derived class has the opportunity to accumulate a score into the pose’s total_energy EnergyMap. WholeStructure energies operate within this method; any method using a NeighborList during minimization would also operate within this function call.

C++: core::scoring::methods::EnergyMethod::finalize_total_energy(class core::pose::Pose &, const class core::scoring::ScoreFunction &, class core::scoring::EMapVector &) const –> void

indicate_required_context_graphs(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, context_graphs_required: pyrosetta.rosetta.utility.vector1_bool) → None¶

Indicate in the context-graphs-required list which: context-graphs this energy method requires that the Pose maintain when doing neighbor evaluation. Context graphs are allowed

C++: core::scoring::methods::EnergyMethod::indicate_required_context_graphs(class utility::vector1<bool, class std::allocator<bool> > &) const –> void

method_type(self: pyrosetta.rosetta.core.scoring.methods.WholeStructureEnergy) → pyrosetta.rosetta.core.scoring.methods.EnergyMethodType¶: C++: core::scoring::methods::WholeStructureEnergy::method_type() const –> enum core::scoring::methods::EnergyMethodType

minimize_in_whole_structure_context(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose) → bool¶

Should this EnergyMethod have score and derivative evaluation: evaluated only in the context of the whole Pose, or can it be included in a decomposed manner for a residue or a set of residue-pairs that are not part of the Pose that’s serving as their context? The default method implemented in the base class returns true in order to grandfather in EnergyMethods that have not had their derivatives changed to take advantage of the new derivative-evaluation machinery. Methods that return “true” will not have their residue-energy(-ext) / residue-pair-energy(-ext) methods invoked by the ScoreFunction during its traversal of the MinimizationGraph, and instead will be asked to perform all their work during finalize_total_energies(). Similarly, they will be expected to perform all their work during eval_atom_deriv() instead of during the ScoreFunction’s traversal of the MinimizationGraph for derivative evaluation. IMPORTANT: Methods that return “true” cannot be included in RTMin.

C++: core::scoring::methods::EnergyMethod::minimize_in_whole_structure_context(const class core::pose::Pose &) const –> bool

prepare_rotamers_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.conformation.RotamerSetBase) → None¶

If an energy method needs to cache data in a packing::RotamerSet object before: rotamer energies are calculated, it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::prepare_rotamers_for_packing(const class core::pose::Pose &, class core::conformation::RotamerSetBase &) const –> void

requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶

Does this EnergyMethod require the opportunity to examine the residue before (regular) scoring begins? Not: all energy methods would. The ScoreFunction will not ask energy methods to examine residues that are uninterested in doing so. The default implmentation of this function returns false

C++: core::scoring::methods::EnergyMethod::requires_a_setup_for_scoring_for_residue_opportunity_during_regular_scoring(const class core::pose::Pose &) const –> bool

score_types(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → pyrosetta.rosetta.utility.vector1_core_scoring_ScoreType¶

Returns the score types that this energy method computes.

C++: core::scoring::methods::EnergyMethod::score_types() const –> const class utility::vector1<enum core::scoring::ScoreType, class std::allocator<enum core::scoring::ScoreType> > &

setup_for_derivatives(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

Called immediately before atom- and DOF-derivatives are calculated: allowing the derived class a chance to prepare for future calls.

C++: core::scoring::methods::EnergyMethod::setup_for_derivatives(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_minimizing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction, : pyrosetta.rosetta.core.kinematics.MinimizerMapBase) → None¶

Called at the beginning of atom tree minimization, this method: allows the derived class the opportunity to initialize pertinent data that will be used during minimization. During minimzation, the chemical structure of the pose is constant, so assumptions on the number of atoms per residue and their identities are safe so long as the pose’s Energies object’s “use_nblist()” method returns true.

C++: core::scoring::methods::EnergyMethod::setup_for_minimizing(class core::pose::Pose &, const class core::scoring::ScoreFunction &, const class core::kinematics::MinimizerMapBase &) const –> void

setup_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.utility.vector1_bool, : pyrosetta.rosetta.utility.vector1_bool) → None¶

if an energy method needs to cache data in the Energies object,: before packing begins, then it does so during this function. The packer must ensure this function is called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_packing(class core::pose::Pose &, const class utility::vector1<bool, class std::allocator<bool> > &, const class utility::vector1<bool, class std::allocator<bool> > &) const –> void

setup_for_scoring(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.core.scoring.ScoreFunction) → None¶

if an energy method needs to cache something in the pose (e.g. in pose.energies()),: before scoring begins, it must do so in this method. All long range energy functions must initialize their LREnergyContainers before scoring begins. The default is to do nothing.

C++: core::scoring::methods::EnergyMethod::setup_for_scoring(class core::pose::Pose &, const class core::scoring::ScoreFunction &) const –> void

setup_for_scoring_for_residue(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, rsd: pyrosetta.rosetta.core.conformation.Residue, pose: pyrosetta.rosetta.core.pose.Pose, sfxn: pyrosetta.rosetta.core.scoring.ScoreFunction, residue_data_cache: pyrosetta.rosetta.basic.datacache.BasicDataCache) → None¶

Do any setup work before scoring, caching any slow-to-compute data that will be used during: energy evaluation inside of the input Residue object’s data cache. (The Residue on the whole is given as a constant reference, but non-constant access to its data cache is granted.)

C++: core::scoring::methods::EnergyMethod::setup_for_scoring_for_residue(const class core::conformation::Residue &, const class core::pose::Pose &, const class core::scoring::ScoreFunction &, class basic::datacache::BasicDataCache &) const –> void

show_additional_info(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.std.ostream, : pyrosetta.rosetta.core.pose.Pose, : bool) → None¶

show additional information of the energy method

C++: core::scoring::methods::EnergyMethod::show_additional_info(class std::basic_ostream<char> &, class core::pose::Pose &, bool) const –> void

update_residue_for_packing(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod, : pyrosetta.rosetta.core.pose.Pose, resid: int) → None¶

If the pose changes in the middle of a packing (as happens in rotamer trials) and if: an energy method needs to cache data in the pose that corresponds to its current state, then the method must update that data when this function is called. The packer must ensure this function gets called. The default behavior is to do nothing.

C++: core::scoring::methods::EnergyMethod::update_residue_for_packing(class core::pose::Pose &, unsigned long) const –> void

version(self: pyrosetta.rosetta.core.scoring.methods.EnergyMethod) → int¶

Return the version of the energy method

C++: core::scoring::methods::EnergyMethod::version() const –> unsigned long

pyrosetta.rosetta.core.scoring.methods.atoms_interact(rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, id1: pyrosetta.rosetta.core.id.AtomID, id2: pyrosetta.rosetta.core.id.AtomID, interaction_cutoff: float) → bool¶: C++: core::scoring::methods::atoms_interact(const class core::conformation::Residue &, const class core::conformation::Residue &, const class core::id::AtomID &, const class core::id::AtomID &, const double) –> bool

pyrosetta.rosetta.core.scoring.methods.create_long_range_energy_container(pose: pyrosetta.rosetta.core.pose.Pose, scoretype: pyrosetta.rosetta.core.scoring.ScoreType, lr_type: pyrosetta.rosetta.core.scoring.methods.LongRangeEnergyType) → None¶

Determines whether a long-range energies container exists in the pose energies object. If not,

creates a new one and appends the score type to it, if necessary.

Vikram K. Mulligan (vmullig.edu).

C++: core::scoring::methods::create_long_range_energy_container(class core::pose::Pose &, const enum core::scoring::ScoreType, const enum core::scoring::methods::LongRangeEnergyType) –> void

pyrosetta.rosetta.core.scoring.methods.determine_lo_and_hi_residues(pose: pyrosetta.rosetta.core.pose.Pose, rsd1: int, rsd2: int, res1_is_lo: bool, res2_is_lo: bool) → None¶

Given two residues that may or may not be connected, determine which of the two, if any,

is the lower one and which is the upper.

Inputs are rsd1 and rsd2; outputs are rsd1_is_lo and rsd2_is_lo. Both will be false if the residues aren’t conventionally connected (i.e. the C of one connected to the N of the other).

Vikram K. Mulligan (vmullig.edu).

C++: core::scoring::methods::determine_lo_and_hi_residues(const class core::pose::Pose &, const unsigned long, const unsigned long, bool &, bool &) –> void

pyrosetta.rosetta.core.scoring.methods.find_cutpoint_variants(pose: pyrosetta.rosetta.core.pose.Pose, tree: pyrosetta.rosetta.core.kinematics.FoldTree, cutpoints: pyrosetta.rosetta.utility.vector1_int) → None¶: C++: core::scoring::methods::find_cutpoint_variants(const class core::pose::Pose &, const class core::kinematics::FoldTree &, class utility::vector1<int, class std::allocator<int> > &) –> void

pyrosetta.rosetta.core.scoring.methods.find_relevant_connections_onersd(pose: pyrosetta.rosetta.core.pose.Pose, seqpos: int, branch_connection: pyrosetta.rosetta.core.scoring.methods.ResidueAtomOverlaps) → None¶: C++: core::scoring::methods::find_relevant_connections_onersd(const class core::pose::Pose &, const unsigned long, struct core::scoring::methods::ResidueAtomOverlaps &) –> void

pyrosetta.rosetta.core.scoring.methods.get_lower_cutpoint_partner_for_upper(pose: pyrosetta.rosetta.core.pose.Pose, upper_res: int) → int¶

Instead of assuming cutpoint partner is simply res-1, find which residue connects via lower/upper.

C++: core::scoring::methods::get_lower_cutpoint_partner_for_upper(const class core::pose::Pose &, const unsigned long) –> unsigned long

pyrosetta.rosetta.core.scoring.methods.get_residue_weight_by_ss(ss: str) → float¶: C++: core::scoring::methods::get_residue_weight_by_ss(char) –> double

pyrosetta.rosetta.core.scoring.methods.get_upper_cutpoint_partner_for_lower(pose: pyrosetta.rosetta.core.pose.Pose, lower_res: int) → int¶

Instead of assuming cutpoint partner is simply cutpoint+1, find which residue connects via lower/upper.

C++: core::scoring::methods::get_upper_cutpoint_partner_for_lower(const class core::pose::Pose &, const unsigned long) –> unsigned long

pyrosetta.rosetta.core.scoring.methods.is_lower_cutpoint(residue: int, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: core::scoring::methods::is_lower_cutpoint(unsigned long, const class core::pose::Pose &) –> bool

pyrosetta.rosetta.core.scoring.methods.is_upper_cutpoint(residue: int, pose: pyrosetta.rosetta.core.pose.Pose) → bool¶: C++: core::scoring::methods::is_upper_cutpoint(unsigned long, const class core::pose::Pose &) –> bool

pyrosetta.rosetta.core.scoring.methods.lower_upper_connected_across_cutpoint(lower_rsd: pyrosetta.rosetta.core.conformation.Residue, upper_rsd: pyrosetta.rosetta.core.conformation.Residue) → bool¶

helper function for looking at residue connections to get lower/upper partners

C++: core::scoring::methods::lower_upper_connected_across_cutpoint(const class core::conformation::Residue &, const class core::conformation::Residue &) –> bool

pyrosetta.rosetta.core.scoring.methods.residues_interact(rsd1: pyrosetta.rosetta.core.conformation.Residue, rsd2: pyrosetta.rosetta.core.conformation.Residue, interaction_cutoff: float) → bool¶: C++: core::scoring::methods::residues_interact(const class core::conformation::Residue &, const class core::conformation::Residue &, const double) –> bool