Rosetta
|
#include <RelaxProtocolBase.hh>
Public Types | |
typedef moves::Mover | parent |
![]() | |
typedef utility::tag::TagCOP | TagCOP |
typedef core::pose::Pose | Pose |
typedef core::pose::PoseCOP | PoseCOP |
typedef std::list< std::string > | Strings |
Public Member Functions | |
RelaxProtocolBase (core::scoring::ScoreFunctionOP) | |
RelaxProtocolBase (std::string const &movername="RelaxProtocol") | |
RelaxProtocolBase (std::string const &movername, core::scoring::ScoreFunctionOP) | |
~RelaxProtocolBase () override | |
protocols::moves::MoverOP | fresh_instance () const override |
Generates a new Mover object freshly created with the default ctor. More... | |
void | apply_disulfides (core::pose::Pose &pose) |
void | set_defaults () |
void | set_default_minimization_settings () |
void | set_default_coordinate_settings () |
void | set_default_movemap () |
core::kinematics::MoveMapCOP | get_movemap () const |
core::kinematics::MoveMapOP | get_movemap () |
const core::scoring::ScoreFunctionCOP | get_scorefxn () const |
core::pack::task::TaskFactoryOP const & | get_task_factory () const |
bool | cartesian () const |
std::string | min_type () const |
core::Size | max_iter () const |
bool | dry_run () const |
bool | constrain_relax_to_native_coords () const |
bool | constrain_relax_to_start_coords () const |
bool | constrain_coords () const |
bool | coord_constrain_sidechains () const |
bool | ramp_down_constraints () const |
bool | constrain_relax_segments () const |
bool | minimize_bond_lengths () const |
bool | minimize_bond_angles () const |
void | set_movemap (core::kinematics::MoveMapOP movemap) |
void | set_movemap_factory (core::select::movemap::MoveMapFactoryOP mm_factory) |
void | set_scorefxn (core::scoring::ScoreFunctionOP scorefxn) |
void | set_task_factory (core::pack::task::TaskFactoryOP task_factory) |
void | cartesian (bool newval) |
Use cartesian (minimization step) More... | |
void | min_type (std::string min_type) |
void | max_iter (core::Size max_iter) |
void | dry_run (bool setting) |
void | constrain_relax_to_native_coords (bool constrain_relax_to_native_coords) |
void | constrain_relax_to_start_coords (bool constrain_relax_to_start_coords) |
void | constrain_coords (bool constrain_coords) |
void | coord_constrain_sidechains (bool coord_constrain_sidechains) |
void | constrain_relax_segments (bool constrain_relax_segments) |
void | ramp_down_constraints (bool ramp_down_constraints) |
void | minimize_bond_lengths (bool minimize_bond_lengths) |
void | minimize_bond_angles (bool minimize_bond_angles) |
void | provide_citation_info (basic::citation_manager::CitationCollectionList &) const override |
Provide the citation. More... | |
![]() | |
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 | apply (Pose &)=0 |
Main Method. 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 MoverOP | clone () const |
Return a clone of the Mover object. 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 |
virtual void | parse_my_tag (TagCOP tag, basic::datacache::DataMap &data) |
Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More... | |
virtual std::string | get_name () const =0 |
Each derived class must specify its name. The class name. More... | |
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 void | show (std::ostream &output=std::cout) const |
Outputs details about the Mover, including current settings. 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 Strings & | info () |
non-const accessor More... | |
virtual Strings const & | info () const |
const accessor More... | |
Static Public Member Functions | |
static void | register_options () |
![]() | |
static std::string | name () |
static void | register_options () |
Overload this static method if you access options within the mover. More... | |
Protected Member Functions | |
core::scoring::ScoreFunctionOP | get_scorefxn () |
bool | fix_omega () const |
int | minimize_bondlength_subset () const |
int | minimize_bondangle_subset () const |
bool | limit_aroma_chi2 () const |
std::string | cst_files (core::Size const i) const |
void | fix_omega (bool fix_omega) |
void | minimize_bondangle_subset (int minimize_bondangle_subset) |
void | minimize_bondlength_subset (int minimize_bondlength_subset) |
void | initialize_movemap (core::pose::Pose const &pose, core::kinematics::MoveMap &movemap) |
void | set_up_constraints (core::pose::Pose &pose, core::kinematics::MoveMap &local_movemap) |
void | output_debug_structure (core::pose::Pose &pose, std::string prefix) |
void | add_cst_files (std::string const &cstfile) |
![]() | |
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... | |
Private Attributes | |
bool | fix_omega_ |
bool | minimize_bond_lengths_ |
bool | minimize_bond_angles_ |
int | minimize_bondangle_subset_ |
int | minimize_bondlength_subset_ |
bool | constrain_relax_to_native_coords_ |
bool | constrain_relax_to_start_coords_ |
bool | constrain_coords_ |
bool | coord_constrain_sidechains_ |
bool | ramp_down_constraints_ |
bool | constrain_relax_segments_ |
utility::vector1< std::string > | cst_files_ |
std::string | min_type_ |
bool | cartesian_ |
Do cartesian-space minimization? More... | |
core::Size | max_iter_ |
maximum minimizer iterations More... | |
bool | limit_aroma_chi2_ |
core::kinematics::MoveMapOP | movemap_ |
core::select::movemap::MoveMapFactoryOP | movemap_factory_ |
core::scoring::ScoreFunctionOP | scorefxn_ |
core::pack::task::TaskFactoryOP | task_factory_ |
task factory for packer ( used only FastRelax as of 11/05/2010 ) More... | |
bool | dry_run_ |
Is this a dry run (i.e. do no cycles) More... | |
protocols::relax::RelaxProtocolBase::RelaxProtocolBase | ( | core::scoring::ScoreFunctionOP | score_in | ) |
References set_defaults().
protocols::relax::RelaxProtocolBase::RelaxProtocolBase | ( | std::string const & | movername = "RelaxProtocol" | ) |
References set_defaults().
protocols::relax::RelaxProtocolBase::RelaxProtocolBase | ( | std::string const & | movername, |
core::scoring::ScoreFunctionOP | score_in | ||
) |
References set_defaults().
|
overridedefault |
|
inlineprotected |
References cst_files_.
Referenced by protocols::relax::FastRelax::parse_my_tag().
void protocols::relax::RelaxProtocolBase::apply_disulfides | ( | core::pose::Pose & | pose | ) |
References movemap_, protocols::antibody::design::repack, and core::pose::Pose::size().
Referenced by protocols::relax::ClassicRelax::apply(), and protocols::relax::MiniRelax::apply().
|
inline |
References cartesian_.
Referenced by protocols::relax::CentroidRelax::apply(), protocols::relax::FastRelax::apply(), protocols::normalmode::NormalModeRelaxMover::apply_on_pose(), protocols::relax::FastRelax::batch_apply(), protocols::relax::FastRelax::check_nonideal_mintype(), protocols::evolution::NucleotideMutation::compute_folding_energies(), protocols::relax::FastRelax::do_minimize(), protocols::relax::FastRelax::parse_my_tag(), protocols::relax::RepeatProteinRelax::relax_pose(), and protocols::relax::CentroidRelax::set_cartesian().
void protocols::relax::RelaxProtocolBase::cartesian | ( | bool | newval | ) |
Use cartesian (minimization step)
Sets to use the lbfgs_armijo_nonmonotone if true or FR default if false Recommended to set max_iter to 200. Requires scorefunction setup for non-ideal minimization.
References cartesian_.
|
inline |
References constrain_coords_.
Referenced by protocols::relax::FastRelax::apply(), and constrain_coords().
void protocols::relax::RelaxProtocolBase::constrain_coords | ( | bool | constrain_coords | ) |
References constrain_coords(), and constrain_coords_.
|
inline |
References constrain_relax_segments_.
Referenced by constrain_relax_segments().
void protocols::relax::RelaxProtocolBase::constrain_relax_segments | ( | bool | constrain_relax_segments | ) |
References constrain_relax_segments(), and constrain_relax_segments_.
|
inline |
References constrain_relax_to_native_coords_.
Referenced by constrain_relax_to_native_coords().
void protocols::relax::RelaxProtocolBase::constrain_relax_to_native_coords | ( | bool | constrain_relax_to_native_coords | ) |
References constrain_relax_to_native_coords(), and constrain_relax_to_native_coords_.
|
inline |
References constrain_relax_to_start_coords_.
Referenced by constrain_relax_to_start_coords().
void protocols::relax::RelaxProtocolBase::constrain_relax_to_start_coords | ( | bool | constrain_relax_to_start_coords | ) |
References constrain_relax_to_start_coords(), and constrain_relax_to_start_coords_.
|
inline |
References coord_constrain_sidechains_.
Referenced by coord_constrain_sidechains().
void protocols::relax::RelaxProtocolBase::coord_constrain_sidechains | ( | bool | coord_constrain_sidechains | ) |
References coord_constrain_sidechains(), and coord_constrain_sidechains_.
|
inlineprotected |
References cst_files_.
Referenced by set_up_constraints().
|
inline |
References dry_run_.
Referenced by protocols::relax::FastRelax::apply(), and protocols::relax::FastRelax::batch_apply().
void protocols::relax::RelaxProtocolBase::dry_run | ( | bool | setting | ) |
References dry_run_.
|
inlineprotected |
References fix_omega_.
|
inlineprotected |
References fix_omega(), and fix_omega_.
Referenced by fix_omega().
|
inlineoverridevirtual |
Generates a new Mover object freshly created with the default ctor.
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.
References protocols::moves::Mover::clone().
core::kinematics::MoveMapOP protocols::relax::RelaxProtocolBase::get_movemap | ( | ) |
References movemap_.
core::kinematics::MoveMapCOP protocols::relax::RelaxProtocolBase::get_movemap | ( | ) | const |
References movemap_.
Referenced by protocols::denovo_design::movers::FastDesign::apply(), protocols::relax::ClassicRelax::apply(), protocols::relax::FastRelax::apply(), protocols::relax::FastRelax::batch_apply(), protocols::denovo_design::movers::FastDesign::create_default_task_factory(), protocols::relax::ClassicRelax::set_default_minimizer(), protocols::relax::ClassicRelax::set_default_moveset_phase1(), protocols::relax::ClassicRelax::set_default_moveset_phase2(), protocols::relax::ClassicRelax::set_default_moveset_phase3(), and protocols::relax::CentroidRelax::setup_class_movemap_and_constraints().
|
protected |
References scorefxn_.
const core::scoring::ScoreFunctionCOP protocols::relax::RelaxProtocolBase::get_scorefxn | ( | ) | const |
References scorefxn_.
Referenced by protocols::denovo_design::movers::FastDesign::apply(), protocols::relax::ClassicRelax::apply(), protocols::relax::FastRelax::apply(), protocols::relax::FastRelax::batch_apply(), protocols::relax::ClassicRelax::check_default_full_repacker(), protocols::relax::ClassicRelax::check_default_mc(), protocols::relax::ClassicRelax::check_default_rottrial(), protocols::relax::FastRelax::inner_loop_reset_reference_command(), protocols::relax::FastRelax::read_script_file(), protocols::relax::ClassicRelax::set_default_minimizer(), protocols::relax::CentroidRelax::set_score_function(), and set_up_constraints().
core::pack::task::TaskFactoryOP const & protocols::relax::RelaxProtocolBase::get_task_factory | ( | ) | const |
References task_factory_.
Referenced by protocols::denovo_design::movers::FastDesign::apply(), protocols::relax::FastRelax::batch_apply(), protocols::relax::ClassicRelax::check_default_full_repacker(), protocols::relax::ClassicRelax::check_default_rottrial(), protocols::denovo_design::movers::FastDesign::create_default_task_factory(), and protocols::relax::FastRelax::setup_local_tf().
|
protected |
References core::conformation::Residue::atom_index(), core::conformation::Residue::atom_is_backbone(), core::id::BB, core::id::D, fix_omega_, core::chemical::ResidueType::has(), core::conformation::Residue::mainchain_atoms(), minimize_bond_angles_, minimize_bond_lengths_, minimize_bondangle_subset_, minimize_bondlength_subset_, movemap_factory_, core::conformation::Residue::natoms(), core::pose::Pose::residue(), core::kinematics::MoveMap::set(), core::pose::Pose::size(), core::id::THETA, protocols::relax::TR(), and core::conformation::Residue::type().
Referenced by protocols::denovo_design::movers::FastDesign::apply(), protocols::relax::ClassicRelax::apply(), protocols::relax::FastRelax::apply(), protocols::relax::FastRelax::batch_apply(), and protocols::relax::CentroidRelax::setup_class_movemap_and_constraints().
|
inlineprotected |
|
inline |
void protocols::relax::RelaxProtocolBase::max_iter | ( | core::Size | max_iter | ) |
References max_iter(), and max_iter_.
|
inline |
References min_type_.
Referenced by protocols::relax::CentroidRelax::apply(), protocols::hybridization::HybridizeProtocol::apply(), protocols::normalmode::NormalModeRelaxMover::apply_on_pose(), protocols::relax::FastRelax::check_nonideal_mintype(), protocols::relax::FastRelax::do_minimize(), min_type(), protocols::relax::FastRelax::parse_my_tag(), protocols::relax::ClassicRelax::set_default(), and protocols::relax::CentroidRelax::set_min_type().
void protocols::relax::RelaxProtocolBase::min_type | ( | std::string | min_type | ) |
References min_type(), and min_type_.
|
inline |
References minimize_bond_angles_.
Referenced by protocols::relax::FastRelax::check_nonideal_mintype(), and minimize_bond_angles().
void protocols::relax::RelaxProtocolBase::minimize_bond_angles | ( | bool | minimize_bond_angles | ) |
References minimize_bond_angles(), and minimize_bond_angles_.
|
inline |
References minimize_bond_lengths_.
Referenced by protocols::relax::FastRelax::check_nonideal_mintype(), and minimize_bond_lengths().
void protocols::relax::RelaxProtocolBase::minimize_bond_lengths | ( | bool | minimize_bond_lengths | ) |
References minimize_bond_lengths(), and minimize_bond_lengths_.
|
inlineprotected |
References minimize_bondangle_subset_.
|
inlineprotected |
References minimize_bondangle_subset(), and minimize_bondangle_subset_.
Referenced by minimize_bondangle_subset().
|
inlineprotected |
References minimize_bondlength_subset_.
|
inlineprotected |
References minimize_bondlength_subset(), and minimize_bondlength_subset_.
Referenced by minimize_bondlength_subset().
|
protected |
|
overridevirtual |
Provide the citation.
Reimplemented from protocols::moves::Mover.
References scorefxn_, and task_factory_.
Referenced by protocols::relax::FastRelax::provide_citation_info().
|
inline |
void protocols::relax::RelaxProtocolBase::ramp_down_constraints | ( | bool | ramp_down_constraints | ) |
References ramp_down_constraints(), and ramp_down_constraints_.
|
static |
Referenced by protocols::relax::ClassicRelax::register_options().
void protocols::relax::RelaxProtocolBase::set_default_coordinate_settings | ( | ) |
void protocols::relax::RelaxProtocolBase::set_default_minimization_settings | ( | ) |
References cartesian_, fix_omega_, max_iter_, min_type_, minimize_bond_angles_, minimize_bond_lengths_, minimize_bondangle_subset_, and minimize_bondlength_subset_.
Referenced by set_defaults().
void protocols::relax::RelaxProtocolBase::set_default_movemap | ( | ) |
References movemap_.
Referenced by protocols::relax::ClassicRelax::set_default(), and set_defaults().
void protocols::relax::RelaxProtocolBase::set_defaults | ( | ) |
References dry_run_, set_default_coordinate_settings(), set_default_minimization_settings(), and set_default_movemap().
Referenced by RelaxProtocolBase().
void protocols::relax::RelaxProtocolBase::set_movemap | ( | core::kinematics::MoveMapOP | movemap | ) |
References movemap_.
Referenced by protocols::normalmode::NormalModeRelaxMover::apply_on_pose(), protocols::relax::CentroidRelax::CentroidRelax(), protocols::relax::ClassicRelax::ClassicRelax(), protocols::evolution::NucleotideMutation::compute_folding_energies(), protocols::loops::loop_closure::ccd::FASelectSlidingWindowLoopClosure::fascore(), protocols::residue_optimization::MetapatchEnumeration::final_sampling(), protocols::residue_optimization::MetapatchEnumeration::initial_sampling(), protocols::cyclic_peptide::CrosslinkerMover::pack_and_minimize_linker_and_sidechains(), protocols::relax::FastRelax::parse_my_tag(), protocols::relax::RepeatProteinRelax::relax_pose(), and protocols::relax::CentroidRelax::setup_class_movemap_and_constraints().
void protocols::relax::RelaxProtocolBase::set_movemap_factory | ( | core::select::movemap::MoveMapFactoryOP | mm_factory | ) |
References movemap_factory_.
Referenced by protocols::relax::FastRelax::parse_my_tag().
void protocols::relax::RelaxProtocolBase::set_scorefxn | ( | core::scoring::ScoreFunctionOP | scorefxn | ) |
void protocols::relax::RelaxProtocolBase::set_task_factory | ( | core::pack::task::TaskFactoryOP | task_factory | ) |
|
protected |
References core::conformation::Residue::aa(), core::chemical::aa_vrt, core::pose::addVirtualResAsRoot(), protocols::relax::AtomCoordinateCstMover::ambiguous_hnq(), protocols::relax::AtomCoordinateCstMover::apply(), core::scoring::atom_pair_constraint, protocols::relax::AtomCoordinateCstMover::bounded(), core::io::pdb::build_pose_from_pdb_as_is(), constrain_coords_, constrain_relax_segments_, constrain_relax_to_native_coords_, core::pose::Pose::constraint_set(), coord_constrain_sidechains_, core::scoring::coordinate_constraint, cst_files(), cst_files_, protocols::relax::AtomCoordinateCstMover::cst_sd(), protocols::relax::AtomCoordinateCstMover::cst_sidechain(), protocols::relax::AtomCoordinateCstMover::cst_width(), protocols::relax::cyclize_pose(), protocols::relax::derive_sc_sc_restraints(), protocols::abinitio::filename(), core::pose::Pose::fold_tree(), get_scorefxn(), core::pose::Pose::num_jump(), core::pose::Pose::residue(), core::kinematics::FoldTree::root(), core::kinematics::MoveMap::set_jump(), protocols::relax::AtomCoordinateCstMover::set_loop_segments(), and protocols::relax::AtomCoordinateCstMover::set_refstruct().
Referenced by protocols::relax::ClassicRelax::apply(), protocols::relax::FastRelax::apply(), and protocols::relax::CentroidRelax::setup_class_movemap_and_constraints().
|
private |
Do cartesian-space minimization?
Referenced by cartesian(), and set_default_minimization_settings().
|
private |
Referenced by constrain_coords(), set_default_coordinate_settings(), and set_up_constraints().
|
private |
Referenced by constrain_relax_segments(), set_default_coordinate_settings(), and set_up_constraints().
|
private |
Referenced by constrain_relax_to_native_coords(), set_default_coordinate_settings(), and set_up_constraints().
|
private |
Referenced by constrain_relax_to_start_coords(), and set_default_coordinate_settings().
|
private |
Referenced by coord_constrain_sidechains(), set_default_coordinate_settings(), and set_up_constraints().
|
private |
Referenced by add_cst_files(), cst_files(), and set_up_constraints().
|
private |
Is this a dry run (i.e. do no cycles)
Referenced by dry_run(), and set_defaults().
|
private |
Referenced by fix_omega(), initialize_movemap(), and set_default_minimization_settings().
|
private |
Referenced by limit_aroma_chi2(), and set_default_coordinate_settings().
|
private |
maximum minimizer iterations
Referenced by max_iter(), and set_default_minimization_settings().
|
private |
Referenced by min_type(), and set_default_minimization_settings().
|
private |
Referenced by initialize_movemap(), minimize_bond_angles(), and set_default_minimization_settings().
|
private |
Referenced by initialize_movemap(), minimize_bond_lengths(), and set_default_minimization_settings().
|
private |
Referenced by initialize_movemap(), minimize_bondangle_subset(), and set_default_minimization_settings().
|
private |
Referenced by initialize_movemap(), minimize_bondlength_subset(), and set_default_minimization_settings().
|
private |
Referenced by apply_disulfides(), get_movemap(), set_default_movemap(), and set_movemap().
|
private |
Referenced by initialize_movemap(), and set_movemap_factory().
|
private |
Referenced by ramp_down_constraints(), and set_default_coordinate_settings().
|
private |
Referenced by get_scorefxn(), provide_citation_info(), and set_scorefxn().
|
private |
task factory for packer ( used only FastRelax as of 11/05/2010 )
Referenced by get_task_factory(), provide_citation_info(), and set_task_factory().