Rosetta
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover Class Reference

wraps protein-interface specific considerations around the general multistate design / genetic algorithm framework More...

#include <ProteinInterfaceMultiStateDesignMover.hh>

Inheritance diagram for protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover:
Inheritance graph
[legend]

Public Types

typedef multistate_design::PosType PosType
 
typedef core::pack::task::PackerTaskCOP PackerTaskCOP
 
typedef utility::pointer::shared_ptr< genetic_algorithm::GeneticAlgorithmGeneticAlgorithmOP
 
- Public Types inherited from protocols::minimization_packing::PackRotamersMover
typedef core::pack::interaction_graph::AnnealableGraphBaseOP AnnealableGraphBaseOP
 
typedef core::pack::interaction_graph::AnnealableGraphBaseCOP AnnealableGraphBaseCOP
 
typedef core::pack::rotamer_set::RotamerSetsOP RotamerSetsOP
 
typedef core::pack::rotamer_set::RotamerSetsCOP RotamerSetsCOP
 
typedef core::pack::task::PackerTaskCOP PackerTaskCOP
 
typedef core::pack::task::TaskFactoryCOP TaskFactoryCOP
 
typedef core::scoring::ScoreFunctionCOP ScoreFunctionCOP
 
- Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP TagCOP
 
typedef core::pose::Pose Pose
 
typedef core::pose::PoseCOP PoseCOP
 
typedef std::list< std::string > Strings
 

Public Member Functions

 ProteinInterfaceMultiStateDesignMover ()
 
 ~ProteinInterfaceMultiStateDesignMover () override
 
void apply (Pose &) override
 Performs side-chain packing based on the input PackerTask using the input ScoreFunction. More...
 
void output_results (Pose &)
 
void parse_my_tag (TagCOP, basic::datacache::DataMap &) override
 parse XML (specifically in the context of the parser/scripting scheme) More...
 
moves::MoverOP fresh_instance () const override
 required in the context of the parser/scripting scheme More...
 
moves::MoverOP clone () const override
 required in the context of the parser/scripting scheme More...
 
void restrict_sequence_profile (core::pose::Pose const &pose, core::pack::task::PackerTaskOP const ptask) const
 
unsigned long sequence_space (core::pack::task::PackerTaskCOP ptask) const
 
void output_alternative_states (core::pose::Pose const &output_pose) const
 
std::string get_name () const override
 Each derived class must specify its name. The class name. More...
 
- Public Member Functions inherited from protocols::minimization_packing::PackRotamersMover
 PackRotamersMover ()
 default constructor; reads the nloop_ value from the global options system. More...
 
 PackRotamersMover (utility::options::OptionCollection const &options)
 constructor that reads from the (possibly local) options collection object More...
 
 PackRotamersMover (std::string const &)
 constructor with typename; reads the nloop_ value from the global options system. More...
 
 PackRotamersMover (ScoreFunctionCOP scorefxn, PackerTaskCOP task=nullptr, core::Size nloop=1)
 Constructs a PackRotamersMover with PackerTask <task> evaluated using <scorefxn> More...
 
 ~PackRotamersMover () override
 
 PackRotamersMover (PackRotamersMover const &other)
 
void show (std::ostream &output=std::cout) const override
 Outputs details about the Mover, including current settings. More...
 
bool task_is_valid (Pose const &pose) const
 when the PackerTask was not generated locally, verify compatibility with pose More...
 
virtual void parse_score_function (TagCOP, basic::datacache::DataMap const &)
 parse "scorefxn" XML option (can be employed virtually by derived Packing movers) More...
 
virtual void parse_task_operations (TagCOP, basic::datacache::DataMap const &)
 parse "task_operations" XML option (can be employed virtually by derived Packing movers) More...
 
void initialize_task_factory_with_operations (std::list< core::pack::task::operation::TaskOperationCOP > const &)
 
void score_function (ScoreFunctionCOP sf)
 Sets the ScoreFunction to <sf> More...
 
virtual void task_factory (TaskFactoryCOP tf)
 Sets the TaskFactory to <tf> More...
 
void task (PackerTaskCOP t)
 Sets the PackerTask to <t> More...
 
void nloop (core::Size nloop_in)
 
ScoreFunctionCOP score_function () const
 Returns the ScoreFunction. More...
 
PackerTaskCOP task () const
 Returns the PackerTask. More...
 
core::Size nloop () const
 
TaskFactoryCOP task_factory () const
 Returns the TaskFactory. More...
 
RotamerSetsCOP rotamer_sets () const
 Returns the RotamerSets object being used for packing. More...
 
void set_annealer_observer (core::pack::annealer::AnnealerObserverOP observer)
 
- Public Member Functions inherited from protocols::moves::Mover
 Mover ()
 
virtual MoverOP create ()
 
MoverCOP get_self_ptr () const
 
MoverOP get_self_ptr ()
 
MoverCAP get_self_weak_ptr () const
 
MoverAP get_self_weak_ptr ()
 
 Mover (std::string const &type_name)
 sets the type for a mover; name_ has been removed (2010/05/14) More...
 
