EMAN::ScaleAligner Class Reference

Scale aligner. More...

#include <aligner.h>

Inheritance diagram for EMAN::ScaleAligner:

Collaboration diagram for EMAN::ScaleAligner:

Public Member Functions
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. More...
virtual EMData *	align (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< 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 = "scale"

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

Detailed Description

Scale aligner.

To scale one image to another in real space

Parameters

min	Minimum scaling (default: 0.95)
max	aximum scaling (default: 1.05)
step	Scaling step (default: 0.01)

Author

John Flanagan

Date

March 2012

Definition at line 191 of file aligner.h.

Member Function Documentation

align() [1/2]

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 197 of file aligner.h.

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

References align().

align() [2/2]

virtual EMData * EMAN::ScaleAligner::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_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()

virtual string EMAN::ScaleAligner::get_desc ( ) const

inlinevirtual

Implements EMAN::Aligner.

Definition at line 207 of file aligner.h.

                {
                        return "Performs real space scale alignment";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

inlinevirtual

Implements EMAN::Aligner.

Definition at line 217 of file aligner.h.

                {
                        TypeDict d;
                        d.put("min", EMObject::FLOAT, "Minimum scaling (default: 0.95)");
                        d.put("max", EMObject::FLOAT, "Maximum scaling (default: 1.05)");
                        d.put("step", EMObject::FLOAT, "Scaling step (default: 0.01)");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 212 of file aligner.h.

                {
                        return new ScaleAligner();
                }

Member Data Documentation

NAME

const string ScaleAligner::NAME = "scale"

static

Definition at line 226 of file aligner.h.

Referenced by get_name().

---

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

• aligner.h
• aligner.cpp