EMAN::TranslationalAligner Class Reference

Translational 2D Alignment using cross correlation. More...

#include <aligner.h>

Inheritance diagram for EMAN::TranslationalAligner:

Collaboration diagram for EMAN::TranslationalAligner:

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 = "translational"

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

Detailed Description

Translational 2D Alignment using cross correlation.

It calculates the shift for a translational alignment, then do the translation.

Parameters

intonly	Integer pixel translations only
maxshift	Maximum translation in pixels
nozero	Zero translation not permitted (useful for CCD images)

Definition at line 237 of file aligner.h.

Member Function Documentation

align() [1/2]

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 243 of file aligner.h.

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

References align().

align() [2/2]

virtual EMData * EMAN::TranslationalAligner::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::TranslationalAligner::get_desc ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 253 of file aligner.h.

                {
                        return "Translational 2D and 3D alignment by cross-correlation";
                }

get_name()

virtual string EMAN::TranslationalAligner::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 248 of file aligner.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 263 of file aligner.h.

                {
                        TypeDict d;
                        d.put("intonly", EMObject::INT,"Integer pixel translations only");
                        d.put("useflcf", EMObject::INT,"Use Fast Local Correlation Function rather than CCF");
                        d.put("maxshift", EMObject::INT,"Maximum translation in pixels");
                        d.put("masked", EMObject::INT,"Treat zero pixels in 'this' as a mask for normalization (default false)");
                        d.put("nozero", EMObject::INT,"Zero translation not permitted (useful for CCD images)");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 258 of file aligner.h.

                {
                        return new TranslationalAligner();
                }

Member Data Documentation

NAME

const string TranslationalAligner::NAME = "translational"

static

Definition at line 274 of file aligner.h.

Referenced by get_name().

---

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

• aligner.h
• aligner.cpp