rigid¶

Bindings for protocols::rigid namespace

class pyrosetta.rosetta.protocols.rigid.Direction¶

Bases: pybind11_object

Direction, which direction

Members:

c2n

random

n2c

c2n = <Direction.c2n: -1>¶

n2c = <Direction.n2c: 1>¶

property name¶

random = <Direction.random: 0>¶

property value¶

class pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover¶

Bases: Mover

perturb the pose along membrane normal

apply(self: pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::MembraneCenterPerturbationMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover, : pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover) → pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover¶: C++: protocols::rigid::MembraneCenterPerturbationMover::operator=(const class protocols::rigid::MembraneCenterPerturbationMover &) –> class protocols::rigid::MembraneCenterPerturbationMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.MembraneCenterPerturbationMover) → str¶: C++: protocols::rigid::MembraneCenterPerturbationMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover¶

Bases: Mover

rotation pose around membrane center, perturb the membrane normal vector relative to the pose

apply(self: pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::MembraneNormalPerturbationMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover, : pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover) → pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover¶: C++: protocols::rigid::MembraneNormalPerturbationMover::operator=(const class protocols::rigid::MembraneNormalPerturbationMover &) –> class protocols::rigid::MembraneNormalPerturbationMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.MembraneNormalPerturbationMover) → str¶: C++: protocols::rigid::MembraneNormalPerturbationMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover¶

Bases: Mover

move pose into a membrane

apply(self: pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::MovePoseToMembraneCenterMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover, : pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover) → pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover¶: C++: protocols::rigid::MovePoseToMembraneCenterMover::operator=(const class protocols::rigid::MovePoseToMembraneCenterMover &) –> class protocols::rigid::MovePoseToMembraneCenterMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

estimate_membrane_center(self: pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.numeric.xyzVector_double_t¶: C++: protocols::rigid::MovePoseToMembraneCenterMover::estimate_membrane_center(class core::pose::Pose &) –> class numeric::xyzVector<double>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.MovePoseToMembraneCenterMover) → str¶: C++: protocols::rigid::MovePoseToMembraneCenterMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.Partner¶

Bases: pybind11_object

Partner, which partner gets moved

Members:

partner_upstream

partner_downstream

property name¶

partner_downstream = <Partner.partner_downstream: 2>¶

partner_upstream = <Partner.partner_upstream: 1>¶

property value¶

class pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover¶

Bases: RigidBodySpinMover

angle_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover, angle_magnitude: float) → None¶: C++: protocols::rigid::RigidBodyDeterministicSpinMover::angle_magnitude(float) –> void

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDeterministicSpinMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover¶: C++: protocols::rigid::RigidBodyDeterministicSpinMover::operator=(const class protocols::rigid::RigidBodyDeterministicSpinMover &) –> class protocols::rigid::RigidBodyDeterministicSpinMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDeterministicSpinMover) → str¶: C++: protocols::rigid::RigidBodyDeterministicSpinMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶: C++: protocols::rigid::RigidBodySpinMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

spin_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, spin_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶: C++: protocols::rigid::RigidBodySpinMover::spin_axis(class numeric::xyzVector<double>) –> void

spin_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, spin_mag: float) → None¶: C++: protocols::rigid::RigidBodySpinMover::spin_mag(const double &) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover¶

Bases: RigidBodyMover

This Mover does a perturbation defined by the rotational and translational magnitudes. Allowed dofs are specified by a map. Can be defined through a move map or with rb_jump. A single jump is selected.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofPerturbMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover¶: C++: protocols::rigid::RigidBodyDofPerturbMover::operator=(const class protocols::rigid::RigidBodyDofPerturbMover &) –> class protocols::rigid::RigidBodyDofPerturbMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

dof(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover, dof: pyrosetta.rosetta.core.conformation.symmetry.SymDof) → None¶: C++: protocols::rigid::RigidBodyDofPerturbMover::dof(class core::conformation::symmetry::SymDof) –> void

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover) → str¶: C++: protocols::rigid::RigidBodyDofPerturbMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

rot_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyDofPerturbMover::rot_magnitude(const double) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyDofPerturbMover::trans_magnitude(const double) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover¶

Bases: RigidBodyMover

A Mover that translates down an axis determined by the available DOFs. Translations are made along all allowed directions (x,y or z) for a randomly selected jump.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofRandomTransMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover¶: C++: protocols::rigid::RigidBodyDofRandomTransMover::operator=(const class protocols::rigid::RigidBodyDofRandomTransMover &) –> class protocols::rigid::RigidBodyDofRandomTransMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover) → str¶: C++: protocols::rigid::RigidBodyDofRandomTransMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

step_size(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover, step_size_in: float) → None¶: C++: protocols::rigid::RigidBodyDofRandomTransMover::step_size(double) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_axis(*args, **kwargs)¶

Overloaded function.

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover) -> pyrosetta.rosetta.numeric.xyzVector_double_t

