EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
EMAN::RotateTranslateBestAligner Class Reference

rotational, translational alignment More...

#include <aligner.h>

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

Public Member Functions

virtual EMDataalign (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 EMDataalign (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< 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. More...
 

Static Public Member Functions

static AlignerNEW ()
 

Static Public Attributes

static const string NAME = "rotate_translate_best"
 

Additional Inherited Members

- Protected Attributes inherited from EMAN::Aligner
Dict params
 

Detailed Description

rotational, translational alignment

Parameters
maxshiftMaximum translation in pixels
snrsignal to noise ratio array

Definition at line 767 of file aligner.h.

Member Function Documentation

◆ align() [1/2]

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

Implements EMAN::Aligner.

Definition at line 773 of file aligner.h.

774 {
775 return align(this_img, to_img, "frc", Dict());
776 }
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.

References align().

◆ align() [2/2]

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_imgThe image to be compared.
to_img'this_img" is aligned with 'to_img'.
cmp_nameThe comparison method to compare the two images.
cmp_paramsThe parameter dictionary for comparison method.
Returns
The aligned image.

Implements EMAN::Aligner.

Referenced by align().

◆ get_desc()

virtual string EMAN::RotateTranslateBestAligner::get_desc ( ) const
inlinevirtual

Implements EMAN::Aligner.

Definition at line 783 of file aligner.h.

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

◆ get_name()

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

779 {
780 return NAME;
781 }
static const string NAME
Definition: aligner.h:801

References NAME.

◆ get_param_types()

virtual TypeDict EMAN::RotateTranslateBestAligner::get_param_types ( ) const
inlinevirtual

Implements EMAN::Aligner.

Definition at line 793 of file aligner.h.

794 {
795 TypeDict d;
796 d.put("maxshift", EMObject::INT, "Maximum translation in pixels");
797 d.put("snr", EMObject::FLOATARRAY, "signal to noise ratio array");
798 return d;
799 }

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

◆ NEW()

static Aligner * EMAN::RotateTranslateBestAligner::NEW ( )
inlinestatic

Definition at line 788 of file aligner.h.

789 {
790 return new RotateTranslateBestAligner();
791 }

Member Data Documentation

◆ NAME

const string RotateTranslateBestAligner::NAME = "rotate_translate_best"
static

Definition at line 801 of file aligner.h.

Referenced by get_name().


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