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:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

float cmp (EMData *image, EMData *with) const
 To compare 'image' with another image passed in through its parameters.
string get_name () const
 Get the Cmp's name.
string get_desc () const
TypeDict get_param_types () const
 Get Cmp parameter information in a dictionary.

Static Public Member Functions

static CmpNEW ()

Static Public Attributes

static const string NAME = "quadmindot"

Detailed Description

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

Author:
Steve Ludtke (sludtke@bcm.tmc.edu)
Date:
2005-07-13
Parameters:
negative Returns -1 * dot product, default true
normalize Returns normalized dot product -1.0 - 1.0

Definition at line 314 of file cmp.h.


Member Function Documentation

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 518 of file cmp.cpp.

References ENTERFUNC, EXITFUNC, EMAN::EMData::get_array_offsets(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), InvalidValueException, nx, ny, EMAN::Cmp::params, EMAN::EMData::set_array_offsets(), EMAN::Dict::set_default(), sqrt(), EMAN::Cmp::validate_input_args(), x, and y.

00519 {
00520         ENTERFUNC;
00521         validate_input_args(image, with);
00522 
00523         if (image->get_zsize()!=1) throw InvalidValueException(0, "QuadMinDotCmp supports 2D only");
00524 
00525         int nx=image->get_xsize();
00526         int ny=image->get_ysize();
00527 
00528         int normalize = params.set_default("normalize", 0);
00529         float negative = (float)params.set_default("negative", 1);
00530 
00531         if (negative) negative=-1.0; else negative=1.0;
00532 
00533         double result[4] = { 0,0,0,0 }, sq1[4] = { 0,0,0,0 }, sq2[4] = { 0,0,0,0 } ;
00534 
00535         vector<int> image_saved_offsets = image->get_array_offsets();
00536         vector<int> with_saved_offsets = with->get_array_offsets();
00537         image->set_array_offsets(-nx/2,-ny/2);
00538         with->set_array_offsets(-nx/2,-ny/2);
00539         int i,x,y;
00540         for (y=-ny/2; y<ny/2; y++) {
00541                 for (x=-nx/2; x<nx/2; x++) {
00542                         int quad=(x<0?0:1) + (y<0?0:2);
00543                         result[quad]+=(*image)(x,y)*(*with)(x,y);
00544                         if (normalize) {
00545                                 sq1[quad]+=(*image)(x,y)*(*image)(x,y);
00546                                 sq2[quad]+=(*with)(x,y)*(*with)(x,y);
00547                         }
00548                 }
00549         }
00550         image->set_array_offsets(image_saved_offsets);
00551         with->set_array_offsets(with_saved_offsets);
00552 
00553         if (normalize) {
00554                 for (i=0; i<4; i++) result[i]/=sqrt(sq1[i]*sq2[i]);
00555         } else {
00556                 for (i=0; i<4; i++) result[i]/=nx*ny/4;
00557         }
00558 
00559         float worst=static_cast<float>(result[0]);
00560         for (i=1; i<4; i++) if (static_cast<float>(result[i])<worst) worst=static_cast<float>(result[i]);
00561 
00562         EXITFUNC;
00563         return (float) (negative*worst);
00564 }

string EMAN::QuadMinDotCmp::get_desc (  )  const [inline, virtual]

Implements EMAN::Cmp.

Definition at line 324 of file cmp.h.

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

string EMAN::QuadMinDotCmp::get_name (  )  const [inline, virtual]

Get the Cmp's name.

Each Cmp is identified by a unique name.

Returns:
The Cmp's name.

Implements EMAN::Cmp.

Definition at line 319 of file cmp.h.

References NAME.

00320                 {
00321                         return NAME;
00322                 }

TypeDict EMAN::QuadMinDotCmp::get_param_types (  )  const [inline, virtual]

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 334 of file cmp.h.

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

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

static Cmp* EMAN::QuadMinDotCmp::NEW (  )  [inline, static]

Definition at line 329 of file cmp.h.

00330                 {
00331                         return new QuadMinDotCmp();
00332                 }


Member Data Documentation

const string QuadMinDotCmp::NAME = "quadmindot" [static]

Definition at line 342 of file cmp.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:42:27 2010 for EMAN2 by  doxygen 1.4.7