IMP logo
IMP Reference Guide  2.11.1
The Integrative Modeling Platform
IMP::core::TransformationSymmetry Class Reference

Set the coordinates of a particle to be a transformed version of a reference. More...

#include <IMP/core/symmetry.h>

+ Inheritance diagram for IMP::core::TransformationSymmetry:

Detailed Description

Set the coordinates of a particle to be a transformed version of a reference.

The passed particles must be Reference particles and XYZ particles and can be RigidBody particles iff the reference particle is a rigid body.

See Also
TransformationAndReflectionSymmetry

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

Public Member Functions

 TransformationSymmetry (const algebra::Transformation3D &t)
 Create with both rotation and translation. More...
 
 TransformationSymmetry (ParticleIndex rb_pi)
 Create based on a rigid body transformation. More...
 
virtual void apply_index (Model *m, ParticleIndex p) const
 
virtual void apply_indexes (Model *m, const ParticleIndexes &o, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the inputs. More...
 
virtual ModelObjectsTemp do_get_outputs (Model *m, const ParticleIndexes &pis) const
 Overload this method to specify the outputs. More...
 
algebra::Transformation3D get_transformation () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set_transformation (algebra::Transformation3D t)
 Set a new transformation to use. More...
 
- Public Member Functions inherited from IMP::SingletonModifier
 SingletonModifier (std::string name="SingletonModifier %1%")
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::ParticleOutputs
ModelObjectsTemp get_outputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects changed when the given list of particles is used. 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)
 

Additional Inherited Members

- Public Types inherited from IMP::SingletonModifier
typedef ParticleArgument
 
typedef ParticleIndex IndexArgument
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::core::TransformationSymmetry::TransformationSymmetry ( const algebra::Transformation3D t)

Create with both rotation and translation.

IMP::core::TransformationSymmetry::TransformationSymmetry ( ParticleIndex  rb_pi)

Create based on a rigid body transformation.

Note
If the rigid body reference frame changes, the transformation used by this Modifier will also change.

Member Function Documentation

virtual void IMP::core::TransformationSymmetry::apply_index ( Model m,
ParticleIndex  v 
) const
virtual

Apply the function to a single value

Implements IMP::SingletonModifier.

virtual void IMP::core::TransformationSymmetry::apply_indexes ( Model m,
const ParticleIndexes o,
unsigned int  lower_bound,
unsigned int  upper_bound 
) const
virtual

Apply the function to a collection of ParticlesTemp If bounds are passed, only apply to ones between the upper and lower bounds.

Reimplemented from IMP::SingletonModifier.

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

virtual ModelObjectsTemp IMP::core::TransformationSymmetry::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual ModelObjectsTemp IMP::core::TransformationSymmetry::do_get_outputs ( Model m,
const ParticleIndexes pis 
) const
virtual

Overload this method to specify the outputs.

Implements IMP::ParticleOutputs.

virtual ::IMP::VersionInfo IMP::core::TransformationSymmetry::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

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

void IMP::core::TransformationSymmetry::set_transformation ( algebra::Transformation3D  t)

Set a new transformation to use.

Note
the transformation will not be applied until Model.update() is called or the model score is evaluated

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


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