sampler

Bindings for protocols::stepwise::sampler namespace

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler

Bases: SamplerPlusPlus

apply(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus, : pyrosetta.rosetta.core.pose.Pose) → None

Apply the current rotamer to pose

C++: protocols::toolbox::SamplerPlusPlus::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler

C++: protocols::stepwise::sampler::StepWiseSampler::operator=(const class protocols::stepwise::sampler::StepWiseSampler &) –> class protocols::stepwise::sampler::StepWiseSampler &

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.toolbox.SamplerPlusPlus) → str

Name of the class

C++: protocols::toolbox::SamplerPlusPlus::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 > > &

init(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus) → None

Initialization

C++: protocols::toolbox::SamplerPlusPlus::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if there are more rotamers available

C++: protocols::stepwise::sampler::StepWiseSampler::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus) → None

Move to next rotamer

C++: protocols::toolbox::SamplerPlusPlus::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus) → None

Reset to the first (or random if random()) rotamer

C++: protocols::toolbox::SamplerPlusPlus::reset() –> void

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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus) -> None

  2. show(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus, output: pyrosetta.rosetta.std.ostream) -> None

  3. show(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::toolbox::SamplerPlusPlus::show(std::ostream &, const unsigned long) 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(self: pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlus) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::toolbox::SamplerPlusPlus::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb

Bases: StepWiseSampler

add_external_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → None

Add one more rotamer sampler to this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerComb::add_external_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSampler> &) –> void

apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, pose: pyrosetta.rosetta.core.pose.Pose) → None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerComb::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb

C++: protocols::stepwise::sampler::StepWiseSamplerComb::operator=(const class protocols::stepwise::sampler::StepWiseSamplerComb &) –> class protocols::stepwise::sampler::StepWiseSamplerComb &

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_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → None

Clear all rotamer samplers stored in this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerComb::clear_rotamer() –> 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.sampler.StepWiseSamplerComb) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerComb::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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerComb::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerComb::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerComb::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → None

Reset to the first (or random if random()) rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerComb::reset() –> void

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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSamplerComb::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerComb::show(std::ostream &, const unsigned long) 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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerComb) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerComb::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF

Bases: StepWiseSamplerOneValue

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose //

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF, pose: pyrosetta.rosetta.core.pose.Pose, i: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSized &) –> class protocols::stepwise::sampler::StepWiseSamplerSized &

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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerOneDOF) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Reset to the first (or random if random()) rotamer.

C++: protocols::stepwise::sampler::StepWiseSamplerSized::reset() –> void

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_DOF_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF, setting: pyrosetta.rosetta.core.id.DOF_ID) → None

Set the DOF_ID of the sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::set_DOF_id(const class core::id::DOF_ID &) –> void

set_DOFs(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF, setting: pyrosetta.rosetta.utility.vector1_double) → None

Set the allowed DOFs in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::set_DOFs(const class utility::vector1<double, class std::allocator<double> > &) –> void

set_atom_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF, setting: pyrosetta.rosetta.core.id.AtomID) → None

Set the atom id being sampled

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::set_atom_id(const class core::id::AtomID &) –> 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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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

set_values(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, setting: pyrosetta.rosetta.utility.vector1_double) → None

Set the allowed values in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::set_values(const class utility::vector1<double, class std::allocator<double> > &) –> void

show(*args, **kwargs)

Overloaded function.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneDOF) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerOneDOF::type() const –> enum protocols::toolbox::SamplerPlusPlusType

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) -> float

Get the value of current value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value() const –> double

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, i: int) -> float

Get the value of i-th value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value(const unsigned long) const –> double

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion

Bases: StepWiseSamplerOneValue

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion, pose: pyrosetta.rosetta.core.pose.Pose, i: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSized &) –> class protocols::stepwise::sampler::StepWiseSamplerSized &

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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerOneTorsion) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Reset to the first (or random if random()) rotamer.

C++: protocols::stepwise::sampler::StepWiseSamplerSized::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const bool) –> void

set_rsd_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion, setting: int) → None

Set the residue id being sampled

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::set_rsd_id(const unsigned long) –> void

