EMAN::RotateTranslateAlignerIterative Class Reference

Iterative rotational, translational alignment. More...

#include <aligner.h>

Inheritance diagram for EMAN::RotateTranslateAlignerIterative:

Collaboration diagram for EMAN::RotateTranslateAlignerIterative:

Public Member Functions
virtual EMData *	align (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. More...
virtual EMData *	align (EMData *this_img, EMData *to_img) const
virtual string	get_name () const
	Get the Aligner's name. More...
virtual string	get_desc () const
virtual TypeDict	get_param_types () const
Public Member Functions inherited from EMAN::Aligner
virtual	~Aligner ()
virtual Dict	get_params () const
	Get the Aligner parameters in a key/value dictionary. More...
virtual void	set_params (const Dict &new_params)
	Set the Aligner parameters using a key/value dictionary. More...
virtual vector< Dict >	xform_align_nbest (EMData *this_img, EMData *to_img, const unsigned int nsoln, const string &cmp_name, const Dict &cmp_params) const
	This function first added in the context of the 3D aligners used by e2tomohunter: which wants the n best solutions, as opposed to just the best. More...

Static Public Member Functions
static Aligner *	NEW ()

Static Public Attributes
static const string	NAME = "rotate_translate_iterative"

Additional Inherited Members
Protected Attributes inherited from EMAN::Aligner
Dict	params

Detailed Description

Iterative rotational, translational alignment.

Basically, we find the best translation, and move to that pointer then we find the best rotation and rotate to that point. Next we iterate X times.

Parameters

maxshift	Maximum translation in pixels
r1	inner ring
r2	outer ring
maxiter	maximum number of alignment iterations
nozero	Zero translation not permitted (useful for CCD images)

Author

John Flanagan

Date

Oct 2010

Definition at line 611 of file aligner.h.

Member Function Documentation

align() [1/2]

virtual EMData * EMAN::RotateTranslateAlignerIterative::align ( EMData *  this_img, EMData *  to_img  ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 617 of file aligner.h.

                {
                        return align(this_img, to_img, "sqeuclidean", Dict());
                }

References align().

align() [2/2]

virtual EMData * EMAN::RotateTranslateAlignerIterative::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().

get_desc()

virtual string EMAN::RotateTranslateAlignerIterative::get_desc ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 627 of file aligner.h.

                {
                        return "Performs rotational alignment and follows this with translational alignment using the iterative method.";
                }

get_name()

virtual string EMAN::RotateTranslateAlignerIterative::get_name ( ) const

inlinevirtual

Get the Aligner's name.

Each Aligner is identified by a unique name.

Returns

The Aligner's name.

Implements EMAN::Aligner.

Definition at line 622 of file aligner.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

virtual TypeDict EMAN::RotateTranslateAlignerIterative::get_param_types ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 637 of file aligner.h.

                {
                        TypeDict d;
                        d.put("maxshift", EMObject::INT, "Maximum translation in pixels");
                        d.put("r1", EMObject::INT, "Inner ring, pixels");
                        d.put("r2", EMObject::INT, "Outer ring, pixels");
                        d.put("maxiter", EMObject::INT, "Maximum number of iterations");
                        d.put("nozero", EMObject::INT,"Zero translation not permitted (useful for CCD images)");
                        d.put("useflcf", EMObject::INT,"Use Fast Local Correlation Function rather than CCF for translational alignment");
                        return d;
                }

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

NEW()

static Aligner * EMAN::RotateTranslateAlignerIterative::NEW ( )

inlinestatic

Definition at line 632 of file aligner.h.

                {
                        return new RotateTranslateAlignerIterative();
                }

Member Data Documentation

NAME

const string RotateTranslateAlignerIterative::NAME = "rotate_translate_iterative"

static

Definition at line 649 of file aligner.h.

Referenced by get_name().

---

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

• aligner.h
• aligner.cpp