IMP logo
IMP Reference Guide  2.20.1
The Integrative Modeling Platform
IMP::core::TransformationSymmetryMover Class Reference

Modify the given TransformationSymmetry. More...

#include <IMP/core/symmetry.h>

+ Inheritance diagram for IMP::core::TransformationSymmetryMover:

Detailed Description

Modify the given TransformationSymmetry.

The effect of this Mover is similar to applying a RigidBodyMover to every Particle that is affected by the TransformationSymmetry Modifier, that is the transformation of the TransformationSymmetry is modified such that these Particles end up being randomly rotated and translated (relative to their original positions) within a ball of given size. Rotations are made around the given pivot in the reference frame of the reference particles (usually the pivot is one of the particles that is a reference for the TransformationSymmetry).

Definition at line 124 of file core/symmetry.h.

Public Member Functions

 TransformationSymmetryMover (Model *m, TransformationSymmetry *symm, ParticleIndex pivot, Float max_translation, Float max_rotation)
 
Float get_maximum_rotation () const
 
Float get_maximum_translation () const
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
void set_maximum_rotation (Float mr)
 
void set_maximum_translation (Float mt)
 
- Public Member Functions inherited from IMP::core::MonteCarloMover
 MonteCarloMover (Model *m, std::string name)
 
void accept ()
 Accept/commit any changes made to the Particles. More...
 
MonteCarloMoverResult propose ()
 Propose a modification. More...
 
void reject ()
 Roll back any changes made to the Particles. More...
 
unsigned int get_number_of_proposed () const
 
unsigned int get_number_of_accepted () const
 
void reset_statistics ()
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Protected Member Functions

virtual ModelObjectsTemp do_get_inputs () const override
 
virtual MonteCarloMoverResult do_propose () override
 Implement propose_move() More...
 
virtual void do_reject () override
 Implement reset_proposed_move() More...
 
- Protected Member Functions inherited from IMP::core::MonteCarloMover
virtual void do_accept ()
 Implement accept_proposed_move(); default implementation is empty. More...
 
virtual ModelObjectsTemp do_get_outputs () const override
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual ModelObjectsTemp IMP::core::TransformationSymmetryMover::do_get_inputs ( ) const
overrideprotectedvirtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

virtual MonteCarloMoverResult IMP::core::TransformationSymmetryMover::do_propose ( )
overrideprotectedvirtual

Implement propose_move()

Implements IMP::core::MonteCarloMover.

virtual void IMP::core::TransformationSymmetryMover::do_reject ( )
overrideprotectedvirtual

Implement reset_proposed_move()

Implements IMP::core::MonteCarloMover.

virtual ::IMP::VersionInfo IMP::core::TransformationSymmetryMover::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 157 of file core/symmetry.h.


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