EMAN::RotateTranslateBestAligner Class Reference

rotational, translational alignment More...

#include <aligner.h>

Inheritance diagram for EMAN::RotateTranslateBestAligner:

Inheritance graph
[legend]
Collaboration diagram for EMAN::RotateTranslateBestAligner:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual EMDataalign (EMData *this_img, EMData *to_img, const string &cmp_name="dot", const Dict &cmp_params=Dict()) const
 To align 'this_img' with another image passed in through its parameters.
virtual EMDataalign (EMData *this_img, EMData *to_img) const
virtual string get_name () const
 Get the Aligner's name.
virtual string get_desc () const
virtual TypeDict get_param_types () const

Static Public Member Functions

static AlignerNEW ()

Static Public Attributes

static const string NAME = "rotate_translate_best"

Detailed Description

rotational, translational alignment

Parameters:
maxshift Maximum translation in pixels
snr signal to noise ratio array

Definition at line 488 of file aligner.h.


Member Function Documentation

virtual EMData* EMAN::RotateTranslateBestAligner::align ( EMData this_img,
EMData to_img 
) const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 494 of file aligner.h.

References align().

00495                 {
00496                         return align(this_img, to_img, "frc", Dict());
00497                 }

virtual EMData* EMAN::RotateTranslateBestAligner::align ( EMData this_img,
EMData to_img,
const string &  cmp_name = "dot",
const Dict cmp_params = Dict() 
) const [virtual]

To align 'this_img' with another image passed in through its parameters.

The alignment uses a user-given comparison method to compare the two images. If none is given, a default one is used.

Parameters:
this_img The image to be compared.
to_img 'this_img" is aligned with 'to_img'.
cmp_name The comparison method to compare the two images.
cmp_params The parameter dictionary for comparison method.
Returns:
The aligned image.

Implements EMAN::Aligner.

Referenced by align().

virtual string EMAN::RotateTranslateBestAligner::get_desc (  )  const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 504 of file aligner.h.

00505                 {
00506                         return "Full 2D alignment using 'Rotational' and 'Translational', also incorporates 2D 'Refine' alignments.";
00507                 }

virtual string EMAN::RotateTranslateBestAligner::get_name (  )  const [inline, virtual]

Get the Aligner's name.

Each Aligner is identified by a unique name.

Returns:
The Aligner's name.

Implements EMAN::Aligner.

Definition at line 499 of file aligner.h.

References NAME.

00500                 {
00501                         return NAME;
00502                 }

virtual TypeDict EMAN::RotateTranslateBestAligner::get_param_types (  )  const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 514 of file aligner.h.

References EMAN::EMObject::FLOATARRAY, EMAN::EMObject::INT, and EMAN::TypeDict::put().

00515                 {
00516                         TypeDict d;
00517                         d.put("maxshift", EMObject::INT, "Maximum translation in pixels");
00518                         d.put("snr", EMObject::FLOATARRAY, "signal to noise ratio array");
00519                         return d;
00520                 }

static Aligner* EMAN::RotateTranslateBestAligner::NEW (  )  [inline, static]

Definition at line 509 of file aligner.h.

00510                 {
00511                         return new RotateTranslateBestAligner();
00512                 }


Member Data Documentation

const string RotateTranslateBestAligner::NAME = "rotate_translate_best" [static]

Definition at line 522 of file aligner.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:47:53 2011 for EMAN2 by  doxygen 1.4.7