sugar

Bindings for protocols::stepwise::modeler::rna::sugar namespace

class pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarInstantiateMover

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarInstantiateMover, pose: pyrosetta.rosetta.core.pose.Pose) None

C++: protocols::stepwise::modeler::rna::sugar::SugarInstantiateMover::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.stepwise.modeler.rna.sugar.SugarInstantiateMover) str

C++: protocols::stepwise::modeler::rna::sugar::SugarInstantiateMover::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.

  1. show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None

  2. 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.

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

Set the ‘type’ string

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

  1. 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.stepwise.modeler.rna.sugar.SugarModeling

Bases: pybind11_object

assign(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling, : pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling) pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling

C++: protocols::stepwise::modeler::rna::sugar::SugarModeling::operator=(const class protocols::stepwise::modeler::rna::sugar::SugarModeling &) –> class protocols::stepwise::modeler::rna::sugar::SugarModeling &

property bulge_res
property bulge_res_base_state
property bulge_res_pucker_state
property bulge_suite
check_compatibility(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling, nres: int) None

C++: protocols::stepwise::modeler::rna::sugar::SugarModeling::check_compatibility(const unsigned long) const –> void

property five_prime_chain_break
property is_prepend
property moving_res
property moving_res_base_state
property moving_res_pucker_state
property pose_list
property reference_res
property sample_sugar
set_base_and_pucker_state(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling, pose: pyrosetta.rosetta.core.pose.Pose, WP: protocols::stepwise::modeler::working_parameters::StepWiseWorkingParameters) None

C++: protocols::stepwise::modeler::rna::sugar::SugarModeling::set_base_and_pucker_state(const class core::pose::Pose &, const class std::shared_ptr<const class protocols::stepwise::modeler::working_parameters::StepWiseWorkingParameters> &) –> void

class pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarVirtualizeMover

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarVirtualizeMover, pose: pyrosetta.rosetta.core.pose.Pose) None

C++: protocols::stepwise::modeler::rna::sugar::SugarVirtualizeMover::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.stepwise.modeler.rna.sugar.SugarVirtualizeMover) str

C++: protocols::stepwise::modeler::rna::sugar::SugarVirtualizeMover::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.

  1. show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None

  2. 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.

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

Set the ‘type’ string

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

  1. 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.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator

Bases: Mover

anchor_sugar_modeling(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::anchor_sugar_modeling() –> const class protocols::stepwise::modeler::rna::sugar::SugarModeling &

apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, pose_to_visualize: pyrosetta.rosetta.core.pose.Pose) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::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>

do_the_modeler(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, pose: pyrosetta.rosetta.core.pose.Pose) bool

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::do_the_modeler(class core::pose::Pose &) –> bool

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.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) str

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::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 > > &

instantiate_sugars_at_cutpoint_closed(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, pose: pyrosetta.rosetta.core.pose.Pose) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::instantiate_sugars_at_cutpoint_closed(class core::pose::Pose &) const –> void

last_proposal_density_ratio(self: pyrosetta.rosetta.protocols.moves.Mover) float

C++: protocols::moves::Mover::last_proposal_density_ratio() –> double

modeler_sugar(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) bool

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::modeler_sugar() const –> bool

modeler_sugar_at_chain_break(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) bool

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::modeler_sugar_at_chain_break() const –> bool

static name() str

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

num_sets(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) int

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::num_sets() const –> unsigned long

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

