star

Bindings for protocols::star namespace

class pyrosetta.rosetta.protocols.star.Extender

Bases: pybind11_object

aligned(self: pyrosetta.rosetta.protocols.star.Extender) → pyrosetta.rosetta.protocols.loops.Loops

Returns the aligned regions in increasing order of start position

C++: protocols::star::Extender::aligned() const –> class std::shared_ptr<const class protocols::loops::Loops>

cutpoints(self: pyrosetta.rosetta.protocols.star.Extender) → pyrosetta.rosetta.utility.vector1_int

Returns a set of suggested cutpoints for star fold tree construction

based on information gathered during extend_unaligned().

C++: protocols::star::Extender::cutpoints() const –> const class utility::vector1<int, class std::allocator<int> > &

extend_unaligned(self: pyrosetta.rosetta.protocols.star.Extender, pose: pyrosetta.rosetta.core.pose.Pose) → None

Sets unaligned residues’ torsion angles to their extended values

and idealizes bond lengths and angles. The placement of unaligned residues depends on the number of residues separating the adjacent aligned regions.

Given aligned regions a_1 and a_2 with (a_1.start < a_2.start):

If (a_2.start - a_1.stop) <= -abinitio:star:short_loop_len, the unaligned residues are grown off a_1.stop. Otherwise, a stochastically selected portion of the residues are grown off a_1.stop and the remainder grown off a_2.start. In both cases, the method is responsible for noting the interior cutpoints it selected.

C++: protocols::star::Extender::extend_unaligned(class core::pose::Pose *) –> void

set_secondary_structure(self: pyrosetta.rosetta.protocols.star.Extender, pred_ss: pyrosetta.rosetta.core.fragment.SecondaryStructure) → None

Updates predicted secondary structure, improving cutpoint selection

C++: protocols::star::Extender::set_secondary_structure(class std::shared_ptr<const class core::fragment::SecondaryStructure>) –> void

unaligned(self: pyrosetta.rosetta.protocols.star.Extender) → pyrosetta.rosetta.protocols.loops.Loops

Returns the unaligned regions in increasing order of start position

C++: protocols::star::Extender::unaligned() const –> class std::shared_ptr<const class protocols::loops::Loops>

class pyrosetta.rosetta.protocols.star.StarAbinitio

Bases: Mover

apply(self: pyrosetta.rosetta.protocols.star.StarAbinitio, pose: pyrosetta.rosetta.core.pose.Pose) → None

C++: protocols::star::StarAbinitio::apply(class core::pose::Pose &) –> void

assign(self: pyrosetta.rosetta.protocols.star.StarAbinitio, : pyrosetta.rosetta.protocols.star.StarAbinitio) → pyrosetta.rosetta.protocols.star.StarAbinitio

C++: protocols::star::StarAbinitio::operator=(const class protocols::star::StarAbinitio &) –> class protocols::star::StarAbinitio &

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.star.StarAbinitio) → pyrosetta.rosetta.protocols.moves.Mover

Uses the copy constructor to create a new instance

C++: protocols::star::StarAbinitio::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.star.StarAbinitio) → pyrosetta.rosetta.protocols.moves.Mover

Uses the no-argument constructor to create a new instance

C++: protocols::star::StarAbinitio::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.star.StarAbinitio) → str

Returns the name of this mover

C++: protocols::star::StarAbinitio::get_name() const –> std::string

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

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

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

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

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

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

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

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

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

non-const accessor

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

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

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

static name() → str

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

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

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

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

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

Provide citations to the passed CitationCollectionList

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

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

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

static register_options() → None

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

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

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

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

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

each use.

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

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

Inform the Job Distributor (August ‘08 vintage) whether this object needs to be regenerated when the input

pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose).

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

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

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

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

set_current_job(self: pyrosetta.rosetta.protocols.moves.Mover, job: protocols::jobdist::BasicJob) → None

C++: protocols::moves::Mover::set_current_job(class std::shared_ptr<const class protocols::jobdist::BasicJob>) –> void

set_current_tag(self: pyrosetta.rosetta.protocols.moves.Mover, new_tag: str) → None

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

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

setter for poses contained for rms

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

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

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

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

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

Set the ‘type’ string

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

show(*args, **kwargs)

Overloaded function.

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

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

Outputs details about the Mover, including current settings.

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

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

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

Allows extra test specific functions to be called before applying

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

type(*args, **kwargs)

Overloaded function.

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

Set the ‘type’ string

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

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

Get the set ‘type’ string

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

pyrosetta.rosetta.protocols.star.StarAbinitio_main(: capsule) → capsule

Entry point for StarAbinitio protocol

C++: protocols::star::StarAbinitio_main(void *) –> void *

pyrosetta.rosetta.protocols.star.emit_intermediate(pose: pyrosetta.rosetta.core.pose.Pose, silent_filename: str) → None

Writes pose to disk with the specified filename if -abinitio:debug is enabled

C++: protocols::star::emit_intermediate(const class core::pose::Pose &, const std::string &) –> void

pyrosetta.rosetta.protocols.star.simple_fold_tree(pose: pyrosetta.rosetta.core.pose.Pose) → None

Restores simple kinematics to pose

C++: protocols::star::simple_fold_tree(class core::pose::Pose &) –> void

pyrosetta.rosetta.protocols.star.to_centroid(pose: pyrosetta.rosetta.core.pose.Pose) → None

Converts pose to centroid residue type set

C++: protocols::star::to_centroid(class core::pose::Pose &) –> void