IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::em2d::ProjectionParameters Class Reference

#include <IMP/em2d/ProjectionParameters.h>

+ Inheritance diagram for IMP::em2d::ProjectionParameters:

Detailed Description

Decorator for particles representing the parameters Rotation and translation. In this cases, the translation is the translation to apply to the model in 3D, in order to perform the registration

Definition at line 23 of file ProjectionParameters.h.

Public Member Functions

 ProjectionParameters (::IMP::Model *m,::IMP::ParticleIndex id)
 
 ProjectionParameters (const IMP::ParticleAdaptor &d)
 
bool get_parameters_optimized () const
 Get whether the parameters are optimized. More...
 
double get_quaternion_1 () const
 Get and set functions for the parameters. More...
 
double get_quaternion_2 () const
 
double get_quaternion_3 () const
 
double get_quaternion_4 () const
 
algebra::Rotation3D get_rotation () const
 
algebra::Vector3D get_translation () const
 
double get_translation_x () const
 
double get_translation_y () const
 
void set_parameters_optimized (bool tf) const
 Set whether the parameters are optimized. More...
 
void set_proper_ranges_for_keys (Model *m, const algebra::Vector3D &min_translation_values, const algebra::Vector3D &max_translation_values)
 
void set_quaternion_1 (double t)
 
void set_quaternion_2 (double t)
 
void set_quaternion_3 (double t)
 
void set_quaternion_4 (double t)
 
void set_rotation (const algebra::Rotation3D &R)
 
void set_translation (const algebra::Vector3D &v)
 
void set_translation_x (double t)
 
void set_translation_y (double t)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::Decorator
bool get_is_valid () const
 Returns true if constructed with a non-default constructor. More...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_particle () const
 Returns the particle decorated by this decorator. More...
 
ParticleIndex get_particle_index () const
 Returns the particle index decorated by this decorator. More...
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 Return true if the particle is a set of projection parameters. More...
 
static const FloatKeysget_keys ()
 Keys of the decorator. More...
 
static ProjectionParameters setup_particle (IMP::ParticleAdaptor pa)
 
static ProjectionParameters setup_particle (Model *m, ParticleIndex pi)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

static bool IMP::em2d::ProjectionParameters::get_is_setup ( Model m,
ParticleIndex  pi 
)
static

Return true if the particle is a set of projection parameters.

static const FloatKeys& IMP::em2d::ProjectionParameters::get_keys ( )
static

Keys of the decorator.

bool IMP::em2d::ProjectionParameters::get_parameters_optimized ( ) const

Get whether the parameters are optimized.

Returns
true only if all of them are optimized.

Definition at line 48 of file ProjectionParameters.h.

+ Here is the call graph for this function:

double IMP::em2d::ProjectionParameters::get_quaternion_1 ( ) const

Get and set functions for the parameters.

returns the value of the quaternion_1 attribute

Definition at line 90 of file ProjectionParameters.h.

double IMP::em2d::ProjectionParameters::get_quaternion_2 ( ) const

returns the value of the quaternion_2 attribute

Definition at line 91 of file ProjectionParameters.h.

double IMP::em2d::ProjectionParameters::get_quaternion_3 ( ) const

returns the value of the quaternion_3 attribute

Definition at line 92 of file ProjectionParameters.h.

double IMP::em2d::ProjectionParameters::get_quaternion_4 ( ) const

returns the value of the quaternion_4 attribute

Definition at line 93 of file ProjectionParameters.h.

double IMP::em2d::ProjectionParameters::get_translation_x ( ) const

returns the value of the translation_x attribute

Definition at line 94 of file ProjectionParameters.h.

double IMP::em2d::ProjectionParameters::get_translation_y ( ) const

returns the value of the translation_y attribute

Definition at line 95 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_parameters_optimized ( bool  tf) const

Set whether the parameters are optimized.

Definition at line 83 of file ProjectionParameters.h.

+ Here is the call graph for this function:

void IMP::em2d::ProjectionParameters::set_proper_ranges_for_keys ( Model m,
const algebra::Vector3D min_translation_values,
const algebra::Vector3D max_translation_values 
)

ranges for the keys. Only adjust the translations, the rotations are self adjusted

void IMP::em2d::ProjectionParameters::set_quaternion_1 ( double  t)

sets the value of the quaternion_1 attribute to t

Definition at line 90 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_quaternion_2 ( double  t)

sets the value of the quaternion_2 attribute to t

Definition at line 91 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_quaternion_3 ( double  t)

sets the value of the quaternion_3 attribute to t

Definition at line 92 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_quaternion_4 ( double  t)

sets the value of the quaternion_4 attribute to t

Definition at line 93 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_translation_x ( double  t)

sets the value of the translation_x attribute to t

Definition at line 94 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_translation_y ( double  t)

sets the value of the translation_y attribute to t

Definition at line 95 of file ProjectionParameters.h.

static ProjectionParameters IMP::em2d::ProjectionParameters::setup_particle ( Model m,
ParticleIndex  pi 
)
static
Returns
a ProjectionParameters object that decorates particle pi

Definition at line 28 of file ProjectionParameters.h.

static ProjectionParameters IMP::em2d::ProjectionParameters::setup_particle ( IMP::ParticleAdaptor  pa)
static
Returns
a ProjectionParameters object that decorates the particle specified by pa
See Also
setup_particle(m, p)

Definition at line 28 of file ProjectionParameters.h.


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