EMAN2
Public Member Functions | Protected Attributes
EMAN::Aligner Class Reference

Aligner class defines image alignment method. More...

#include <aligner.h>

Inheritance diagram for EMAN::Aligner:
Inheritance graph
[legend]
Collaboration diagram for EMAN::Aligner:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~Aligner ()
virtual EMDataalign (EMData *this_img, EMData *to_img) const =0
virtual EMDataalign (EMData *this_img, EMData *to_img, const string &cmp_name, const Dict &cmp_params) const =0
 To align 'this_img' with another image passed in through its parameters.
virtual string get_name () const =0
 Get the Aligner's name.
virtual string get_desc () const =0
virtual Dict get_params () const
 Get the Aligner parameters in a key/value dictionary.
virtual void set_params (const Dict &new_params)
 Set the Aligner parameters using a key/value dictionary.
virtual TypeDict get_param_types () const =0
virtual vector< Dictxform_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.

Protected Attributes

Dict params

Detailed Description

Aligner class defines image alignment method.

It aligns 2 images based on a user-given comparison method. Aligner class is the base class for all aligners. Each specific Aligner class has a unique name. This name is used to create a new Aligner instance or call an Aligner.

All Aligner classes in EMAN are managed by a Factory pattern. So each Aligner class must define:

Typical usage of Aligners:

Definition at line 84 of file aligner.h.


Constructor & Destructor Documentation

virtual EMAN::Aligner::~Aligner ( ) [inline, virtual]

Definition at line 87 of file aligner.h.

                {
                }

Member Function Documentation

virtual EMData* EMAN::Aligner::align ( EMData this_img,
EMData to_img 
) const [pure virtual]
virtual EMData* EMAN::Aligner::align ( EMData this_img,
EMData to_img,
const string &  cmp_name,
const Dict cmp_params 
) const [pure virtual]
virtual string EMAN::Aligner::get_desc ( ) const [pure virtual]
virtual string EMAN::Aligner::get_name ( ) const [pure virtual]
virtual TypeDict EMAN::Aligner::get_param_types ( ) const [pure virtual]
virtual Dict EMAN::Aligner::get_params ( ) const [inline, virtual]

Get the Aligner parameters in a key/value dictionary.

Returns:
A key/value pair dictionary containing the parameters.

Definition at line 116 of file aligner.h.

References params.

                {
                        return params;
                }
virtual void EMAN::Aligner::set_params ( const Dict new_params) [inline, virtual]

Set the Aligner parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Definition at line 124 of file aligner.h.

References params.

                {
                        params = new_params;
                }
vector< Dict > Aligner::xform_align_nbest ( EMData this_img,
EMData to_img,
const unsigned int  nsoln,
const string &  cmp_name,
const Dict cmp_params 
) const [virtual]

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.

Return value is an ordered vector of Dicts of length nsoln. The data with idx 0 has the best solution in it. The Dicts in the vector have two keys, "score" (which is a floating point score, probably correlation score), and "xform.align3d", which is a Transform containing the alignment parameters

Parameters:
this_imgthe image that will be aligned (transformed) and compared to to_img as part of the process of finding the best alignment
to_imgthe image that will stay still as this_img is transformed and compared to it
nsolnthe number of solutions you want to receive in the return vector.
cmp_namethe name of a comparator - may be unused
cmp_paramsthe params of the comparator - may be unused
Returns:
an ordered vector of Dicts of length nsoln. The Dicts in the vector have keys "score" (i.e. correlation score) and "xform.align3d" (Transform containing the alignment)

Reimplemented in EMAN::RT3DGridAligner, EMAN::RT3DSphereAligner, and EMAN::RT3DSymmetryAligner.

Definition at line 125 of file aligner.cpp.

Referenced by EMAN::RT3DSymmetryAligner::align(), EMAN::RT3DSphereAligner::align(), EMAN::RT3DGridAligner::align(), and EMAN::EMData::xform_align_nbest().

{
        vector<Dict> solns;
        return solns;
}

Member Data Documentation

Dict EMAN::Aligner::params [mutable, protected]

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