EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
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:
maxshiftMaximum translation in pixels
snrsignal to noise ratio array

Definition at line 678 of file aligner.h.


Member Function Documentation

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_imgThe image to be compared.
to_img'this_img" is aligned with 'to_img'.
cmp_nameThe comparison method to compare the two images.
cmp_paramsThe parameter dictionary for comparison method.
Returns:
The aligned image.

Implements EMAN::Aligner.

Referenced by align().

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

Implements EMAN::Aligner.

Definition at line 684 of file aligner.h.

References align().

                {
                        return align(this_img, to_img, "frc", Dict());
                }
virtual string EMAN::RotateTranslateBestAligner::get_desc ( ) const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 694 of file aligner.h.

                {
                        return "Full 2D alignment using 'Rotational' and 'Translational', also incorporates 2D 'Refine' alignments.";
                }
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 689 of file aligner.h.

References NAME.

                {
                        return NAME;
                }
virtual TypeDict EMAN::RotateTranslateBestAligner::get_param_types ( ) const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 704 of file aligner.h.

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

                {
                        TypeDict d;
                        d.put("maxshift", EMObject::INT, "Maximum translation in pixels");
                        d.put("snr", EMObject::FLOATARRAY, "signal to noise ratio array");
                        return d;
                }
static Aligner* EMAN::RotateTranslateBestAligner::NEW ( ) [inline, static]

Definition at line 699 of file aligner.h.

                {
                        return new RotateTranslateBestAligner();
                }

Member Data Documentation

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

Definition at line 712 of file aligner.h.

Referenced by get_name().


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