set_torsion_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion, setting: pyrosetta.rosetta.core.id.TorsionID) → None

Set the TorsionID of the sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::set_torsion_id(const class core::id::TorsionID &) –> void

set_torsions(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion, setting: pyrosetta.rosetta.utility.vector1_double) → None

Set the allowed torsions in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::set_torsions(const class utility::vector1<double, class std::allocator<double> > &) –> 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_values(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, setting: pyrosetta.rosetta.utility.vector1_double) → None

Set the allowed values in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::set_values(const class utility::vector1<double, class std::allocator<double> > &) –> void

show(*args, **kwargs)

Overloaded function.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneTorsion) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerOneTorsion::type() const –> enum protocols::toolbox::SamplerPlusPlusType

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) -> float

Get the value of current value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value() const –> double

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, i: int) -> float

Get the value of i-th value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value(const unsigned long) const –> double

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue

Bases: StepWiseSamplerSized

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, : pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, : pyrosetta.rosetta.core.pose.Pose, : int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSized &) –> class protocols::stepwise::sampler::StepWiseSamplerSized &

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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerOneValue) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Reset to the first (or random if random()) rotamer.

C++: protocols::stepwise::sampler::StepWiseSamplerSized::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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

set_values(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, setting: pyrosetta.rosetta.utility.vector1_double) → None

Set the allowed values in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::set_values(const class utility::vector1<double, class std::allocator<double> > &) –> void

show(*args, **kwargs)

Overloaded function.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::type() const –> enum protocols::toolbox::SamplerPlusPlusType

value(*args, **kwargs)

Overloaded function.

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) -> float

Get the value of current value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value() const –> double

  1. value(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue, i: int) -> float

Get the value of i-th value

C++: protocols::stepwise::sampler::StepWiseSamplerOneValue::value(const unsigned long) const –> double

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb

Bases: StepWiseSamplerSizedComb

add_external_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValue) → None

Add one more rotamer sampler to this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::add_external_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSamplerOneValue> &) –> void

add_internal_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None
Add one more rotamer sampler to this sampler. This one is ‘internal’ to

existing rotamers, i.e., when this one completes its cycle, the existing

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::add_internal_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSamplerSized> &) –> void

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, pose: pyrosetta.rosetta.core.pose.Pose, id: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::operator=(const class protocols::stepwise::sampler::StepWiseSamplerOneValueComb &) –> class protocols::stepwise::sampler::StepWiseSamplerOneValueComb &

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_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Clear all rotamer samplers stored in this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::clear_rotamer() –> 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>

fast_forward(*args, **kwargs)

Overloaded function.

  1. fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) -> None

  2. fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, sampler_number: int) -> None

Move sampler to end.

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::fast_forward(const unsigned long) –> 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.stepwise.sampler.StepWiseSamplerOneValueComb) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::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

get_value_list(*args, **kwargs)

Overloaded function.

  1. get_value_list(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb, id: int) -> pyrosetta.rosetta.utility.vector1_double

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::get_value_list(const unsigned long) –> const class utility::vector1<double, class std::allocator<double> > &

  1. get_value_list(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb, id_list: pyrosetta.rosetta.utility.vector1_unsigned_long) -> pyrosetta.rosetta.utility.vector1_double

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::get_value_list(const class utility::vector1<unsigned long, class std::allocator<unsigned long> > &) –> const class utility::vector1<double, class std::allocator<double> > &

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Reset to the first (or random if random()) rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerOneValueComb) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerOneValueComb::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer

Bases: StepWiseSamplerSized

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer, pose: pyrosetta.rosetta.core.pose.Pose, i: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::operator=(const class protocols::stepwise::sampler::StepWiseSamplerRingConformer &) –> class protocols::stepwise::sampler::StepWiseSamplerRingConformer &

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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerRingConformer) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerSized::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Reset to the first (or random if random()) rotamer.

C++: protocols::stepwise::sampler::StepWiseSamplerSized::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer) → int

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerRingConformer) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerRingConformer::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized

Bases: StepWiseSampler

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, : pyrosetta.rosetta.core.pose.Pose, : int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSized::apply(class core::pose::Pose &, const unsigned long) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSized::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSized &) –> class protocols::stepwise::sampler::StepWiseSamplerSized &

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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerSized) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerSized::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSized::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Reset to the first (or random if random()) rotamer.

C++: protocols::stepwise::sampler::StepWiseSamplerSized::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSized::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSized::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerSized::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny

Bases: StepWiseSamplerSized

add_external_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

Add one more rotamer sampler to this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::add_external_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSamplerSized> &) –> void

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, pose: pyrosetta.rosetta.core.pose.Pose, i: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSizedAny &) –> class protocols::stepwise::sampler::StepWiseSamplerSizedAny &

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_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → None

Clear all rotamer samplers stored in this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::clear_rotamer() –> 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>

fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::fast_forward() –> 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.stepwise.sampler.StepWiseSamplerSizedAny) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → None

Reset to the first (or random if random()) rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSampler::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedAny) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerSizedAny::type() const –> enum protocols::toolbox::SamplerPlusPlusType

class pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb

Bases: StepWiseSamplerSized

add_external_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None
Add one more rotamer sampler to this sampler. This one is ‘external’ to

any previously existing rotamers, i.e., this new only gets incremented when all previous existing rotamers complete their cycle.

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::add_external_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSamplerSized> &) –> void

add_internal_loop_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, rotamer: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → None
Add one more rotamer sampler to this sampler. This one is ‘internal’ to

existing rotamers, i.e., when this one completes its cycle, the existing

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::add_internal_loop_rotamer(const class std::shared_ptr<class protocols::stepwise::sampler::StepWiseSamplerSized> &) –> void

apply(*args, **kwargs)

Overloaded function.

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, pose: pyrosetta.rosetta.core.pose.Pose) -> None

Apply the current rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::apply(class core::pose::Pose &) –> void

  1. apply(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, pose: pyrosetta.rosetta.core.pose.Pose, id: int) -> None

Apply the i-th rotamer to pose

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::apply(class core::pose::Pose &, const unsigned long) –> void

assign(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, : pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::operator=(const class protocols::stepwise::sampler::StepWiseSamplerSizedComb &) –> class protocols::stepwise::sampler::StepWiseSamplerSizedComb &

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_rotamer(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Clear all rotamer samplers stored in this sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::clear_rotamer() –> 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>

fast_forward(*args, **kwargs)

Overloaded function.

  1. fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) -> None

  2. fast_forward(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, sampler_number: int) -> None

Move sampler to end.

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::fast_forward(const unsigned long) –> 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.stepwise.sampler.StepWiseSamplerSizedComb) → str

Name of the class

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::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

id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → int

C++: protocols::stepwise::sampler::StepWiseSamplerSized::id() const –> const unsigned long &

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 > > &

init(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Initialization

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::init() –> void

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

not_end(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized) → bool

Check if reach the end of rotamer list

C++: protocols::stepwise::sampler::StepWiseSamplerSized::not_end() const –> bool

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

pre_increment(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Move to next rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::operator++() –> 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

random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSampler) → bool

Check if is random modeler

C++: protocols::stepwise::sampler::StepWiseSampler::random() const –> bool

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → None

Reset to the first (or random if random()) rotamer

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::reset() –> void

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_id(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSized, setting: int) → None

C++: protocols::stepwise::sampler::StepWiseSamplerSized::set_id(const unsigned long) –> 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_random(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, setting: bool) → None

Set the random modeler state

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::set_random(const 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.

  1. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, out: pyrosetta.rosetta.std.ostream) -> None

  2. show(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb, out: pyrosetta.rosetta.std.ostream, indent: int) -> None

output summary of class

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::show(std::ostream &, const unsigned long) const –> void

size(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → int

Get the total number of rotamers in sampler

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::size() const –> unsigned long

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(self: pyrosetta.rosetta.protocols.stepwise.sampler.StepWiseSamplerSizedComb) → pyrosetta.rosetta.protocols.toolbox.SamplerPlusPlusType

Type of class (see enum in SamplerPlusPlusTypes.hh)

C++: protocols::stepwise::sampler::StepWiseSamplerSizedComb::type() const –> enum protocols::toolbox::SamplerPlusPlusType