IMP  2.1.1
The Integrative Modeling Platform
Public Member Functions | Static Public Member Functions | List of all members
IMP::em2d::ProjectionParameters Class Reference

#include <IMP/em2d/ProjectionParameters.h>

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

Public Member Functions

 ProjectionParameters (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 ProjectionParameters (const IMP::kernel::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.
 
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.
 
void set_proper_ranges_for_keys (kernel::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::kernel::Decorator
ParticleIndex get_particle_index () const
 
Particle * get_particle () const
 
Model * get_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static ProjectionParameters decorate_particle (::IMP::kernel::Particle *p)
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 Return true of the particle is a set of projection parameters.
 
static const FloatKeys & get_keys ()
 Keys of the decorator.
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static ProjectionParameters setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static ProjectionParameters setup_particle (kernel::Model *m, ParticleIndex pi)
 
- Static Public Member Functions inherited from IMP::kernel::Decorator
static bool get_is_setup (Particle *p)
 Return true if the particle can be cast to the decorator. More...
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 26 of file ProjectionParameters.h.

Member Function Documentation

static ProjectionParameters IMP::em2d::ProjectionParameters::decorate_particle ( ::IMP::kernel::Particle *  p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 32 of file ProjectionParameters.h.

bool IMP::em2d::ProjectionParameters::get_parameters_optimized ( ) const
Returns
true only if all of them are optimized.

Definition at line 54 of file ProjectionParameters.h.

+ Here is the call graph for this function:

static bool IMP::em2d::ProjectionParameters::particle_is_instance ( ::IMP::kernel::Particle *  p)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file ProjectionParameters.h.

static bool IMP::em2d::ProjectionParameters::particle_is_instance ( IMP::kernel::Model *  m,
IMP::kernel::ParticleIndex  pi 
)
static
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 32 of file ProjectionParameters.h.

void IMP::em2d::ProjectionParameters::set_proper_ranges_for_keys ( kernel::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

static ProjectionParameters IMP::em2d::ProjectionParameters::setup_particle ( kernel::Model *  m,
ParticleIndex  pi 
)
static

Setup the particle so it can be used with this decorator.

Definition at line 33 of file ProjectionParameters.h.

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