IMP  2.1.1
The Integrative Modeling Platform
IMP::em2d::RegistrationResult Class Reference

Class to manage registration results. More...

#include <IMP/em2d/RegistrationResult.h>

Public Member Functions

 RegistrationResult (double phi, double theta, double psi, algebra::Vector2D shift, int projection_index=0, int image_index=0, String name="")
 
 RegistrationResult (algebra::Rotation3D R, algebra::Vector2D shift=algebra::Vector2D(0., 0.), int projection_index=0, int image_index=0, String name="")
 
void add_in_plane_transformation (algebra::Transformation2D t)
 
double get_ccc () const
 
int get_image_index () const
 Image that has been registered.
 
bool get_is_optimized_result () const
 
String get_name () const
 Name of the object.
 
double get_phi () const
 
int get_projection_index () const
 Projection that best matches the image after coarse registration.
 
double get_psi () const
 
algebra::Rotation3D get_rotation () const
 Returns the rotation for the 3 projection angles.
 
double get_score () const
 
algebra::Vector2D get_shift () const
 
algebra::Vector3D get_shift_3d () const
 
double get_theta () const
 
void read (const String &s)
 read
 
void read_from_image (const em::ImageHeader &header)
 Reads the registration parameters from an image.
 
void set_ccc (double ccc)
 
void set_image_index (int index)
 Index of the image that is registered.
 
void set_in_image (em::ImageHeader &header) const
 Sets the registration results to the header of an image.
 
void set_name (String name)
 
void set_projection_index (int index)
 
void set_random_registration (unsigned int index, double maximum_shift)
 Gets a random result.
 
void set_rotation (double phi, double theta, double psi)
 Rotation to apply to the model.
 
void set_rotation (algebra::Rotation3D R)
 Rotation to apply to the model.
 
void set_score (double Score)
 
void set_shift (algebra::Vector2D shift)
 Shift to apply to the projection to register.
 
void show (std::ostream &out=std::cout) const
 
void write (std::ostream &out=std::cout) const
 Writes a parseable result.
 
void write_comment_line (std::ostream &out=std::cout) const
 Writes an info line to with the contents of a result line.
 

Protected Attributes

bool angles_defined_
 
double ccc_
 Cross correlation coefficient.
 
int image_index_
 index of the image being registered
 
bool is_optimized_result_
 
String name_
 name and index of the projection compared
 
double phi_
 Euler angles (ZYZ)
 
int projection_index_
 
double psi_
 
algebra::Rotation3D R_
 
double Score_
 Score.
 
algebra::Vector2D shift_
 Translation in pixels and the rows first (y rows, x columns)
 
double theta_
 

Detailed Description

Note
Stores the rotation and in-plane translation needed to register a model with an EM image. The values can come from a coarse registration, or from a fine registration (optimized with simplex). I the second case, the function get_is_optimized_result() will return true Contains:
  • Rotation in 3D of the model to register its projection with an image
  • The rotation is understood as ZYZ
  • shift shift to apply to the projection of the model (after rotation) to align it with the given image

Definition at line 35 of file RegistrationResult.h.

Member Function Documentation

void IMP::em2d::RegistrationResult::add_in_plane_transformation ( algebra::Transformation2D  t)

adds an in-plane transformation to the result stored The translation is understood as a shift (in pixels)

double IMP::em2d::RegistrationResult::get_ccc ( ) const

Cross correlation coefficient between the image and the projection of the model after registration

Definition at line 79 of file RegistrationResult.h.

double IMP::em2d::RegistrationResult::get_score ( ) const

Returns the score computed by the ScoreFunction comparing an image and a projection

Definition at line 88 of file RegistrationResult.h.


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