protocols::canonical_sampling::CanonicalSamplingMover Class Reference

#include <CanonicalSamplingMover.hh>

Public Member Functions
	CanonicalSamplingMover ()
	CanonicalSamplingMover (core::scoring::ScoreFunctionOP sfxn, mc_convergence_checks::Pool_RMSD_OP ptr, int ntrial)
void	add_mover (protocols::moves::MoverOP m, core::Real weight)
std::string	get_ABGEO_string (core::pose::Pose &pose, protocols::loops::Loops &loop)
void	ntrials (int ntrial)
void	set_defaults_from_cmdline ()
void	set_temp (core::Real temperature)
core::Real	get_temp ()
void	set_interval_pose_dump (int p_interval)
void	set_interval_data_dump (int d_interval)
void	set_scorefunction (core::scoring::ScoreFunctionOP sfxn)
void	detailed_balance (bool truefalse)
bool	detailed_balance () const
core::Real	transition_threshold () const
void	use_MPI_sync_pools (bool truefalse)
bool	use_MPI_sync_pools () const
void	use_MPI_bcast (bool truefalse)
bool	use_MPI_bcast () const
void	use_hierarchical_clustering (bool truefalse)
bool	use_hierarchical_clustering () const
void	output_only_cluster_transitions (bool truefalse)
void	set_poolrmsd (mc_convergence_checks::Pool_RMSD_OP ptr)
virtual void	apply (core::pose::Pose &pose)
virtual std::string	get_name () const
	Each derived class must specify its name. The class name. 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...
virtual core::Real	last_proposal_density_ratio ()
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
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...
void	type (const std::string &type_in)
virtual MoverOP	clone () const
	Return a clone of the Mover object. More...
virtual void	parse_my_tag (TagCOP tag, basic::datacache::DataMap &data, Filters_map const &filters, Movers_map const &movers, Pose const &pose)
	Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...
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
	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...
virtual MoverOP	fresh_instance () const
	Generates a new Mover object freshly created with the default ctor. More...
void	set_current_job (protocols::jobdist::BasicJobCOP job)
jobdist::BasicJobCOP	get_current_job () const
virtual void	show (std::ostream &output=std::cout) const
	Outputs details about the Mover, including current settings. More...

Static Public Member Functions
static void	register_options ()
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
core::Real	periodic_range (core::Real a, core::Real x)
void	dump_xtc_format_decoy (std::ostream &os, core::pose::Pose const &pose, loops::Loops const &loop_to_dump)
void	dump_decoy_or_score (std::ostream &os, core::pose::Pose const &pose, core::Size i_trial, std::string const &jobname, loops::Loops const &loop_to_dump, bool score_only=false)
void	setup_constraints (core::pose::Pose &pose)

Private Attributes
protocols::moves::MonteCarloOP	mc_
core::scoring::ScoreFunctionOP	sfxn_
moves::RandomMoverOP	randmove_
mc_convergence_checks::Pool_RMSD_OP	pool_rms_
core::Size	interval_posedump_
core::Size	interval_transitiondump_
core::Size	ntrials_
bool	detailed_balance_
bool	MPI_synchronize_pools_
bool	MPI_bcast_
bool	use_hierarchical_clustering_
bool	save_loops_only_
bool	dump_loops_only_
bool	output_only_cluster_transition_
core::Real	transition_threshold_
core::Real	temperature_
bool	ramp_temperature_
bool	boinc_mode_

Static Private Attributes
static bool	options_registered_

Additional Inherited Members
Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP	TagCOP
typedef core::pose::Pose	Pose
typedef core::pose::PoseCOP	PoseCOP
typedef protocols::filters::Filters_map	Filters_map
typedef std::list< std::string >	Strings
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...

Constructor & Destructor Documentation

protocols::canonical_sampling::CanonicalSamplingMover::CanonicalSamplingMover

(

)

References set_defaults_from_cmdline().

protocols::canonical_sampling::CanonicalSamplingMover::CanonicalSamplingMover	(	core::scoring::ScoreFunctionOP	sfxn,
		mc_convergence_checks::Pool_RMSD_OP	ptr,
		int	ntrial
	)

References canonical_sampling, mc_kt, option, options, runtime_assert, sampling, and set_defaults_from_cmdline().

Member Function Documentation

