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

rotational alignment using the iterative method (in this case we only do one iteration b/c we are not doing a translation. More...

#include <aligner.h>

Inheritance diagram for EMAN::RotationalAlignerIterative:
Inheritance graph
[legend]
Collaboration diagram for EMAN::RotationalAlignerIterative:
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 = "rotational_iterative"
 

Additional Inherited Members

- Protected Attributes inherited from EMAN::Aligner
Dict params
 

Detailed Description

rotational alignment using the iterative method (in this case we only do one iteration b/c we are not doing a translation.

The advantage of this over the 'regular' rotational alinger is that this is done in real space and does not use invariants.

Parameters
r1inner ring
r2outer ring
Author
John Flanagan
Date
Oct 2010

Definition at line 371 of file aligner.h.

Member Function Documentation

◆ align() [1/2]

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

Implements EMAN::Aligner.

Definition at line 377 of file aligner.h.

378 {
379 return align(this_img, to_img, "dot", Dict());
380 }
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::RotationalAlignerIterative::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::RotationalAlignerIterative::get_desc ( ) const
inlinevirtual

Implements EMAN::Aligner.

Definition at line 387 of file aligner.h.

388 {
389 return "Performs rotational alignment using the SPIDER method of iterating between rotational and translational alingment in real-space";
390 }

◆ get_name()

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

383 {
384 return NAME;
385 }
static const string NAME
Definition: aligner.h:405

References NAME.

◆ get_param_types()

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

Implements EMAN::Aligner.

Definition at line 397 of file aligner.h.

398 {
399 TypeDict d;
400 d.put("r1", EMObject::INT, "Inner ring, pixels");
401 d.put("r2", EMObject::INT, "Outer ring, pixels");
402 return d;
403 }

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

◆ NEW()

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

Definition at line 392 of file aligner.h.

393 {
394 return new RotationalAlignerIterative();
395 }

Member Data Documentation

◆ NAME

const string RotationalAlignerIterative::NAME = "rotational_iterative"
static

Definition at line 405 of file aligner.h.

Referenced by get_name().


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