EMAN::QuadMinDotCmp Class Reference

This will calculate the dot product for each quadrant of the image and return the worst value. More...

#include <cmp.h>

Inheritance diagram for EMAN::QuadMinDotCmp:

Collaboration diagram for EMAN::QuadMinDotCmp:

Public Member Functions
float	cmp (EMData *image, EMData *with) const
	To compare 'image' with another image passed in through its parameters. More...
string	get_name () const
	Get the Cmp's name. More...
string	get_desc () const
TypeDict	get_param_types () const
	Get Cmp parameter information in a dictionary. More...
Public Member Functions inherited from EMAN::Cmp
virtual	~Cmp ()
virtual Dict	get_params () const
	Get the Cmp parameters in a key/value dictionary. More...
virtual void	set_params (const Dict &new_params)
	Set the Cmp parameters using a key/value dictionary. More...

Static Public Member Functions
static Cmp *	NEW ()

Static Public Attributes
static const string	NAME = "quadmindot"

Additional Inherited Members
Protected Member Functions inherited from EMAN::Cmp
void	validate_input_args (const EMData *image, const EMData *with) const
Protected Attributes inherited from EMAN::Cmp
Dict	params

Detailed Description

This will calculate the dot product for each quadrant of the image and return the worst value.

Author

Steve Ludtke (sludt.nosp@m.ke@b.nosp@m.cm.tm.nosp@m.c.ed.nosp@m.u)

Date

2005-07-13

Parameters

negative	Returns -1 * dot product, default true
normalize	Returns normalized dot product -1.0 - 1.0

Definition at line 488 of file cmp.h.

Member Function Documentation

cmp()

float QuadMinDotCmp::cmp ( EMData *  image, EMData *  with  ) const

virtual

To compare 'image' with another image passed in through its parameters.

An optional transformation may be used to transform the 2 images.

Parameters

image	The first image to be compared.
with	The second image to be comppared.

Returns

The comparison result. Smaller better by default

Implements EMAN::Cmp.

Definition at line 988 of file cmp.cpp.

{
        ENTERFUNC;
        validate_input_args(image, with);
 
        if (image->get_zsize()!=1) throw InvalidValueException(0, "QuadMinDotCmp supports 2D only");
 
        int nx=image->get_xsize();
        int ny=image->get_ysize();
 
        int normalize = params.set_default("normalize", 0);
        float negative = (float)params.set_default("negative", 1);
 
        if (negative) negative=-1.0; else negative=1.0;
 
        double result[4] = { 0,0,0,0 }, sq1[4] = { 0,0,0,0 }, sq2[4] = { 0,0,0,0 } ;
 
        vector<int> image_saved_offsets = image->get_array_offsets();
        vector<int> with_saved_offsets = with->get_array_offsets();
        image->set_array_offsets(-nx/2,-ny/2);
        with->set_array_offsets(-nx/2,-ny/2);
        int i,x,y;
        for (y=-ny/2; y<ny/2; y++) {
                for (x=-nx/2; x<nx/2; x++) {
                        int quad=(x<0?0:1) + (y<0?0:2);
                        result[quad]+=(*image)(x,y)*(*with)(x,y);
                        if (normalize) {
                                sq1[quad]+=(*image)(x,y)*(*image)(x,y);
                                sq2[quad]+=(*with)(x,y)*(*with)(x,y);
                        }
                }
        }
        image->set_array_offsets(image_saved_offsets);
        with->set_array_offsets(with_saved_offsets);
 
        if (normalize) {
                for (i=0; i<4; i++) result[i]/=sqrt(sq1[i]*sq2[i]);
        } else {
                for (i=0; i<4; i++) result[i]/=nx*ny/4;
        }
 
        float worst=static_cast<float>(result[0]);
        for (i=1; i<4; i++) if (static_cast<float>(result[i])<worst) worst=static_cast<float>(result[i]);
 
        EXITFUNC;
        return (float) (negative*worst);
}

References ENTERFUNC, EXITFUNC, InvalidValueException, EMAN::Cmp::params, EMAN::Dict::set_default(), sqrt(), EMAN::Cmp::validate_input_args(), x, and y.

get_desc()

string EMAN::QuadMinDotCmp::get_desc ( ) const

inlinevirtual

Implements EMAN::Cmp.

Definition at line 498 of file cmp.h.

                {
                        return "Calculates dot product for each quadrant and returns worst value (default -1 * dot product)";
                }

get_name()

string EMAN::QuadMinDotCmp::get_name ( ) const

inlinevirtual

Get the Cmp's name.

Each Cmp is identified by a unique name.

Returns

The Cmp's name.

Implements EMAN::Cmp.

Definition at line 493 of file cmp.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

TypeDict EMAN::QuadMinDotCmp::get_param_types ( ) const

inlinevirtual

Get Cmp parameter information in a dictionary.

Each parameter has one record in the dictionary. Each record contains its name, data-type, and description.

Returns

A dictionary containing the parameter info.

Implements EMAN::Cmp.

Definition at line 508 of file cmp.h.

                {
                        TypeDict d;
                        d.put("negative", EMObject::INT, "If set, returns -1 * dot product. Default = true (smaller is better)");
                        d.put("normalize", EMObject::INT, "If set, returns normalized dot product -1.0 - 1.0.");
                        return d;
                }

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

NEW()

static Cmp * EMAN::QuadMinDotCmp::NEW ( )

inlinestatic

Definition at line 503 of file cmp.h.

                {
                        return new QuadMinDotCmp();
                }

Member Data Documentation

NAME

const string QuadMinDotCmp::NAME = "quadmindot"

static

Definition at line 516 of file cmp.h.

Referenced by get_name().

---

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

• cmp.h
• cmp.cpp