void protocols::canonical_sampling::CanonicalSamplingMover::add_mover	(	protocols::moves::MoverOP	m,
		core::Real	weight
	)

References protocols::moves::MoverContainer::add_mover(), and randmove_.

void protocols::canonical_sampling::CanonicalSamplingMover::apply ( core::pose::Pose &  pose )

virtual

Implements protocols::moves::Mover.

References protocols::viewer::add_conformation_viewer(), core::scoring::constraints::add_constraints_from_cmdline(), protocols::moves::RandomMover::apply(), core::scoring::atom_pair_constraint, boinc_mode_, protocols::moves::MonteCarlo::boltzmann(), core::scoring::CA_rmsd(), core::pose::Pose::conformation(), constraints::cst_file, protocols::jd2::JobDistributor::current_job(), protocols::jd2::current_output_name(), detailed_balance_, dump_decoy_or_score(), utility::file::file_exists(), utility::file::file_size(), utility::pointer::owning_ptr< T >::get(), get_ABGEO_string(), core::io::silent::SilentStructFactory::get_instance(), protocols::jd2::JobDistributor::get_instance(), core::io::silent::SilentStructFactory::get_silent_struct_in(), utility::file::gzip(), protocols::init::init(), interval_posedump_, interval_transitiondump_, protocols::jd2::JobDistributor::job_outputter(), jobname, protocols::canonical_sampling::jobname_dirhash(), protocols::moves::RandomMover::last_proposal_density_ratio(), basic::options::OptionKeys::loops::loop_file, loops, basic::options::OptionKeys::canonical_sampling::sampling::max_files_per_dir, mc_, basic::options::OptionKeys::canonical_sampling::sampling::mc_kt, MPI_bcast_, MPI_synchronize_pools_, basic::MPICANONICALSAMPLING, protocols::moves::Mover::name(), basic::options::OptionKeys::canonical_sampling::out::new_structures, ntrials_, option, output_only_cluster_transition_, pool_rms_, PROF_START, PROF_STOP, ramp_temperature_, randmove_, core::io::silent::SilentFileData::read_file(), core::io::silent::SilentFileData::read_tags_fast(), core::pose::Pose::remove_constraints(), protocols::moves::MonteCarlo::reset(), runtime_assert, save_loops_only_, core::io::silent::SilentFileData::set_filename(), protocols::moves::MonteCarlo::set_temperature(), setup_constraints(), sfxn_, protocols::moves::MonteCarlo::temperature(), core::pose::Pose::total_residue(), protocols::canonical_sampling::tr, transition_threshold_, protocols::moves::Mover::type(), use_hierarchical_clustering_, user, and utility_exit_with_message.

void protocols::canonical_sampling::CanonicalSamplingMover::detailed_balance

(

bool

truefalse

)

References detailed_balance_.

bool protocols::canonical_sampling::CanonicalSamplingMover::detailed_balance ( ) const

inline

Referenced by set_defaults_from_cmdline().

void protocols::canonical_sampling::CanonicalSamplingMover::dump_decoy_or_score ( std::ostream &  os, core::pose::Pose const &  pose, core::Size  i_trial, std::string const &  jobname, loops::Loops const &  loop_to_dump, bool  score_only = false  )

private

void CanonicalSamplingMover::dump_xtc_format_decoy( std::ostream& os, core::pose::Pose const& pose, loops::Loops const& loop_to_dump ) {

}

References protocols::loops::Loops::begin(), boinc_mode_, basic::CANONICALMOVER_WRITE_TO_FILE, dump_loops_only_, protocols::loops::Loops::end(), core::io::silent::SilentStruct::fill_struct(), core::io::silent::SilentStructFactory::get_instance(), core::io::silent::SilentStructFactory::get_silent_struct(), core::io::silent::SilentStructFactory::get_silent_struct_out(), interval_posedump_, interval_transitiondump_, protocols::loops::Loops::num_loop(), PROF_START, PROF_STOP, ss, and core::io::silent::SilentFileData::write_silent_struct().

Referenced by apply().

void protocols::canonical_sampling::CanonicalSamplingMover::dump_xtc_format_decoy ( std::ostream &  os, core::pose::Pose const &  pose, loops::Loops const &  loop_to_dump  )

private