C++: protocols::rigid::RigidBodyDofRandomTransMover::trans_axis() –> class numeric::xyzVector<double> &

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomTransMover, trans_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) -> None

C++: protocols::rigid::RigidBodyDofRandomTransMover::trans_axis(class numeric::xyzVector<double>) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover¶

Bases: RigidBodyMover

A Mover that initializes all DOFs in the system randomly. It starts with rotation angles only.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofRandomizeMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover¶: C++: protocols::rigid::RigidBodyDofRandomizeMover::operator=(const class protocols::rigid::RigidBodyDofRandomizeMover &) –> class protocols::rigid::RigidBodyDofRandomizeMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofRandomizeMover) → str¶: C++: protocols::rigid::RigidBodyDofRandomizeMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover¶

Bases: RigidBodyMover

This Mover does a perturbation defined by the rotational and translational magnitudes. Allowed dofs are specified by a map. Can be defined through a move map or with rb_jump. All jumps are selected in random order.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::operator=(const class protocols::rigid::RigidBodyDofSeqPerturbMover &) –> class protocols::rigid::RigidBodyDofSeqPerturbMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

dofs(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover, dofs: pyrosetta.rosetta.std.map_unsigned_long_core_conformation_symmetry_SymDof) → None¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::dofs(class std::map<unsigned long, class core::conformation::symmetry::SymDof, struct std::less<unsigned long>, class std::allocator<struct std::pair<const unsigned long, class core::conformation::symmetry::SymDof> > >) –> void

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover) → str¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

rot_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::rot_magnitude(const double) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyDofSeqPerturbMover::trans_magnitude(const double) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover¶

Bases: RigidBodyMover

A Mover that initializes all DOFs in the system randomly. It starts with rotation angles only.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofSeqRandomizeMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover¶: C++: protocols::rigid::RigidBodyDofSeqRandomizeMover::operator=(const class protocols::rigid::RigidBodyDofSeqRandomizeMover &) –> class protocols::rigid::RigidBodyDofSeqRandomizeMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqRandomizeMover) → str¶: C++: protocols::rigid::RigidBodyDofSeqRandomizeMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover¶

Bases: RigidBodyMover

A Mover that translates down an axis determined by the available DOFs. Translations are made along all allowed directions (x,y or z) for a selected jump. Jumps are visited in random order

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofSeqTransMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover¶: C++: protocols::rigid::RigidBodyDofSeqTransMover::operator=(const class protocols::rigid::RigidBodyDofSeqTransMover &) –> class protocols::rigid::RigidBodyDofSeqTransMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover) → str¶: C++: protocols::rigid::RigidBodyDofSeqTransMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

step_size(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover, step_size_in: float) → None¶: C++: protocols::rigid::RigidBodyDofSeqTransMover::step_size(double) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_axis(*args, **kwargs)¶

Overloaded function.

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover) -> pyrosetta.rosetta.numeric.xyzVector_double_t

C++: protocols::rigid::RigidBodyDofSeqTransMover::trans_axis() –> class numeric::xyzVector<double> &

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofSeqTransMover, trans_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) -> None

C++: protocols::rigid::RigidBodyDofSeqTransMover::trans_axis(class numeric::xyzVector<double>) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover¶

Bases: RigidBodyMover

A Mover that translates down an axis determined by the available DOFs. Translations are made along all allowed directions (x,y or z) for a selected jump.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyDofTransMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover¶: C++: protocols::rigid::RigidBodyDofTransMover::operator=(const class protocols::rigid::RigidBodyDofTransMover &) –> class protocols::rigid::RigidBodyDofTransMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover) → str¶: C++: protocols::rigid::RigidBodyDofTransMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

last_slide_good(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover) → bool¶: C++: protocols::rigid::RigidBodyDofTransMover::last_slide_good() –> bool

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

step_size(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover, step_size_in: float) → None¶: C++: protocols::rigid::RigidBodyDofTransMover::step_size(double) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_axis(*args, **kwargs)¶

Overloaded function.

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover) -> pyrosetta.rosetta.numeric.xyzVector_double_t

C++: protocols::rigid::RigidBodyDofTransMover::trans_axis() –> class numeric::xyzVector<double> &

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyDofTransMover, trans_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) -> None

C++: protocols::rigid::RigidBodyDofTransMover::trans_axis(class numeric::xyzVector<double>) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover¶

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

Randomly selects a chunk and perturbs its rigid body transformation

C++: protocols::rigid::RigidBodyMotionMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover¶: C++: protocols::rigid::RigidBodyMotionMover::operator=(const class protocols::rigid::RigidBodyMotionMover &) –> class protocols::rigid::RigidBodyMotionMover &