virtual void test_move (Pose &pose)
 : Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...
 
virtual bool reinitialize_for_each_job () const
 Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...
 
virtual bool reinitialize_for_new_input () const
 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). More...
 
MoverStatus get_last_move_status () const
 end parser interface, start Job Distributor interface///////////// More...
 
void reset_status ()
 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. More...
 
virtual core::pose::PoseOP get_additional_output ()
 Mechanism by which a mover may return multiple output poses from a single input pose. More...
 
void set_type (std::string const &setting)
 Set the 'type' string. More...
 
std::string get_type () const
 
void type (const std::string &type_in)
 Set the 'type' string. More...
 
std::string const & type () const
 Get the set 'type' string. More...
 
virtual void set_input_pose (PoseCOP pose)
 setter for poses contained for rms More...
 
virtual void set_native_pose (PoseCOP pose)
 setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...
 
PoseCOP get_input_pose () const
 
PoseCOP get_native_pose () const
 
void set_current_job (protocols::jobdist::BasicJobCOP job)
 
jobdist::BasicJobCOP get_current_job () const
 
virtual void set_current_tag (std::string const &new_tag)
 
std::string get_current_tag () const
 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. More...
 
virtual core::Real last_proposal_density_ratio ()
 
virtual void clear_info ()
 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. More...
 
virtual Stringsinfo ()
 non-const accessor More...
 
virtual Strings const & info () const
 const accessor More...
 
virtual void provide_citation_info (basic::citation_manager::CitationCollectionList &) const
 Provide citations to the passed CitationCollectionList Subclasses should add the info for themselves and any other classes they use. More...
 

Static Public Member Functions

static std::string mover_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
- Static Public Member Functions inherited from protocols::minimization_packing::PackRotamersMover
static std::string mover_name ()
 
static utility::tag::XMLSchemaComplexTypeGeneratorOP complex_type_generator_for_pack_rotamers_mover (utility::tag::XMLSchemaDefinition &xsd)
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 
static void list_options_read (utility::options::OptionKeyList &opts)
 
- Static Public Member Functions inherited from protocols::moves::Mover
static std::string name ()
 
static void register_options ()
 Overload this static method if you access options within the mover. More...
 

Private Member Functions

void initialize (Pose &)
 
void run ()
 
void add_states (Pose const &)
 add target and competitor states More...
 

Private Attributes

GeneticAlgorithmOP gen_alg_
 
multistate_design::MultiStatePackerOP multistate_packer_
 
core::Size rb_jump_
 
core::scoring::ScoreFunctionOP scorefxn_
 
core::Size generations_
 
core::Size pop_size_
 
core::Size num_packs_
 
core::Size pop_from_ss_
 
core::Size numresults_
 
core::Real fraction_by_recombination_
 
core::Real mutate_rate_
 
core::Real boltz_temp_
 
core::Real anchor_offset_
 
std::string checkpoint_prefix_
 
core::Size checkpoint_interval_
 
bool checkpoint_gz_
 
bool checkpoint_rename_
 
bool unbound_
 
bool unfolded_
 
bool input_is_positive_
 
bool use_unbound_for_sequence_profile_
 
core::Real bump_threshold_
 
bool compare_energy_to_ground_state_
 
utility::vector1< core::pose::PoseOPstate_poses_
 states More...
 
utility::vector1< core::pose::PoseOPsaved_state_poses_
 
utility::vector1< bool > state_positive_
 for dumping out pdbs of negative states at the end More...
 
utility::vector1< bool > state_unfolded_
 
utility::vector1< bool > state_unbound_
 
utility::vector1< core::pack::task::TaskFactoryCOPstate_task_factory_
 
std::string fname_prefix_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::minimization_packing::PackRotamersMover
virtual void setup (Pose &pose)
 get rotamers, energies. Also performs lazy initialization of ScoreFunction, PackerTask. More...
 
virtual core::PackerEnergy run (Pose &pose, utility::vector0< int > rot_to_pack=utility::vector0< int >()) const
 
virtual void cleanup (core::pose::Pose &pose)
 Clean up cached pose and mover data after the fact. More...
 
virtual void note_packertask_settings (Pose const &)
 note PackerTask's packable and designable residues as string info More...
 
- Protected Member Functions inherited from protocols::moves::Mover
void set_last_move_status (MoverStatus status)
 nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...
 

Detailed Description

wraps protein-interface specific considerations around the general multistate design / genetic algorithm framework

Member Typedef Documentation

◆ GeneticAlgorithmOP

◆ PackerTaskCOP

◆ PosType

Constructor & Destructor Documentation

◆ ProteinInterfaceMultiStateDesignMover()

protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::ProteinInterfaceMultiStateDesignMover ( )

◆ ~ProteinInterfaceMultiStateDesignMover()

protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::~ProteinInterfaceMultiStateDesignMover ( )
overridedefault

Member Function Documentation

◆ add_states()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::add_states ( Pose const &  pose)
private

◆ apply()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::apply ( Pose pose)
overridevirtual