std::string protocols::canonical_sampling::CanonicalSamplingMover::get_ABGEO_string	(	core::pose::Pose &	pose,
		protocols::loops::Loops &	loop
	)

References protocols::loops::Loops::begin(), protocols::loops::Loops::end(), core::pose::Pose::omega(), protocols::stepwise::sampling::protein::omega(), periodic_range(), core::pose::Pose::phi(), protocols::stepwise::sampling::protein::phi(), core::pose::Pose::psi(), and protocols::stepwise::sampling::protein::psi().

Referenced by apply().

std::string protocols::canonical_sampling::CanonicalSamplingMover::get_name ( ) const

virtual

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

Implements protocols::moves::Mover.

core::Real protocols::canonical_sampling::CanonicalSamplingMover::get_temp ( )

inline

void protocols::canonical_sampling::CanonicalSamplingMover::ntrials

(

int

ntrial

)

References ntrials_.

Referenced by set_defaults_from_cmdline().

void protocols::canonical_sampling::CanonicalSamplingMover::output_only_cluster_transitions

(

bool

truefalse

)

References output_only_cluster_transition_.

Referenced by set_defaults_from_cmdline().

core::Real protocols::canonical_sampling::CanonicalSamplingMover::periodic_range ( core::Real  a, core::Real  x  )

private

References mod().

Referenced by get_ABGEO_string().

void protocols::canonical_sampling::CanonicalSamplingMover::register_options ( )

static

References canonical_sampling::sampling::dump_loops_only, canonical_sampling::sampling::interval_data_dump, canonical_sampling::sampling::interval_pose_dump, mc::known_structures, canonical_sampling::sampling::max_files_per_dir, canonical_sampling::sampling::mc_kt, canonical_sampling::out::new_structures, canonical_sampling::sampling::no_detailed_balance, canonical_sampling::sampling::ntrials, OPT, options_registered_, canonical_sampling::sampling::output_only_cluster_transitions, out::path::path, canonical_sampling::sampling::save_loops_only, and canonical_sampling::sampling::transition_threshold.

void protocols::canonical_sampling::CanonicalSamplingMover::set_defaults_from_cmdline

(

)

References boinc_mode_, detailed_balance(), basic::options::OptionKeys::canonical_sampling::sampling::dump_loops_only, dump_loops_only_, basic::options::OptionKeys::canonical_sampling::sampling::interval_data_dump, basic::options::OptionKeys::canonical_sampling::sampling::interval_pose_dump, basic::options::OptionKeys::canonical_sampling::sampling::no_detailed_balance, basic::options::OptionKeys::canonical_sampling::sampling::ntrials, ntrials(), option, options_registered_, basic::options::OptionKeys::canonical_sampling::sampling::output_only_cluster_transitions, output_only_cluster_transitions(), run::protocol, ramp_temperature_, runtime_assert, basic::options::OptionKeys::canonical_sampling::sampling::save_loops_only, save_loops_only_, set_interval_data_dump(), set_interval_pose_dump(), basic::options::OptionKeys::canonical_sampling::sampling::transition_threshold, transition_threshold_, and user.

Referenced by CanonicalSamplingMover().

void protocols::canonical_sampling::CanonicalSamplingMover::set_interval_data_dump

(

int

d_interval

)

References interval_transitiondump_.

Referenced by set_defaults_from_cmdline().

void protocols::canonical_sampling::CanonicalSamplingMover::set_interval_pose_dump

(

int

p_interval

)

References interval_posedump_.

Referenced by set_defaults_from_cmdline().

void protocols::canonical_sampling::CanonicalSamplingMover::set_poolrmsd

(

mc_convergence_checks::Pool_RMSD_OP

ptr

)

References pool_rms_.

void protocols::canonical_sampling::CanonicalSamplingMover::set_scorefunction

(

core::scoring::ScoreFunctionOP

sfxn

)

References sfxn_.

void protocols::canonical_sampling::CanonicalSamplingMover::set_temp

(

core::Real

temperature

)

References mc_, sfxn_, and temperature_.

void protocols::canonical_sampling::CanonicalSamplingMover::setup_constraints ( core::pose::Pose &  pose )

private

References core::pose::Pose::add_constraint(), core::conformation::Residue::atom_index(), length, core::pose::Pose::remove_constraints(), core::pose::Pose::residue(), core::pose::Pose::total_residue(), and core::conformation::Residue::xyz().