chainbreak_bias(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → float¶

Returns the strength of the chainbreak bias

C++: protocols::rigid::RigidBodyMotionMover::chainbreak_bias() const –> double

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fold_tree(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → pyrosetta.rosetta.core.kinematics.FoldTree¶

Returns the input fold tree

C++: protocols::rigid::RigidBodyMotionMover::fold_tree() const –> const class core::kinematics::FoldTree &

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → str¶

Returns the name of this mover

C++: protocols::rigid::RigidBodyMotionMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

magnitude_rotation(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → float¶

Returns the magnitude of rotation

C++: protocols::rigid::RigidBodyMotionMover::magnitude_rotation() const –> double

magnitude_translation(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover) → float¶

Returns the magnitude of translation

C++: protocols::rigid::RigidBodyMotionMover::magnitude_translation() const –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_chainbreak_bias(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, cb_bias: float) → None¶

Updates the strength of the chainbreak bias

C++: protocols::rigid::RigidBodyMotionMover::set_chainbreak_bias(double) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_fold_tree(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, tree: pyrosetta.rosetta.core.kinematics.FoldTree) → None¶

Updates the input fold tree and regenerates chunks

C++: protocols::rigid::RigidBodyMotionMover::set_fold_tree(const class core::kinematics::FoldTree &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_magnitude_rotation(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, mag_rot: float) → None¶

Updates the magnitude of rotation

C++: protocols::rigid::RigidBodyMotionMover::set_magnitude_rotation(double) –> void

set_magnitude_translation(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMotionMover, mag_trans: float) → None¶

Updates the magnitude of translation

C++: protocols::rigid::RigidBodyMotionMover::set_magnitude_translation(double) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.RigidBodyMover¶

Bases: ThermodynamicMover

Rigid-body random translate/rotate around centroid of downstream side of a jump.

We operate on a single jump rather than e.g. a randomly selected jump from the mobile jumps in a MoveMap. If you want a random choice among jumps, put multiple RigidBodyMovers into a RandomMover (which will give you more control, anyway).

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyMover¶: C++: protocols::rigid::RigidBodyMover::operator=(const class protocols::rigid::RigidBodyMover &) –> class protocols::rigid::RigidBodyMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → str¶: C++: protocols::rigid::RigidBodyMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover¶

Bases: RigidBodyMover

This Mover does a perturbation defined by the rotational and translational magnitudes.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyPerturbMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover¶: C++: protocols::rigid::RigidBodyPerturbMover::operator=(const class protocols::rigid::RigidBodyPerturbMover &) –> class protocols::rigid::RigidBodyPerturbMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover) → str¶: C++: protocols::rigid::RigidBodyPerturbMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_rot_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover) → float¶: C++: protocols::rigid::RigidBodyPerturbMover::get_rot_mag() const –> double

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_trans_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover) → float¶: C++: protocols::rigid::RigidBodyPerturbMover::get_trans_mag() const –> double

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, : pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyPerturbMover::rot_center(const class numeric::xyzVector<double> &) –> void

rot_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyPerturbMover::rot_magnitude(const double) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyPerturbMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyPerturbMover::trans_magnitude(const double) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover¶

Bases: RigidBodyMover

does a perturbation defined by the rotational and translational magnitudes without setting up the center Can be defined through a move map or with rb_jump Defining through a movemap with multiple jumps leads to a random jump being chosen at apply time, NOT at construction time! This is done to simplify docking with more than one active jump.

add_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, : int) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::add_jump(unsigned long) –> void

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::operator=(const class protocols::rigid::RigidBodyPerturbNoCenterMover &) –> class protocols::rigid::RigidBodyPerturbNoCenterMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clear_jumps(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::clear_jumps() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover) → str¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static mover_name() → str¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::mover_name() –> std::string

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

rot_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::rot_magnitude(const double) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_magnitude(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMover, magnitude: float) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMover::trans_magnitude(const double) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator, : pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator) → pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMoverCreator::operator=(const class protocols::rigid::RigidBodyPerturbNoCenterMoverCreator &) –> class protocols::rigid::RigidBodyPerturbNoCenterMoverCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator) → str¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMoverCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbNoCenterMoverCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyPerturbNoCenterMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover¶

Bases: RigidBodyMover

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyPerturbRandomJumpMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover¶: C++: protocols::rigid::RigidBodyPerturbRandomJumpMover::operator=(const class protocols::rigid::RigidBodyPerturbRandomJumpMover &) –> class protocols::rigid::RigidBodyPerturbRandomJumpMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyPerturbRandomJumpMover) → str¶: C++: protocols::rigid::RigidBodyPerturbRandomJumpMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover¶

Bases: RigidBodyMover

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyRandomizeMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover¶: C++: protocols::rigid::RigidBodyRandomizeMover::operator=(const class protocols::rigid::RigidBodyRandomizeMover &) –> class protocols::rigid::RigidBodyRandomizeMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover) → str¶: C++: protocols::rigid::RigidBodyRandomizeMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_phi(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover) → float¶: C++: protocols::rigid::RigidBodyRandomizeMover::get_phi() const –> double

get_psi(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover) → float¶: C++: protocols::rigid::RigidBodyRandomizeMover::get_psi() const –> double

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyRandomizeMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyRandomizeMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover¶

