IMP logo
IMP Reference Guide  develop.374319d7bb,2024/06/17
The Integrative Modeling Platform
IMP::em2d::RelativePositionMover Class Reference

#include <IMP/em2d/RelativePositionMover.h>

+ Inheritance diagram for IMP::em2d::RelativePositionMover:

Detailed Description

Move a nested rigid body.

Definition at line 30 of file RelativePositionMover.h.

Public Member Functions

 RelativePositionMover (core::RigidBody d, Float max_translation, Float max_rotation)
 
void add_internal_transformations (core::RigidBody d, algebra::Transformation3Ds transforms)
 
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_random_move_probability (Float p)
 
- Public Member Functions inherited from IMP::core::RigidBodyMover
 RigidBodyMover (Model *m, ParticleIndex pi, Float max_translation, Float max_rotation)
 Constructor. The given rigid body is rotated and translated. More...
 
Float get_maximum_rotation () const
 
Float get_maximum_translation () const
 
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 core::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::RigidBodyMover
virtual ModelObjectsTemp do_get_inputs () const override
 
- 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 ()
 

Protected Attributes

algebra::Transformation3D last_transformation_
 
Float max_angle_
 
Float max_translation_
 
Float probability_of_random_move_
 
core::RigidBody rbA_
 
core::RigidBodies reference_rbs_
 
Transformation3DsList transformations_map_
 

Member Function Documentation

void IMP::em2d::RelativePositionMover::add_internal_transformations ( core::RigidBody  d,
algebra::Transformation3Ds  transforms 
)

Adds a reference RigidBody and the set of internal transformations. The internal transformations are used for positioning the rigid body that this Mover is moving

Parameters
[in]dReference rigid body
[in]transformsThe internal transformations
virtual core::MonteCarloMoverResult IMP::em2d::RelativePositionMover::do_propose ( )
overrideprotectedvirtual

Implement propose_move()

Reimplemented from IMP::core::RigidBodyMover.

virtual void IMP::em2d::RelativePositionMover::do_reject ( )
overrideprotectedvirtual

Implement reset_proposed_move()

Reimplemented from IMP::core::RigidBodyMover.

virtual ::IMP::VersionInfo IMP::em2d::RelativePositionMover::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::core::RigidBodyMover.

Definition at line 63 of file RelativePositionMover.h.

void IMP::em2d::RelativePositionMover::set_random_move_probability ( Float  p)
Parameters
[in]pProbability of a random move instead of a relative one. default is 0.

Definition at line 58 of file RelativePositionMover.h.


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