Aligns a particle with a specified symetry to its symmetry axis using the simplex multidimensional minimization algorithm. More...

#include <aligner.h>

Inheritance diagram for EMAN::SymAlignProcessorQuat:

[legend]

Collaboration diagram for EMAN::SymAlignProcessorQuat:

[legend]

Public Member Functions
virtual EMData *	align (EMData this_img, EMData to_img, const string &cmp_name="ccc", 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

virtual 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 = "symalignquat"

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

Detailed Description

Aligns a particle with a specified symetry to its symmetry axis using the simplex multidimensional minimization algorithm.

Author: John Flanagan

Date: October 2011

Parameters

sym	The symmetry of the particle in question
xform.align3d	The initial guess to align the paricle to its symmetry axis

Definition at line 1420 of file aligner.h.

Member Function Documentation

◆ align() [1/2]

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 1426 of file aligner.h.

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

References align().

◆ align() [2/2]

virtual EMData * EMAN::SymAlignProcessorQuat::align	(	EMData *	this_img,
		EMData *	to_img,
		const string &	cmp_name = `"ccc"`,
		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::SymAlignProcessorQuat::get_desc ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 1439 of file aligner.h.

                {
                        return "Finds the symmetry axis using the simplex algorithm.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 1443 of file aligner.h.

                {
                        TypeDict d;
                        d.put("sym", EMObject::STRING, "The symmettry. Default is c1");
                        d.put("xform.align3d", EMObject::TRANSFORM, "The initial guess for to align the particel to sym axis");
                        d.put("stepx", EMObject::FLOAT, "The initial simplex step size in x. Default is 1");
                        d.put("stepy", EMObject::FLOAT, "The initial simplex step size in y. Default is 1");
                        d.put("stepz", EMObject::FLOAT, "The initial simplex step size in z. Default is 1." );
                        d.put("stepn0", EMObject::FLOAT, "The initial simplex step size in the first quaternion vecotr component. Default is 1." );
                        d.put("stepn1", EMObject::FLOAT, "The initial simplex step size in the second quaternion vecotr component. Default is 1." );
                        d.put("stepn2", EMObject::FLOAT, "The initial simplex step size in the third quaternion vecotr component. Default is 1." );
                        d.put("spin_coeff", EMObject::FLOAT,"The multiplier appied to the spin (if it is too small or too large the simplex will not converge).  Default is 10.");
                        d.put("precision", EMObject::FLOAT, "The precision which, if achieved, can stop the iterative refinement before reaching the maximum iterations. Default is 0.01." );
                        d.put("maxiter", EMObject::INT, "The maximum number of iterations that can be performed by the Simplex minimizer. Default is 100.");
                        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.");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 1435 of file aligner.h.

                {
                        return new SymAlignProcessorQuat();
                }

Member Data Documentation

◆ NAME

const string SymAlignProcessorQuat::NAME = "symalignquat"

static

Definition at line 1460 of file aligner.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ align() [1/2]

◆ align() [2/2]

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

Member Data Documentation

◆ NAME