EMAN::FRM2DAligner Class Reference

#include <aligner.h>

Inheritance diagram for EMAN::FRM2DAligner:

Collaboration diagram for EMAN::FRM2DAligner:

Public Member Functions
virtual EMData *	align (EMData *this_img, EMData *to_img, const string &cmp_name, 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
string	get_name () const
	Get the Aligner's name. More...
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 = "frm2d"

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

Detailed Description

Definition at line 2076 of file aligner.h.

Member Function Documentation

align() [1/2]

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 2082 of file aligner.h.

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

References align().

align() [2/2]

virtual EMData * EMAN::FRM2DAligner::align ( EMData *  this_img, EMData *  to_img, const string &  cmp_name, 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()

string EMAN::FRM2DAligner::get_desc ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 2092 of file aligner.h.

                                        {
                                                return "FRM2D uses two rotational parameters and one translational parameter";
                                        }

get_name()

string EMAN::FRM2DAligner::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 2087 of file aligner.h.

                                        {
                                                return NAME;
                                        }

References NAME.

get_param_types()

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 2101 of file aligner.h.

                                        {
                                                        TypeDict d;
                                                        d.put("maxshift", EMObject::INT,"Maximum translation in pixels in any direction. If the solution yields a shift beyond this value in any direction, then the refinement is judged a failure and the original alignment is used as the solution.");
 
                                                        //d.put("p_max", EMObject::FLOAT,"p_max is");
                                                        return d;
                                        }

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

NEW()

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

inlinestatic

Definition at line 2097 of file aligner.h.

                                        {
                                                return new FRM2DAligner();
                                        }

Member Data Documentation

NAME

const string FRM2DAligner::NAME = "frm2d"

static

Definition at line 2110 of file aligner.h.

Referenced by get_name().

---

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

• aligner.h
• aligner.cpp