Referenced by apply().

core::Real protocols::canonical_sampling::CanonicalSamplingMover::transition_threshold ( ) const

inline

void protocols::canonical_sampling::CanonicalSamplingMover::use_hierarchical_clustering

(

bool

truefalse

)

References use_hierarchical_clustering_.

bool protocols::canonical_sampling::CanonicalSamplingMover::use_hierarchical_clustering ( ) const

inline

void protocols::canonical_sampling::CanonicalSamplingMover::use_MPI_bcast

(

bool

truefalse

)

References MPI_bcast_.

bool protocols::canonical_sampling::CanonicalSamplingMover::use_MPI_bcast ( ) const

inline

void protocols::canonical_sampling::CanonicalSamplingMover::use_MPI_sync_pools

(

bool

truefalse

)

References MPI_synchronize_pools_.

bool protocols::canonical_sampling::CanonicalSamplingMover::use_MPI_sync_pools ( ) const

inline

Member Data Documentation

bool protocols::canonical_sampling::CanonicalSamplingMover::boinc_mode_

private

Referenced by apply(), dump_decoy_or_score(), and set_defaults_from_cmdline().

bool protocols::canonical_sampling::CanonicalSamplingMover::detailed_balance_

private

Referenced by apply(), and detailed_balance().

bool protocols::canonical_sampling::CanonicalSamplingMover::dump_loops_only_

private

Referenced by dump_decoy_or_score(), and set_defaults_from_cmdline().

core::Size protocols::canonical_sampling::CanonicalSamplingMover::interval_posedump_

private

Referenced by apply(), dump_decoy_or_score(), and set_interval_pose_dump().

core::Size protocols::canonical_sampling::CanonicalSamplingMover::interval_transitiondump_

private

Referenced by apply(), dump_decoy_or_score(), and set_interval_data_dump().

protocols::moves::MonteCarloOP protocols::canonical_sampling::CanonicalSamplingMover::mc_

private

Referenced by apply(), and set_temp().

bool protocols::canonical_sampling::CanonicalSamplingMover::MPI_bcast_

private

Referenced by apply(), and use_MPI_bcast().

bool protocols::canonical_sampling::CanonicalSamplingMover::MPI_synchronize_pools_

private

Referenced by apply(), and use_MPI_sync_pools().

core::Size protocols::canonical_sampling::CanonicalSamplingMover::ntrials_

private

Referenced by apply(), and ntrials().

bool protocols::canonical_sampling::CanonicalSamplingMover::options_registered_

staticprivate

Referenced by register_options(), and set_defaults_from_cmdline().

bool protocols::canonical_sampling::CanonicalSamplingMover::output_only_cluster_transition_

private

Referenced by apply(), and output_only_cluster_transitions().

mc_convergence_checks::Pool_RMSD_OP protocols::canonical_sampling::CanonicalSamplingMover::pool_rms_

private

Referenced by apply(), and set_poolrmsd().

bool protocols::canonical_sampling::CanonicalSamplingMover::ramp_temperature_

private

Referenced by apply(), and set_defaults_from_cmdline().

moves::RandomMoverOP protocols::canonical_sampling::CanonicalSamplingMover::randmove_

private

Referenced by add_mover(), and apply().

bool protocols::canonical_sampling::CanonicalSamplingMover::save_loops_only_

private

Referenced by apply(), and set_defaults_from_cmdline().

core::scoring::ScoreFunctionOP protocols::canonical_sampling::CanonicalSamplingMover::sfxn_

private

Referenced by apply(), set_scorefunction(), and set_temp().

core::Real protocols::canonical_sampling::CanonicalSamplingMover::temperature_

private

Referenced by set_temp().

core::Real protocols::canonical_sampling::CanonicalSamplingMover::transition_threshold_

private

Referenced by apply(), and set_defaults_from_cmdline().

bool protocols::canonical_sampling::CanonicalSamplingMover::use_hierarchical_clustering_

private

Referenced by apply(), and use_hierarchical_clustering().

---

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

• symlinks/rosetta/src/protocols/canonical_sampling/CanonicalSamplingMover.hh
• symlinks/rosetta/src/protocols/canonical_sampling/CanonicalSamplingMover.cc