Performs side-chain packing based on the input PackerTask using the input ScoreFunction.

example(s): packmover.apply(pose) See Also: PackerTask ScoreFunction

Reimplemented from protocols::minimization_packing::PackRotamersMover.

References initialize(), output_alternative_states(), output_results(), and run().

◆ clone()

moves::MoverOP protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::clone ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::minimization_packing::PackRotamersMover.

◆ fresh_instance()

moves::MoverOP protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::fresh_instance ( ) const
overridevirtual

required in the context of the parser/scripting scheme

Reimplemented from protocols::minimization_packing::PackRotamersMover.

◆ get_name()

std::string protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::get_name ( ) const
overridevirtual

Each derived class must specify its name. The class name.

Reimplemented from protocols::minimization_packing::PackRotamersMover.

References mover_name().

◆ initialize()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::initialize ( Pose pose)
private

◆ mover_name()

std::string protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::mover_name ( )
static

◆ output_alternative_states()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::output_alternative_states ( core::pose::Pose const &  output_pose) const

◆ output_results()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::output_results ( Pose pose)

◆ parse_my_tag()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap datamap 
)
overridevirtual

◆ provide_xml_schema()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static

◆ restrict_sequence_profile()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::restrict_sequence_profile ( core::pose::Pose const &  pose,
core::pack::task::PackerTaskOP const  ptask 
) const

◆ run()

void protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::run ( )
private

◆ sequence_space()

unsigned long protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::sequence_space ( core::pack::task::PackerTaskCOP  ptask) const

Member Data Documentation

◆ anchor_offset_

core::Real protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::anchor_offset_
private

Referenced by initialize(), and parse_my_tag().

◆ boltz_temp_

core::Real protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::boltz_temp_
private

Referenced by initialize(), and parse_my_tag().

◆ bump_threshold_

core::Real protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::bump_threshold_
private

◆ checkpoint_gz_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::checkpoint_gz_
private

Referenced by initialize(), and parse_my_tag().

◆ checkpoint_interval_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::checkpoint_interval_
private

Referenced by initialize(), and parse_my_tag().

◆ checkpoint_prefix_

std::string protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::checkpoint_prefix_
private

Referenced by initialize(), and parse_my_tag().

◆ checkpoint_rename_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::checkpoint_rename_
private

Referenced by initialize(), and parse_my_tag().

◆ compare_energy_to_ground_state_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::compare_energy_to_ground_state_
private

Referenced by initialize(), and parse_my_tag().

◆ fname_prefix_

std::string protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::fname_prefix_
private

◆ fraction_by_recombination_

core::Real protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::fraction_by_recombination_
private

Referenced by initialize(), and parse_my_tag().

◆ gen_alg_

GeneticAlgorithmOP protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::gen_alg_
private

Referenced by initialize(), output_results(), and run().

◆ generations_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::generations_
private

Referenced by initialize(), and parse_my_tag().

◆ input_is_positive_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::input_is_positive_
private

Referenced by add_states(), and parse_my_tag().

◆ multistate_packer_

multistate_design::MultiStatePackerOP protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::multistate_packer_
private

◆ mutate_rate_

core::Real protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::mutate_rate_
private

Referenced by initialize(), and parse_my_tag().

◆ num_packs_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::num_packs_
private

Referenced by initialize(), and parse_my_tag().

◆ numresults_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::numresults_
private

Referenced by output_results(), and parse_my_tag().

◆ pop_from_ss_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::pop_from_ss_
private

Referenced by initialize(), and parse_my_tag().

◆ pop_size_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::pop_size_
private

Referenced by initialize(), and parse_my_tag().

◆ rb_jump_

core::Size protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::rb_jump_
private

◆ saved_state_poses_

utility::vector1< core::pose::PoseOP > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::saved_state_poses_
private

◆ scorefxn_

core::scoring::ScoreFunctionOP protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::scorefxn_
private

◆ state_poses_

utility::vector1< core::pose::PoseOP > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::state_poses_
private

◆ state_positive_

utility::vector1< bool > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::state_positive_
private

for dumping out pdbs of negative states at the end

Referenced by add_states(), output_alternative_states(), parse_my_tag(), and ProteinInterfaceMultiStateDesignMover().

◆ state_task_factory_

utility::vector1< core::pack::task::TaskFactoryCOP > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::state_task_factory_
private

Referenced by add_states(), and parse_my_tag().

◆ state_unbound_

utility::vector1< bool > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::state_unbound_
private

◆ state_unfolded_

utility::vector1< bool > protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::state_unfolded_
private

◆ unbound_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::unbound_
private

Referenced by add_states(), and parse_my_tag().

◆ unfolded_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::unfolded_
private

Referenced by add_states(), and parse_my_tag().

◆ use_unbound_for_sequence_profile_

bool protocols::protein_interface_design::movers::ProteinInterfaceMultiStateDesignMover::use_unbound_for_sequence_profile_
private

The documentation for this class was generated from the following files: