EMAN::RotateTranslateBestAligner Class Reference

rotational, translational alignment More...

#include <aligner.h>

Inheritance diagram for EMAN::RotateTranslateBestAligner:

[legend]

Collaboration diagram for EMAN::RotateTranslateBestAligner:

[legend]

List of all members.

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.
virtual EMData *	align (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 Aligner *	NEW ()

---

Detailed Description

rotational, translational alignment

Parameters:

	maxshift	Maximum translation in pixels
	snr	signal to noise ratio array

Definition at line 332 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_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 EMData* EMAN::RotateTranslateBestAligner::align	(	EMData *	this_img,
		EMData *	to_img
	)			const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 338 of file aligner.h.

References align().

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

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 343 of file aligner.h.

                {
                        return "rotate_translate_best";
                }

virtual string EMAN::RotateTranslateBestAligner::get_desc

(

)

const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 348 of file aligner.h.

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

static Aligner* EMAN::RotateTranslateBestAligner::NEW

(

)

[inline, static]

Definition at line 353 of file aligner.h.

                {
                        return new RotateTranslateBestAligner();
                }

virtual TypeDict EMAN::RotateTranslateBestAligner::get_param_types

(

)

const [inline, virtual]

Implements EMAN::Aligner.

Definition at line 358 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;
                }

---

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

• aligner.h