prepare_from_prior_sampled_sugar_jobs(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, pose: pyrosetta.rosetta.core.pose.Pose, starting_pose_data_list: pyrosetta.rosetta.utility.vector1_std_shared_ptr_core_pose_Pose_t, pose_explosion_legacy: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::prepare_from_prior_sampled_sugar_jobs(const class core::pose::Pose &, class utility::vector1<class std::shared_ptr<class core::pose::Pose>, class std::allocator<class std::shared_ptr<class core::pose::Pose> > > &, const bool) const –> void

prepare_from_prior_sampled_sugar_jobs_for_chain_break(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, pose: pyrosetta.rosetta.core.pose.Pose, starting_pose_data_list: pyrosetta.rosetta.utility.vector1_std_shared_ptr_core_pose_Pose_t) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::prepare_from_prior_sampled_sugar_jobs_for_chain_break(const class core::pose::Pose &, class utility::vector1<class std::shared_ptr<class core::pose::Pose>, class std::allocator<class std::shared_ptr<class core::pose::Pose> > > &) const –> 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

residue_alternative_set(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, n: int) pyrosetta.rosetta.protocols.stepwise.sampler.copy_dofs.ResidueAlternativeSet

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::residue_alternative_set(const unsigned long) –> const class protocols::stepwise::sampler::copy_dofs::ResidueAlternativeSet &

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_keep_base_fixed(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::set_keep_base_fixed(const bool &) –> 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_options(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, options: pyrosetta.rosetta.protocols.stepwise.modeler.options.StepWiseModelerOptions) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::set_options(class std::shared_ptr<const class protocols::stepwise::modeler::options::StepWiseModelerOptions>) –> void

set_scorefxn(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::set_scorefxn(class std::shared_ptr<const class core::scoring::ScoreFunction>) –> 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.

  1. show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None

  2. 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

success(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator) bool

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator::success() const –> const bool &

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.

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

Set the ‘type’ string

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

  1. 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.stepwise.modeler.rna.sugar.VirtualSugarSampler

Bases: MoverForPoseList

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, pose_to_visualize: pyrosetta.rosetta.core.pose.Pose) -> None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, pose_list: pyrosetta.rosetta.utility.vector1_std_shared_ptr_core_pose_Pose_t, pose_to_visualize: pyrosetta.rosetta.core.pose.Pose) -> None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::apply(class utility::vector1<class std::shared_ptr<class core::pose::Pose>, class std::allocator<class std::shared_ptr<class core::pose::Pose> > > &, class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.moves.MoverForPoseList, : pyrosetta.rosetta.protocols.moves.MoverForPoseList) pyrosetta.rosetta.protocols.moves.MoverForPoseList

C++: protocols::moves::MoverForPoseList::operator=(const class protocols::moves::MoverForPoseList &) –> class protocols::moves::MoverForPoseList &

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.stepwise.modeler.rna.sugar.VirtualSugarSampler) str

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::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_choose_random(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_choose_random(const bool &) –> 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_do_minimize(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_do_minimize(const bool &) –> void

set_do_screens(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_do_screens(const bool &) –> 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_integration_test_mode(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_integration_test_mode(const bool &) –> void

set_keep_base_fixed(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_keep_base_fixed(const bool &) –> void

set_legacy_mode(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_legacy_mode(const bool &) –> 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_scorefxn(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_scorefxn(class std::shared_ptr<const class core::scoring::ScoreFunction>) –> void

set_tag(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: str) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_tag(const std::string &) –> 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

set_use_phenix_geo(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_use_phenix_geo(const bool &) –> void

set_virtual_sugar_is_from_prior_step(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSampler, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSampler::set_virtual_sugar_is_from_prior_step(const bool &) –> void

show(*args, **kwargs)

Overloaded function.

  1. show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None

  2. 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.

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

Set the ‘type’ string

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

  1. 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.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, pose_to_visualize: pyrosetta.rosetta.core.pose.Pose) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::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.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList) str

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::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_choose_random(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_choose_random(const bool &) –> 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_integration_test_mode(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_integration_test_mode(const bool &) –> void

set_legacy_mode(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_legacy_mode(const bool &) –> 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_scorefxn(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_scorefxn(const class std::shared_ptr<class core::scoring::ScoreFunction> &) –> void

set_silent_file_out(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: str) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_silent_file_out(const std::string &) –> void

set_tag(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: str) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_tag(const std::string &) –> 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

set_use_phenix_geo(self: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarSamplerFromStringList, setting: bool) None

C++: protocols::stepwise::modeler::rna::sugar::VirtualSugarSamplerFromStringList::set_use_phenix_geo(const bool &) –> void

show(*args, **kwargs)

Overloaded function.

  1. show(self: pyrosetta.rosetta.protocols.moves.Mover) -> None

  2. 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.

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

Set the ‘type’ string

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

  1. 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.stepwise.modeler.rna.sugar.convert_sugar_modeling_to_residue_alternative_set(sugar_modeling: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling) pyrosetta.rosetta.protocols.stepwise.sampler.copy_dofs.ResidueAlternativeSet

C++: protocols::stepwise::modeler::rna::sugar::convert_sugar_modeling_to_residue_alternative_set(const class protocols::stepwise::modeler::rna::sugar::SugarModeling &) –> class std::shared_ptr<class protocols::stepwise::sampler::copy_dofs::ResidueAlternativeSet>

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.copy_bulge_res_and_sugar_torsion(*args, **kwargs)

Overloaded function.

  1. copy_bulge_res_and_sugar_torsion(sugar_modeling: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling, pose: pyrosetta.rosetta.core.pose.Pose, template_pose: pyrosetta.rosetta.core.pose.Pose) -> None

  2. copy_bulge_res_and_sugar_torsion(sugar_modeling: pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.SugarModeling, pose: pyrosetta.rosetta.core.pose.Pose, template_pose: pyrosetta.rosetta.core.pose.Pose, instantiate_sugar: bool) -> None

C++: protocols::stepwise::modeler::rna::sugar::copy_bulge_res_and_sugar_torsion(const class protocols::stepwise::modeler::rna::sugar::SugarModeling &, class core::pose::Pose &, const class core::pose::Pose &, bool) –> void

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.get_possible_reference_res_list_from_pose_without_fold_tree(virtual_sugar_res: int, pose: pyrosetta.rosetta.core.pose.Pose, moving_suite: int) pyrosetta.rosetta.utility.vector1_unsigned_long

C++: protocols::stepwise::modeler::rna::sugar::get_possible_reference_res_list_from_pose_without_fold_tree(const unsigned long, const class core::pose::Pose &, const unsigned long) –> class utility::vector1<unsigned long, class std::allocator<unsigned long> >

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.get_reference_res_for_each_virtual_sugar_based_on_fold_tree(pose: pyrosetta.rosetta.core.pose.Pose) pyrosetta.rosetta.std.map_unsigned_long_unsigned_long

C++: protocols::stepwise::modeler::rna::sugar::get_reference_res_for_each_virtual_sugar_based_on_fold_tree(const class core::pose::Pose &) –> const class std::map<unsigned long, unsigned long, struct std::less<unsigned long>, class std::allocator<struct std::pair<const unsigned long, unsigned long> > >

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.get_reference_res_for_each_virtual_sugar_without_fold_tree(pose: pyrosetta.rosetta.core.pose.Pose, moving_suite: int) pyrosetta.rosetta.std.map_unsigned_long_unsigned_long

C++: protocols::stepwise::modeler::rna::sugar::get_reference_res_for_each_virtual_sugar_without_fold_tree(const class core::pose::Pose &, const unsigned long) –> const class std::map<unsigned long, unsigned long, struct std::less<unsigned long>, class std::allocator<struct std::pair<const unsigned long, unsigned long> > >

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.get_reference_res_for_virtual_sugar_based_on_fold_tree(pose: pyrosetta.rosetta.core.pose.Pose, n: int) int

C++: protocols::stepwise::modeler::rna::sugar::get_reference_res_for_virtual_sugar_based_on_fold_tree(const class core::pose::Pose &, const unsigned long) –> unsigned long

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.instantiate_any_virtual_sugars(pose: pyrosetta.rosetta.core.pose.Pose, working_parameters: protocols::stepwise::modeler::working_parameters::StepWiseWorkingParameters, scorefxn: pyrosetta.rosetta.core.scoring.ScoreFunction, options: pyrosetta.rosetta.protocols.stepwise.modeler.options.StepWiseModelerOptions) pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.VirtualSugarJustInTimeInstantiator

C++: protocols::stepwise::modeler::rna::sugar::instantiate_any_virtual_sugars(class core::pose::Pose &, class std::shared_ptr<const class protocols::stepwise::modeler::working_parameters::StepWiseWorkingParameters>, class std::shared_ptr<const class core::scoring::ScoreFunction>, class std::shared_ptr<const class protocols::stepwise::modeler::options::StepWiseModelerOptions>) –> class std::shared_ptr<class protocols::stepwise::modeler::rna::sugar::VirtualSugarJustInTimeInstantiator>

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.is_sugar_virtual(*args, **kwargs)

Overloaded function.

  1. is_sugar_virtual(pose: pyrosetta.rosetta.core.pose.Pose, sugar_res: int, bulge_res: int, bulge_residues_to_virtualize: pyrosetta.rosetta.utility.vector1_unsigned_long) -> bool

C++: protocols::stepwise::modeler::rna::sugar::is_sugar_virtual(const class core::pose::Pose &, const unsigned long, const unsigned long, class utility::vector1<unsigned long, class std::allocator<unsigned long> > &) –> bool

  1. is_sugar_virtual(pose: pyrosetta.rosetta.core.pose.Pose, previous_moving_res: int, previous_bulge_res: int) -> bool

C++: protocols::stepwise::modeler::rna::sugar::is_sugar_virtual(const class core::pose::Pose &, const unsigned long, const unsigned long) –> bool

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.look_for_jumps(n: int, pose: pyrosetta.rosetta.core.pose.Pose, force_upstream: bool) int

C++: protocols::stepwise::modeler::rna::sugar::look_for_jumps(const unsigned long, const class core::pose::Pose &, const bool) –> unsigned long

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.look_for_jumps_to_next(virtual_sugar_res: int, pose: pyrosetta.rosetta.core.pose.Pose, force_upstream: bool) int

C++: protocols::stepwise::modeler::rna::sugar::look_for_jumps_to_next(const unsigned long, const class core::pose::Pose &, const bool) –> unsigned long

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.look_for_jumps_to_previous(virtual_sugar_res: int, pose: pyrosetta.rosetta.core.pose.Pose, force_upstream: bool) int

C++: protocols::stepwise::modeler::rna::sugar::look_for_jumps_to_previous(const unsigned long, const class core::pose::Pose &, const bool) –> unsigned long

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.look_for_non_jump_reference_to_next(virtual_sugar_res: int, pose: pyrosetta.rosetta.core.pose.Pose, moving_suite: int) int

C++: protocols::stepwise::modeler::rna::sugar::look_for_non_jump_reference_to_next(const unsigned long, const class core::pose::Pose &, const unsigned long) –> unsigned long

pyrosetta.rosetta.protocols.stepwise.modeler.rna.sugar.look_for_non_jump_reference_to_previous(virtual_sugar_res: int, pose: pyrosetta.rosetta.core.pose.Pose, moving_suite: int) int

C++: protocols::stepwise::modeler::rna::sugar::look_for_non_jump_reference_to_previous(const unsigned long, const class core::pose::Pose &, const unsigned long) –> unsigned long