rational_mc

Bindings for protocols::simple_moves::rational_mc namespace

class pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo

Bases: Mover

class; almost anything you could possibly want to add is a bad idea.

add_trigger(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, trigger: std::function<void (core::pose::Pose const&)>) → int

Registers the specified trigger with this instance. Returns a unique

identifier for referring to this trigger in subsequent operations.

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::add_trigger(const class std::function<void (const class core::pose::Pose &)> &) –> unsigned long

apply(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, pose: pyrosetta.rosetta.core.pose.Pose) → None

Applies the underlying mover to <pose> the specified number of times

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, : pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::operator=(const class protocols::simple_moves::rational_mc::RationalMonteCarlo &) –> class protocols::simple_moves::rational_mc::RationalMonteCarlo &

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>

disable_autotemp(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::disable_autotemp() –> void

enable_autotemp(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, quench: float) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::enable_autotemp(double) –> 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.simple_moves.rational_mc.RationalMonteCarlo) → str

Returns this mover’s name

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::get_name() const –> std::string

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

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

get_self_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.protocols.moves.Mover

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

get_self_weak_ptr(self: pyrosetta.rosetta.protocols.moves.Mover) → pyrosetta.rosetta.std.weak_ptr_protocols_moves_Mover_t

C++: protocols::moves::Mover::get_self_weak_ptr() –> class std::weak_ptr<class protocols::moves::Mover>

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

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

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

non-const accessor

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

last_accepted_pose(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → pyrosetta.rosetta.core.pose.Pose

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::last_accepted_pose() const –> const class core::pose::Pose &

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

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

lowest_score_pose(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → pyrosetta.rosetta.core.pose.Pose

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::lowest_score_pose() const –> const class core::pose::Pose &

mover(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → pyrosetta.rosetta.protocols.moves.Mover

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::mover() const –> class std::shared_ptr<class protocols::moves::Mover>

static name() → str

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

num_trials(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → int

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::num_trials() const –> unsigned long

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

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

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

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

recover_low(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → bool

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::recover_low() 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

remove_trigger(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, trigger_id: int) → None

Unregisters the trigger with the given unique identifier

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::remove_trigger(unsigned long) –> void

reset(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, pose: pyrosetta.rosetta.core.pose.Pose) → None

Updates the last accepted and lowest scoring pose members of the

MonteCarlo member variable to the score of the specified pose

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::reset(const class core::pose::Pose &) –> 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

score_function(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → pyrosetta.rosetta.core.scoring.ScoreFunction

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::score_function() const –> const class core::scoring::ScoreFunction &

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_mover(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, mover: pyrosetta.rosetta.protocols.moves.Mover) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::set_mover(class std::shared_ptr<class protocols::moves::Mover>) –> 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_num_trials(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, num_trials: int) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::set_num_trials(unsigned long) –> void

set_recover_low(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, recover_low: bool) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::set_recover_low(bool) –> void

set_score_function(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, score: pyrosetta.rosetta.core.scoring.ScoreFunction) → None

Updates the score function. Before calling this method, make sure

that apply() has been called at least once on a non-empty pose.

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::set_score_function(class std::shared_ptr<class core::scoring::ScoreFunction>) –> void

set_temperature(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo, temperature: float) → None

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::set_temperature(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

show(*args, **kwargs)

Overloaded function.

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

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

Outputs details about the Mover, including current settings.

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

temperature(self: pyrosetta.rosetta.protocols.simple_moves.rational_mc.RationalMonteCarlo) → float

C++: protocols::simple_moves::rational_mc::RationalMonteCarlo::temperature() const –> double

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

: Unit test support function. Apply one move to a given pose.

Allows extra test specific functions to be called before applying

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

type(*args, **kwargs)

Overloaded function.

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

Set the ‘type’ string

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

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

Get the set ‘type’ string

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