|
Rosetta 3.5
|
class for non-discrete side chain sampling using Dunbrack rotamer probabilities/distributions More...
#include <SidechainMCMover.hh>


Public Member Functions | |
| SidechainMCMover () | |
| default constructor More... | |
| SidechainMCMover (core::pack::dunbrack::RotamerLibrary const &rotamer_library) | |
| constructor with user provided rotamer library More... | |
| ~SidechainMCMover () | |
| void | show_counters (std::ostream &out) |
| void | setup (core::scoring::ScoreFunctionCOP sfxn) |
| protocols::moves::MoverOP | clone () const |
| clone has to be overridden only if clone invocation is expected. More... | |
| protocols::moves::MoverOP | fresh_instance () const |
| this is like clone(), except it generates a new mover object freshly created with the default ctor. This function should be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage). More... | |
| void | parse_my_tag (utility::tag::TagPtr const tag, protocols::moves::DataMap &, protocols::filters::Filters_map const &, protocols::moves::Movers_map const &, core::pose::Pose const &) |
| Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More... | |
| void | apply (core::pose::Pose &pose) |
| apply a sidechain move to a Pose object More... | |
| virtual std::string | get_name () const |
| Each derived class must specify its name. The class name. More... | |
| void | set_ntrials (core::Size ntrial) |
| core::Size | ntrials () |
| void | set_temperature (core::Real temp) |
| core::Real | temperature () |
| void | set_inherit_scorefxn_temperature (bool inherit_scorefxn_temperature) |
| bool | inherit_scorefxn_temperature () const |
| void | set_scorefunction (core::scoring::ScoreFunction const &sfxn) |
| core::scoring::ScoreFunction & | scorefunction () |
| virtual void | initialize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover, core::Size cycle) |
| callback executed before any Monte Carlo trials More... | |
| virtual core::Real | last_proposal_density_ratio () |
| get the ratio of proposal densities for the last move More... | |
| virtual bool | is_multi_trial () |
| determine whether the move performs multiple trials on a single apply More... | |
| virtual core::Real | last_inner_score_temperature_delta () |
| get change in internal score/temperature for last apply method of multiple trial movers More... | |
| virtual protocols::canonical_sampling::MetropolisHastingsMoverAP | metropolis_hastings_mover () |
| get the MetropolisHastingsMover for multiple trial movers More... | |
| virtual void | set_metropolis_hastings_mover (protocols::canonical_sampling::MetropolisHastingsMoverAP metropolis_hastings_mover) |
| set the MetropolisHastingsMover for multiple trial movers More... | |
Public Member Functions inherited from protocols::simple_moves::sidechain_moves::SidechainMover | |
| SidechainMover () | |
| default constructor More... | |
| SidechainMover (core::pack::dunbrack::RotamerLibrary const &rotamer_library) | |
| constructor with user provided rotamer library More... | |
| SidechainMover (SidechainMover const &mover) | |
| ~SidechainMover () | |
| void | init_task (core::pose::Pose const &pose) |
| initialize the packer task if necessary More... | |
| core::conformation::ResidueOP | make_move (core::conformation::ResidueOP res) |
| bool | task_initialized () |
| void | apply (core::pose::Pose &pose) |
| apply a sidechain move to a Pose object More... | |
| core::Real | proposal_density (core::conformation::Residue const &proposed_residue, core::Size const proposed_resnum, core::chemical::ResidueType const &initial_residue_type, utility::vector1< core::Real > const &initial_chi_angles) const |
| void | test_move (core::pose::Pose &) |
| test the backrub move More... | |
| void | idealize_sidechains (core::pose::Pose &pose) |
| idealize sidechains that might be altered More... | |
| core::pack::dunbrack::RotamerLibrary const & | rotamer_library () const |
| get the rotamer library More... | |
| core::pack::task::TaskFactoryCOP | task_factory () const |
| get the task factory More... | |
| void | set_task_factory (core::pack::task::TaskFactoryCOP task_factory) |
| set the task factory More... | |
| core::pack::task::PackerTaskCOP | task () const |
| get the packer task More... | |
| void | set_task (core::pack::task::PackerTaskCOP task) |
| set the task More... | |
| core::Real | prob_uniform () const |
| get the probability of uniformly sampling chi angles More... | |
| void | set_prob_uniform (core::Real prob_uniform) |
| set the probability of uniformly sampling chi angles More... | |
| bool | preserve_detailed_balance () const |
| get whether detailed balance is preserved (i.e. proposal density ratio calculated) More... | |
| void | set_preserve_detailed_balance (bool preserve_detailed_balance) |
| set whether detailed balance is preserved (i.e. proposal density ratio calculated) More... | |
| bool | change_chi_without_replacing_residue () const |
| perform direct chi manipulations rather than using replace_residue to effect rotamer changes; useful if things are kinematically dependent on a sidechain. More... | |
| void | set_change_chi_without_replacing_residue (bool const change_chi_without_replacing_residue) |
| perform direct chi manipulations rather than using replace_residue to effect rotamer changes; useful if things are kinematically dependent on a sidechain. More... | |
| virtual utility::vector1 < core::id::TorsionID_Range > | torsion_id_ranges (core::pose::Pose &pose) |
| get the TorsionIDs perturbed by the mover during moves, along with their ranges More... | |
| virtual utility::vector1 < core::id::DOF_ID_Range > | dof_id_ranges (core::pose::Pose &pose) |
| get the DOF_IDs perturbed by the mover during moves, along with their ranges More... | |
| core::Real | prob_withinrot () const |
| get the probability of sampling within the same rotamer More... | |
| void | set_prob_withinrot (core::Real prob_withinrot) |
| set the probability of sampling within the same rotamer More... | |
| core::Real | prob_random_pert_current () const |
| void | set_prob_random_pert_current (core::Real prob_pert) |
| utility::vector1< core::Size > const & | packed_residues () const |
| get the residues that can be changed by this mover More... | |
| utility::vector1< bool > const & | residue_packed () const |
| get a vector indicating whether each residue can be packed More... | |
| core::Size | next_resnum () const |
| get the next residue to be changed, 0 means a random will be chosen More... | |
| void | next_resnum (core::Size resnum) |
| set the next residue to be changed, 0 means a random will be chosen More... | |
| core::Size | last_nchi () const |
| get the number of chi angles sampled in the last move More... | |
| bool | last_mutation () const |
| get whether the last move mutated the residue More... | |
| bool | last_uniform () const |
| get whether the last move used uniform chi sampling More... | |
| bool | last_withinrot () const |
| get whether the last move sampled within the same rotamer More... | |
| void | update_type () |
| update string describing the move type More... | |
| void | set_sampling_temperature (core::Real temp) |
| set temperature for bias sampling at dunbrack distribution More... | |
| core::Real | sampling_temperature () |
Public Member Functions inherited from protocols::canonical_sampling::ThermodynamicMover | |
| ThermodynamicMover () | |
| virtual | ~ThermodynamicMover () |
| virtual void | observe_after_metropolis (protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover) |
| callback executed after the Metropolis criterion is evaluated More... | |
| virtual void | finalize_simulation (core::pose::Pose &pose, protocols::canonical_sampling::MetropolisHastingsMover const &metropolis_hastings_mover) |
| callback executed after all Monte Carlo trials More... | |
Public Member Functions inherited from protocols::moves::Mover | |
| Mover () | |
| virtual | ~Mover () |
| virtual MoverSP | create () |
| virtual void | apply (core::io::serialization::PipeMap &pmap) |
| virtual void | parse_state (SerializableState const &state) |
| virtual void | parse_def (utility::lua::LuaObject const &def, utility::lua::LuaObject const &score_fxns, utility::lua::LuaObject const &tasks, MoverCacheSP cache) |
| virtual void | save_state (SerializableState &state) |
| Mover (std::string const &type_name) | |
| sets the type for a mover; name_ has been removed (2010/05/14) More... | |
| Mover (Mover const &other) | |
| Mover & | operator= (Mover const &other) |
| assignment operator More... | |
| std::string const & | type () const |
| 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... | |
| void | set_current_tag (std::string const &new_tag) |
| 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 | type (const std::string &type_in) |
| std::string | get_type () const |
| 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... | |
| 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 Strings & | info () |
| non-const accessor More... | |
| virtual Strings const & | info () const |
| const accessor More... | |
| virtual bool | reinitialize_for_each_job () const |
| this function informs 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 |
| this function informs 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... | |
| void | set_current_job (protocols::jobdist::BasicJobCOP job) |
| jobdist::BasicJobCOP | get_current_job () const |
Private Member Functions | |
| bool | pass_metropolis (core::Real delta_energy, core::Real last_proposal_density_ratio) |
| void | perturb_chi (numeric::random::RandomGenerator Rand, core::Real max_deviation, utility::vector1< core::Real > ¤t_chi, utility::vector1< core::Real > &new_chi) |
Additional Inherited Members | |
Public Types inherited from protocols::moves::Mover | |
| typedef utility::tag::TagPtr | TagPtr |
| typedef core::pose::Pose | Pose |
| typedef core::pose::PoseCOP | PoseCOP |
| typedef protocols::filters::Filters_map | Filters_map |
| typedef std::list< std::string > | Strings |
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. 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. 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... | |
Protected Attributes inherited from protocols::simple_moves::sidechain_moves::SidechainMover | |
| core::Real | temperature0_ |
| core::Real | sampling_temperature_ |
class for non-discrete side chain sampling using Dunbrack rotamer probabilities/distributions
Definition at line 62 of file SidechainMCMover.hh.
| protocols::simple_moves::sidechain_moves::SidechainMCMover::SidechainMCMover | ( | ) |
default constructor
Definition at line 100 of file SidechainMCMover.cc.
| protocols::simple_moves::sidechain_moves::SidechainMCMover::SidechainMCMover | ( | core::pack::dunbrack::RotamerLibrary const & | rotamer_library) |
constructor with user provided rotamer library
Definition at line 118 of file SidechainMCMover.cc.
| protocols::simple_moves::sidechain_moves::SidechainMCMover::~SidechainMCMover | ( | ) |
Definition at line 138 of file SidechainMCMover.cc.
|
virtual |
apply a sidechain move to a Pose object
Implements protocols::moves::Mover.
Definition at line 167 of file SidechainMCMover.cc.
References best_, best_energy_, current_, core::pose::Pose::dump_pdb(), ig_, inherit_scorefxn_temperature_, protocols::simple_moves::sidechain_moves::SidechainMover::init_task(), protocols::simple_moves::sidechain_moves::SidechainMover::last_proposal_density_ratio(), protocols::simple_moves::sidechain_moves::SidechainMover::make_move(), metropolis_hastings_mover_, core::conformation::Residue::name1(), ntrials_, protocols::simple_moves::sidechain_moves::SidechainMover::packed_residues(), pass_metropolis(), previous_, core::pose::Pose::replace_residue(), core::pose::Pose::residue(), Rg(), score_post_apply_, score_pre_apply_, set_temperature(), sfxn_, core::io::serialization::size(), temperature_, core::pose::Pose::total_residue(), protocols::simple_moves::sidechain_moves::TR(), and protocols::moves::Mover::type().
|
virtual |
clone has to be overridden only if clone invocation is expected.
clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.
Reimplemented from protocols::simple_moves::sidechain_moves::SidechainMover.
Definition at line 156 of file SidechainMCMover.cc.
|
virtual |
this is like clone(), except it generates a new mover object freshly created with the default ctor. This function should be pure virtual but that would disrupt the code base; MAKE SURE YOU DEFINE IT if you want to have your mover be a protocol handed to the job distributor (august 08 vintage).
fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.
Reimplemented from protocols::moves::Mover.
Definition at line 161 of file SidechainMCMover.cc.
|
virtual |
Each derived class must specify its name. The class name.
Reimplemented from protocols::simple_moves::sidechain_moves::SidechainMover.
Definition at line 323 of file SidechainMCMover.cc.
|
inline |
Definition at line 122 of file SidechainMCMover.hh.
References inherit_scorefxn_temperature_.
Referenced by parse_my_tag(), and set_inherit_scorefxn_temperature().
|
virtual |
callback executed before any Monte Carlo trials
Reimplemented from protocols::simple_moves::sidechain_moves::SidechainMover.
Definition at line 399 of file SidechainMCMover.cc.
References inherit_scorefxn_temperature_, protocols::simple_moves::sidechain_moves::SidechainMover::initialize_simulation(), metropolis_hastings_mover_, set_scorefunction(), and set_temperature().
|
inlinevirtual |
determine whether the move performs multiple trials on a single apply
Reimplemented from protocols::canonical_sampling::ThermodynamicMover.
Definition at line 154 of file SidechainMCMover.hh.
|
inlinevirtual |
get change in internal score/temperature for last apply method of multiple trial movers
Reimplemented from protocols::canonical_sampling::ThermodynamicMover.
Definition at line 161 of file SidechainMCMover.hh.
References score_post_apply_, score_pre_apply_, and temperature_.
|
inlinevirtual |
get the ratio of proposal densities for the last move
Reimplemented from protocols::simple_moves::sidechain_moves::SidechainMover.
Definition at line 147 of file SidechainMCMover.hh.
Referenced by pass_metropolis().
|
inlinevirtual |
get the MetropolisHastingsMover for multiple trial movers
Reimplemented from protocols::canonical_sampling::ThermodynamicMover.
Definition at line 168 of file SidechainMCMover.hh.
References metropolis_hastings_mover_.
Referenced by set_metropolis_hastings_mover().
|
inline |
Definition at line 101 of file SidechainMCMover.hh.
References ntrials_.
|
virtual |
Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.
Some movers need not be parsed, so we shouldn't stop executions. This, however, calls attention to the lack of this method, which could be due to something as silly as a wrong parameters definition.
Reimplemented from protocols::simple_moves::sidechain_moves::SidechainMover.
Definition at line 351 of file SidechainMCMover.cc.
References core::pack::task::TaskFactory::create_packer_task(), core::sequence::end, protocols::moves::DataMap::get(), protocols::moves::DataMap::has(), inherit_scorefxn_temperature(), ntrials_, protocols::simple_moves::sidechain_moves::SidechainMover::preserve_detailed_balance(), protocols::simple_moves::sidechain_moves::SidechainMover::prob_random_pert_current(), protocols::simple_moves::sidechain_moves::SidechainMover::prob_uniform(), protocols::simple_moves::sidechain_moves::SidechainMover::prob_withinrot(), set_inherit_scorefxn_temperature(), protocols::simple_moves::sidechain_moves::SidechainMover::set_preserve_detailed_balance(), protocols::simple_moves::sidechain_moves::SidechainMover::set_prob_random_pert_current(), protocols::simple_moves::sidechain_moves::SidechainMover::set_prob_uniform(), protocols::simple_moves::sidechain_moves::SidechainMover::set_prob_withinrot(), protocols::simple_moves::sidechain_moves::SidechainMover::set_task(), protocols::simple_moves::sidechain_moves::SidechainMover::set_task_factory(), setup(), temperature_, and protocols::simple_moves::sidechain_moves::TR().
|
private |
Definition at line 328 of file SidechainMCMover.cc.
References accepts_, current_ntrial_, last_proposal_density_ratio(), Rg(), temperature_, and protocols::simple_moves::sidechain_moves::TR().
Referenced by apply().
|
private |
|
inline |
Definition at line 133 of file SidechainMCMover.hh.
References sfxn_.
|
inline |
Definition at line 116 of file SidechainMCMover.hh.
References inherit_scorefxn_temperature(), and inherit_scorefxn_temperature_.
Referenced by parse_my_tag().
|
inlinevirtual |
set the MetropolisHastingsMover for multiple trial movers
Reimplemented from protocols::canonical_sampling::ThermodynamicMover.
Definition at line 175 of file SidechainMCMover.hh.
References metropolis_hastings_mover(), and metropolis_hastings_mover_.
|
inline |
Definition at line 96 of file SidechainMCMover.hh.
References ntrials_.
|
inline |
Definition at line 128 of file SidechainMCMover.hh.
References sfxn_.
Referenced by initialize_simulation(), and setup().
|
inline |
Definition at line 106 of file SidechainMCMover.hh.
References temperature_.
Referenced by apply(), and initialize_simulation().
| void protocols::simple_moves::sidechain_moves::SidechainMCMover::setup | ( | core::scoring::ScoreFunctionCOP | sfxn) |
Definition at line 142 of file SidechainMCMover.cc.
References ig_, and set_scorefunction().
Referenced by parse_my_tag().
| void protocols::simple_moves::sidechain_moves::SidechainMCMover::show_counters | ( | std::ostream & | out) |
Definition at line 151 of file SidechainMCMover.cc.
References accepts_, and current_ntrial_.
|
inline |
Definition at line 111 of file SidechainMCMover.hh.
References temperature_.
|
private |
Definition at line 205 of file SidechainMCMover.hh.
Referenced by pass_metropolis(), and show_counters().
|
private |
Definition at line 197 of file SidechainMCMover.hh.
Referenced by apply().
|
private |
Definition at line 200 of file SidechainMCMover.hh.
Referenced by apply().
|
private |
Definition at line 195 of file SidechainMCMover.hh.
Referenced by apply().
|
private |
Definition at line 201 of file SidechainMCMover.hh.
|
private |
Definition at line 206 of file SidechainMCMover.hh.
Referenced by pass_metropolis(), and show_counters().
|
private |
Definition at line 204 of file SidechainMCMover.hh.
|
private |
Definition at line 203 of file SidechainMCMover.hh.
Referenced by apply(), inherit_scorefxn_temperature(), initialize_simulation(), and set_inherit_scorefxn_temperature().
|
private |
Definition at line 209 of file SidechainMCMover.hh.
Referenced by apply(), initialize_simulation(), metropolis_hastings_mover(), and set_metropolis_hastings_mover().
|
private |
Definition at line 199 of file SidechainMCMover.hh.
Referenced by apply(), ntrials(), parse_my_tag(), and set_ntrials().
|
private |
Definition at line 196 of file SidechainMCMover.hh.
Referenced by apply().
|
private |
Definition at line 208 of file SidechainMCMover.hh.
Referenced by apply(), and last_inner_score_temperature_delta().
|
private |
Definition at line 207 of file SidechainMCMover.hh.
Referenced by apply(), and last_inner_score_temperature_delta().
|
private |
Definition at line 202 of file SidechainMCMover.hh.
Referenced by apply(), scorefunction(), and set_scorefunction().
|
private |
Definition at line 198 of file SidechainMCMover.hh.
Referenced by apply(), last_inner_score_temperature_delta(), parse_my_tag(), pass_metropolis(), set_temperature(), and temperature().
1.8.4