Bases: RigidBodyMover

A Mover that spins about a random axis.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodySpinMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, : pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover) → pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover¶: C++: protocols::rigid::RigidBodySpinMover::operator=(const class protocols::rigid::RigidBodySpinMover &) –> class protocols::rigid::RigidBodySpinMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover) → str¶: C++: protocols::rigid::RigidBodySpinMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶: C++: protocols::rigid::RigidBodySpinMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

spin_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, spin_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶: C++: protocols::rigid::RigidBodySpinMover::spin_axis(class numeric::xyzVector<double>) –> void

spin_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodySpinMover, spin_mag: float) → None¶: C++: protocols::rigid::RigidBodySpinMover::spin_mag(const double &) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover¶

Bases: RigidBodyMover

A Mover that tilts around the spin axis.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyTiltMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover¶: C++: protocols::rigid::RigidBodyTiltMover::operator=(const class protocols::rigid::RigidBodyTiltMover &) –> class protocols::rigid::RigidBodyTiltMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTiltMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTiltMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover) → str¶: C++: protocols::rigid::RigidBodyTiltMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static mover_name() → str¶: C++: protocols::rigid::RigidBodyTiltMover::mover_name() –> std::string

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::RigidBodyTiltMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyTiltMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

spin_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, spin_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶: C++: protocols::rigid::RigidBodyTiltMover::spin_axis(const class numeric::xyzVector<double> &) –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

tilt1_center(*args, **kwargs)¶

Overloaded function.

tilt1_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt1_center_in: int) -> None

C++: protocols::rigid::RigidBodyTiltMover::tilt1_center(const unsigned long) –> void

tilt1_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt1_center_in: pyrosetta.rosetta.core.pose.ResidueIndexDescription) -> None

C++: protocols::rigid::RigidBodyTiltMover::tilt1_center(class std::shared_ptr<const class core::pose::ResidueIndexDescription>) –> void

tilt1_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt1_mag_in: float) → None¶: C++: protocols::rigid::RigidBodyTiltMover::tilt1_mag(const double) –> void

tilt2_center(*args, **kwargs)¶

Overloaded function.

tilt2_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt2_center_in: int) -> None

C++: protocols::rigid::RigidBodyTiltMover::tilt2_center(const unsigned long) –> void

tilt2_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt2_center_in: pyrosetta.rosetta.core.pose.ResidueIndexDescription) -> None

C++: protocols::rigid::RigidBodyTiltMover::tilt2_center(class std::shared_ptr<const class core::pose::ResidueIndexDescription>) –> void

tilt2_mag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMover, tilt2_mag_in: float) → None¶: C++: protocols::rigid::RigidBodyTiltMover::tilt2_mag(const double) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator, : pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator) → pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator¶: C++: protocols::rigid::RigidBodyTiltMoverCreator::operator=(const class protocols::rigid::RigidBodyTiltMoverCreator &) –> class protocols::rigid::RigidBodyTiltMoverCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTiltMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator) → str¶: C++: protocols::rigid::RigidBodyTiltMoverCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTiltMoverCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyTiltMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover¶

Bases: RigidBodyMover

This Mover translate down an axis.

apply(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RigidBodyTransMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, : pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) → pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover¶: C++: protocols::rigid::RigidBodyTransMover::operator=(const class protocols::rigid::RigidBodyTransMover &) –> class protocols::rigid::RigidBodyTransMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTransMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTransMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) → str¶: C++: protocols::rigid::RigidBodyTransMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static mover_name() → str¶: C++: protocols::rigid::RigidBodyTransMover::mover_name() –> std::string

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, tag: pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::RigidBodyTransMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyTransMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

step_size(*args, **kwargs)¶

Overloaded function.

step_size(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, step_size_in: float) -> None

C++: protocols::rigid::RigidBodyTransMover::step_size(double) –> void

step_size(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) -> float

C++: protocols::rigid::RigidBodyTransMover::step_size() –> double

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

trans_axis(*args, **kwargs)¶

Overloaded function.

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover) -> pyrosetta.rosetta.numeric.xyzVector_double_t

C++: protocols::rigid::RigidBodyTransMover::trans_axis() –> class numeric::xyzVector<double> &

trans_axis(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, trans_axis_in: pyrosetta.rosetta.numeric.xyzVector_double_t) -> None

C++: protocols::rigid::RigidBodyTransMover::trans_axis(class numeric::xyzVector<double>) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

vary_stepsize(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMover, vary: bool) → None¶: C++: protocols::rigid::RigidBodyTransMover::vary_stepsize(bool) –> void

class pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator, : pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator) → pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator¶: C++: protocols::rigid::RigidBodyTransMoverCreator::operator=(const class protocols::rigid::RigidBodyTransMoverCreator &) –> class protocols::rigid::RigidBodyTransMoverCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RigidBodyTransMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator) → str¶: C++: protocols::rigid::RigidBodyTransMoverCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.RigidBodyTransMoverCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RigidBodyTransMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.RollMover¶

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.rigid.RollMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RollMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.RollMover, : pyrosetta.rosetta.protocols.rigid.RollMover) → pyrosetta.rosetta.protocols.rigid.RollMover¶: C++: protocols::rigid::RollMover::operator=(const class protocols::rigid::RollMover &) –> class protocols::rigid::RollMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.RollMover) → pyrosetta.rosetta.protocols.moves.Mover¶

required in the context of the parser/scripting scheme

C++: protocols::rigid::RollMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.rigid.RollMover) → pyrosetta.rosetta.protocols.moves.Mover¶

required in the context of the parser/scripting scheme

C++: protocols::rigid::RollMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RollMover) → str¶: C++: protocols::rigid::RollMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static mover_name() → str¶: C++: protocols::rigid::RollMover::mover_name() –> std::string

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.RollMover, : pyrosetta.rosetta.utility.tag.Tag, : pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::RollMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RollMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_min_max_angles(self: pyrosetta.rosetta.protocols.rigid.RollMover, min_angle: float, max_angle: float) → None¶: C++: protocols::rigid::RollMover::set_min_max_angles(double, double) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.RollMoverCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.RollMoverCreator, : pyrosetta.rosetta.protocols.rigid.RollMoverCreator) → pyrosetta.rosetta.protocols.rigid.RollMoverCreator¶: C++: protocols::rigid::RollMoverCreator::operator=(const class protocols::rigid::RollMoverCreator &) –> class protocols::rigid::RollMoverCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.RollMoverCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::RollMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.RollMoverCreator) → str¶: C++: protocols::rigid::RollMoverCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.RollMoverCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::RollMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.RotateJumpAxisMover¶

Bases: Mover

This mover rotates a jump transform. Its original use was to rotate a freely rotateable zinc-histidine bond as emulated by an atom-to-atom fixed-length jump. It recalculates the Stubs for the jump and applies the new jump, resulting in an N degree rotation of one partner about the axis between the histidine nitrogen and the zinc. It will work for any jump but is intended for atom-atom jumps (not residue-residue jumps). It will choose an angle from the uniform random distribution bounded by inputs (defaults to (-180,180]); if you want a particular value then set the limits equal.

apply(self: pyrosetta.rosetta.protocols.rigid.RotateJumpAxisMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::RotateJumpAxisMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::operator=(const class protocols::moves::Mover &) –> class protocols::moves::Mover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.RotateJumpAxisMover) → str¶: C++: protocols::rigid::RotateJumpAxisMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM¶

Bases: ClientMover

apply(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::UniformRigidBodyCM::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, : pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM) → pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM¶: C++: protocols::rigid::UniformRigidBodyCM::operator=(const class protocols::rigid::UniformRigidBodyCM &) –> class protocols::rigid::UniformRigidBodyCM &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyCM::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyCM::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM) → str¶: C++: protocols::rigid::UniformRigidBodyCM::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::UniformRigidBodyCM::initialize(class core::pose::Pose &) –> void

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static mover_name() → str¶: C++: protocols::rigid::UniformRigidBodyCM::mover_name() –> std::string

name(*args, **kwargs)¶

Overloaded function.

name(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM) -> str

C++: protocols::rigid::UniformRigidBodyCM::name() const –> const std::string &

name(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, name: str) -> None

C++: protocols::rigid::UniformRigidBodyCM::name(const std::string &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::UniformRigidBodyCM::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::UniformRigidBodyCM::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

yield_claims(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCM, : pyrosetta.rosetta.core.pose.Pose, : pyrosetta.rosetta.basic.datacache.WriteableCacheableMap) → pyrosetta.rosetta.std.list_std_shared_ptr_protocols_environment_claims_EnvClaim_t¶: C++: protocols::rigid::UniformRigidBodyCM::yield_claims(const class core::pose::Pose &, class std::shared_ptr<class basic::datacache::WriteableCacheableMap>) –> class std::list<class std::shared_ptr<class protocols::environment::claims::EnvClaim>, class std::allocator<class std::shared_ptr<class protocols::environment::claims::EnvClaim> > >

yield_submovers(self: pyrosetta.rosetta.protocols.environment.ClientMover, : pyrosetta.rosetta.std.set_std_shared_ptr_protocols_environment_ClientMover_t) → None¶

this method is used to make sure any movers contained in this: mover (that want to make claims) also get registered with the environment.

C++: protocols::environment::ClientMover::yield_submovers(class std::set<class std::shared_ptr<class protocols::environment::ClientMover>, struct std::less<class std::shared_ptr<class protocols::environment::ClientMover> >, class std::allocator<class std::shared_ptr<class protocols::environment::ClientMover> > > &) const –> void

class pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator, : pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator) → pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator¶: C++: protocols::rigid::UniformRigidBodyCMCreator::operator=(const class protocols::rigid::UniformRigidBodyCMCreator &) –> class protocols::rigid::UniformRigidBodyCMCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyCMCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator) → str¶: C++: protocols::rigid::UniformRigidBodyCMCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyCMCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::UniformRigidBodyCMCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover¶

Bases: ThermodynamicMover

apply(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, : pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::UniformRigidBodyMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, : pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) → pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover¶: C++: protocols::rigid::UniformRigidBodyMover::operator=(const class protocols::rigid::UniformRigidBodyMover &) –> class protocols::rigid::UniformRigidBodyMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyMover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

static complex_type_gen() → utility::tag::XMLSchemaComplexTypeGenerator¶: C++: protocols::rigid::UniformRigidBodyMover::complex_type_gen() –> class std::shared_ptr<class utility::tag::XMLSchemaComplexTypeGenerator>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

fresh_instance(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyMover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) → str¶: C++: protocols::rigid::UniformRigidBodyMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

jump_number(*args, **kwargs)¶

Overloaded function.

jump_number(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, : int) -> None

C++: protocols::rigid::UniformRigidBodyMover::jump_number(int) –> void

jump_number(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) -> int

C++: protocols::rigid::UniformRigidBodyMover::jump_number() const –> int

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static mover_name() → str¶: C++: protocols::rigid::UniformRigidBodyMover::mover_name() –> std::string

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶: C++: protocols::rigid::UniformRigidBodyMover::parse_my_tag(class std::shared_ptr<const class utility::tag::Tag>, class basic::datacache::DataMap &) –> void

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover) → bool¶: C++: protocols::rigid::UniformRigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static provide_xml_schema(xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::UniformRigidBodyMover::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, : bool) → None¶: C++: protocols::rigid::UniformRigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶: C++: protocols::rigid::UniformRigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator¶

Bases: MoverCreator

assign(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator, : pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator) → pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator¶: C++: protocols::rigid::UniformRigidBodyMoverCreator::operator=(const class protocols::rigid::UniformRigidBodyMoverCreator &) –> class protocols::rigid::UniformRigidBodyMoverCreator &

create_mover(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::rigid::UniformRigidBodyMoverCreator::create_mover() const –> class std::shared_ptr<class protocols::moves::Mover>

keyname(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator) → str¶: C++: protocols::rigid::UniformRigidBodyMoverCreator::keyname() const –> std::string

provide_xml_schema(self: pyrosetta.rosetta.protocols.rigid.UniformRigidBodyMoverCreator, xsd: utility::tag::XMLSchemaDefinition) → None¶: C++: protocols::rigid::UniformRigidBodyMoverCreator::provide_xml_schema(class utility::tag::XMLSchemaDefinition &) const –> void

class pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover¶

Bases: RigidBodyMover

Rigid-body move that evenly samples the space within a sphere

apply(self: pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::UniformSphereTransMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover, : pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover) → pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover¶: C++: protocols::rigid::UniformSphereTransMover::operator=(const class protocols::rigid::UniformSphereTransMover &) –> class protocols::rigid::UniformSphereTransMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

finalize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after all Monte Carlo trials are completed.

C++: protocols::canonical_sampling::ThermodynamicMover::finalize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

freeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::freeze() –> void

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.UniformSphereTransMover) → str¶: C++: protocols::rigid::UniformSphereTransMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

initialize_simulation(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, pose: pyrosetta.rosetta.core.pose.Pose, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover, cycle: int) → None¶

Callback executed before any Monte Carlo trials are attempted.

C++: protocols::canonical_sampling::ThermodynamicMover::initialize_simulation(class core::pose::Pose &, const class protocols::canonical_sampling::MetropolisHastingsMover &, unsigned long) –> void

is_multi_trial(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → bool¶

Return true if the move performs multiple trials on each apply.

last_inner_score_delta_over_temperature()

metropolis_hastings_mover()

set_metropolis_hastings_mover()

C++: protocols::canonical_sampling::ThermodynamicMover::is_multi_trial() –> bool

last_inner_score_delta_over_temperature(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

If this is a multi-trial move, return the change in internal

score/temperature caused by the last call to apply().

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::last_inner_score_delta_over_temperature() –> double

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → float¶

Return the proposal density ratio for last apply method.

C++: protocols::canonical_sampling::ThermodynamicMover::last_proposal_density_ratio() –> double

metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover) → pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t¶

If this is a multi-trial move, return the MetropolisHastingsMover

being used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::metropolis_hastings_mover() –> class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

observe_after_metropolis(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: protocols::canonical_sampling::MetropolisHastingsMover) → None¶

Callback executed after the Metropolis criterion is evaluated.

C++: protocols::canonical_sampling::ThermodynamicMover::observe_after_metropolis(const class protocols::canonical_sampling::MetropolisHastingsMover &) –> void

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → bool¶: C++: protocols::rigid::RigidBodyMover::preserve_detailed_balance() const –> bool

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

rb_jump(*args, **kwargs)¶

Overloaded function.

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> int

C++: protocols::rigid::RigidBodyMover::rb_jump() const –> int

rb_jump(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, jump_id: int) -> None

C++: protocols::rigid::RigidBodyMover::rb_jump(int) –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

rot_center(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, rot_center_in: pyrosetta.rosetta.numeric.xyzVector_double_t) → None¶

Manual override of rotation center.

C++: protocols::rigid::RigidBodyMover::rot_center(const class numeric::xyzVector<double> &) –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_metropolis_hastings_mover(self: pyrosetta.rosetta.protocols.canonical_sampling.ThermodynamicMover, metropolis_hastings_mover: pyrosetta.rosetta.std.weak_ptr_protocols_canonical_sampling_MetropolisHastingsMover_t) → None¶

If this is a multi-trial move, set the MetropolisHastingsMover to

be used internally.

is_multi_trial()

C++: protocols::canonical_sampling::ThermodynamicMover::set_metropolis_hastings_mover(class std::weak_ptr<class protocols::canonical_sampling::MetropolisHastingsMover>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_preserve_detailed_balance(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, : bool) → None¶

set whether detailed balance is preserved (i.e. no branch angle optimization during moves)

C++: protocols::rigid::RigidBodyMover::set_preserve_detailed_balance(bool) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) -> None
show(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, output: pyrosetta.rosetta.std.ostream) -> None

C++: protocols::rigid::RigidBodyMover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

torsion_id_ranges(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover, pose: pyrosetta.rosetta.core.pose.Pose) → pyrosetta.rosetta.utility.vector1_core_id_TorsionID_Range¶

get the TorsionIDs perturbed by the mover during moves, along with their ranges

C++: protocols::rigid::RigidBodyMover::torsion_id_ranges(class core::pose::Pose &) –> class utility::vector1<class core::id::TorsionID_Range, class std::allocator<class core::id::TorsionID_Range> >

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

unfreeze(self: pyrosetta.rosetta.protocols.rigid.RigidBodyMover) → None¶: C++: protocols::rigid::RigidBodyMover::unfreeze() –> void

class pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover¶

Bases: Mover

rotate the whole pose

apply(self: pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::WholeBodyRotationMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover, : pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover) → pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover¶: C++: protocols::rigid::WholeBodyRotationMover::operator=(const class protocols::rigid::WholeBodyRotationMover &) –> class protocols::rigid::WholeBodyRotationMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.WholeBodyRotationMover) → str¶: C++: protocols::rigid::WholeBodyRotationMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

class pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover¶

Bases: Mover

translate the whole pose

apply(self: pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶: C++: protocols::rigid::WholeBodyTranslationMover::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover, : pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover) → pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover¶: C++: protocols::rigid::WholeBodyTranslationMover::operator=(const class protocols::rigid::WholeBodyTranslationMover &) –> class protocols::rigid::WholeBodyTranslationMover &

clear_info(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file.

clear_info is called by jd2 before calling apply

C++: protocols::moves::Mover::clear_info() –> void

clone(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Return a clone of the Mover object.

C++: protocols::moves::Mover::clone() const –> class std::shared_ptr<class protocols::moves::Mover>

create(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::create() –> class std::shared_ptr<class protocols::moves::Mover>

fresh_instance(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶

Generates a new Mover object freshly created with the default ctor.

C++: protocols::moves::Mover::fresh_instance() const –> class std::shared_ptr<class protocols::moves::Mover>

get_additional_output(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶

fpd

Mechanism by which a mover may return multiple output poses from a single input pose.

Supported in JD2. Will attempt to grab additional poses until a nullptr is returned.

C++: protocols::moves::Mover::get_additional_output() –> class std::shared_ptr<class core::pose::Pose>

get_current_job(self: pyrosetta.rosetta.protocols.moves.Mover) → protocols::jobdist::BasicJob¶: C++: protocols::moves::Mover::get_current_job() const –> class std::shared_ptr<const class protocols::jobdist::BasicJob>

get_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶

A tag is a unique identifier used to identify structures produced: by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor.

C++: protocols::moves::Mover::get_current_tag() const –> std::string

get_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_input_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_last_move_status(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.MoverStatus¶

returns status after an apply(). The job distributor (august 08 vintage) will check this function to see if your protocol wants to filter its results - if your protocol wants to say “that run was no good, skip it” then use the protected last_move_status(MoverStatus) to change the value that this function will return.

C++: protocols::moves::Mover::get_last_move_status() const –> enum protocols::moves::MoverStatus

get_name(self: pyrosetta.rosetta.protocols.rigid.WholeBodyTranslationMover) → str¶: C++: protocols::rigid::WholeBodyTranslationMover::get_name() const –> std::string

get_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.core.pose.Pose¶: C++: protocols::moves::Mover::get_native_pose() const –> class std::shared_ptr<const class core::pose::Pose>

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover¶: C++: protocols::moves::Mover::get_self_ptr() –> class std::shared_ptr<class protocols::moves::Mover>

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t¶: C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

get_type(self: pyrosetta.rosetta.protocols.moves.Mover) → str¶: C++: protocols::moves::Mover::get_type() const –> std::string

info(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.list_std_string_t¶

non-const accessor

C++: protocols::moves::Mover::info() –> class std::list<std::string, class std::allocator<std::string > > &

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) → float¶: C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

static name() → str¶: C++: protocols::moves::Mover::name() –> std::string

parse_my_tag(self: pyrosetta.rosetta.protocols.moves.Mover, tag: pyrosetta.rosetta.utility.tag.Tag, data: pyrosetta.rosetta.basic.datacache.DataMap) → None¶

Called by MoverFactory when constructing new Movers. Takes care of the specific mover’s parsing.

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

provide_citation_info(self: pyrosetta.rosetta.protocols.moves.Mover, : pyrosetta.rosetta.basic.citation_manager.CitationCollectionList) → None¶

Provide citations to the passed CitationCollectionList

Subclasses should add the info for themselves and any other classes they use.

The default implementation of this function does nothing. It may be overriden by movers wishing to provide citation information.

C++: protocols::moves::Mover::provide_citation_info(class basic::citation_manager::CitationCollectionList &) const –> void

static register_options() → None¶

Overload this static method if you access options within the mover.

These options will end up in -help of your application if users of this mover call register_options. Do this recursively! If you use movers within your mover, call their register_options in your register_options() method.

C++: protocols::moves::Mover::register_options() –> void

reinitialize_for_each_job(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be freshly regenerated on: each use.

C++: protocols::moves::Mover::reinitialize_for_each_job() const –> bool

reinitialize_for_new_input(self: pyrosetta.rosetta.protocols.moves.Mover) → bool¶

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input: pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

C++: protocols::moves::Mover::reinitialize_for_new_input() const –> bool

reset_status(self: pyrosetta.rosetta.protocols.moves.Mover) → None¶

resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s.

C++: protocols::moves::Mover::reset_status() –> void

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None¶: C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None¶: C++: protocols::moves::Mover::set_current_tag(const std::string &) –> void

set_input_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for poses contained for rms

C++: protocols::moves::Mover::set_input_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_native_pose(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

setter for native poses contained for rms —- we should get rid of this method? it is widely used, but a bit unsafe

C++: protocols::moves::Mover::set_native_pose(class std::shared_ptr<const class core::pose::Pose>) –> void

set_type(self: pyrosetta.rosetta.protocols.moves.Mover, setting: str) → None¶

Set the ‘type’ string

C++: protocols::moves::Mover::set_type(const std::string &) –> void

show(*args, **kwargs)¶

Overloaded function.

show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None
show(self: pyrosetta.rosetta.protocols.moves.Mover, output: pyrosetta.rosetta.std.ostream) -> None

Outputs details about the Mover, including current settings.

C++: protocols::moves::Mover::show(std::ostream &) const –> void

test_move(self: pyrosetta.rosetta.protocols.moves.Mover, pose: pyrosetta.rosetta.core.pose.Pose) → None¶

: Unit test support function. Apply one move to a given pose.: Allows extra test specific functions to be called before applying

C++: protocols::moves::Mover::test_move(class core::pose::Pose &) –> void

type(*args, **kwargs)¶

Overloaded function.

type(self: pyrosetta.rosetta.protocols.moves.Mover, type_in: str) -> None

Set the ‘type’ string

C++: protocols::moves::Mover::type(const std::string &) –> void

type(self: pyrosetta.rosetta.protocols.moves.Mover) -> str

Get the set ‘type’ string

C++: protocols::moves::Mover::type() const –> const std::string &

pyrosetta.rosetta.protocols.rigid.gaussian_jump_move(*args, **kwargs)¶

Overloaded function.

gaussian_jump_move(pose: pyrosetta.rosetta.core.pose.Pose, mm: pyrosetta.rosetta.core.kinematics.MoveMap, translation_magnitude: float, rotation_magnitude: float) -> int
gaussian_jump_move(pose: pyrosetta.rosetta.core.pose.Pose, mm: pyrosetta.rosetta.core.kinematics.MoveMap, translation_magnitude: float, rotation_magnitude: float, dir: int) -> int

C++: protocols::rigid::gaussian_jump_move(class core::pose::Pose &, const class core::kinematics::MoveMap &, const double, const double, const int) –> int

gaussian_jump_move(pose: pyrosetta.rosetta.core.pose.Pose, jump_number: int, translation_magnitude: float, rotation_magnitude: float) -> None
gaussian_jump_move(pose: pyrosetta.rosetta.core.pose.Pose, jump_number: int, translation_magnitude: float, rotation_magnitude: float, dir: int) -> None

C++: protocols::rigid::gaussian_jump_move(class core::pose::Pose &, const int, const double, const double, int) –> void