EMAN::XGradientProcessor Class Reference

Determines the partial derivatives in the x direction Does this by constructing edge kernels in real space but convoluting in Fourier space. More...

#include <processor.h>

Inheritance diagram for EMAN::XGradientProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 XGradientProcessor ()
string get_name () const
 Get the processor's name.
void process_inplace (EMData *image)
 To process an image in-place.
string get_desc () const
 Get the descrition of this specific processor.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "math.edge.xgradient"

Detailed Description

Determines the partial derivatives in the x direction Does this by constructing edge kernels in real space but convoluting in Fourier space.

Author:
David Woolford
Date:
2007/12/04

Definition at line 554 of file processor.h.


Constructor & Destructor Documentation

EMAN::XGradientProcessor::XGradientProcessor (  )  [inline]

Definition at line 557 of file processor.h.

Referenced by NEW().

00557 {}


Member Function Documentation

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

Get the descrition of this specific processor.

This function must be overwritten by a subclass.

Returns:
The description of this processor.

Implements EMAN::Processor.

Definition at line 571 of file processor.h.

00572                 {
00573                         return "Determines the image gradient in the x direction";
00574                 }

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

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 559 of file processor.h.

References NAME.

00560                 {
00561                         return NAME;
00562                 }

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

Get processor 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.

Reimplemented from EMAN::Processor.

Definition at line 576 of file processor.h.

00577                 {
00578                         TypeDict d;
00579                         return d;
00580                 }

static Processor* EMAN::XGradientProcessor::NEW (  )  [inline, static]

Definition at line 566 of file processor.h.

References XGradientProcessor().

00567                 {
00568                         return new XGradientProcessor();
00569                 }

void XGradientProcessor::process_inplace ( EMData image  )  [virtual]

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters:
image The image to be processed.

Implements EMAN::Processor.

Definition at line 9387 of file processor.cpp.

References EMAN::EMData::clip_inplace(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), ImageDimensionException, ImageFormatException, EMAN::EMData::is_complex(), EMAN::EMData::process_inplace(), EMAN::EMData::set_size(), and EMAN::EMData::set_value_at().

09388 {
09389         if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
09390 
09391         EMData* e = new EMData();
09392         int nx = image->get_xsize();
09393         int ny = image->get_ysize();
09394         int nz = image->get_zsize();
09395 
09396         if ( nz == 1 && ny == 1 ) {
09397                 if ( nx < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09398 
09399                 e->set_size(3,1,1);
09400                 e->set_value_at(0,-1);
09401                 e->set_value_at(2, 1);
09402 
09403                 Region r = Region(-nx/2+1,nx);
09404                 e->clip_inplace(r);
09405         } else if ( nz == 1 ) {
09406                 if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09407                 e->set_size(3,3,1);
09408                 e->set_value_at(0,0,-1);
09409                 e->set_value_at(0,1,-2);
09410                 e->set_value_at(0,2,-1);
09411 
09412                 e->set_value_at(2,0,1);
09413                 e->set_value_at(2,1,2);
09414                 e->set_value_at(2,2,1);
09415                 Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
09416                 e->clip_inplace(r);
09417         } else {
09418                 if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09419                 e->set_size(3,3,3);
09420                 e->set_value_at(0,0,0,-1);
09421                 e->set_value_at(0,1,0,-1);
09422                 e->set_value_at(0,2,0,-1);
09423                 e->set_value_at(0,0,1,-1);
09424                 e->set_value_at(0,1,1,-8);
09425                 e->set_value_at(0,2,1,-1);
09426                 e->set_value_at(0,0,2,-1);
09427                 e->set_value_at(0,1,2,-1);
09428                 e->set_value_at(0,2,2,-1);
09429 
09430                 e->set_value_at(2,0,0,1);
09431                 e->set_value_at(2,1,0,1);
09432                 e->set_value_at(2,2,0,1);
09433                 e->set_value_at(2,0,1,1);
09434                 e->set_value_at(2,1,1,8);
09435                 e->set_value_at(2,2,1,1);
09436                 e->set_value_at(2,0,2,1);
09437                 e->set_value_at(2,1,2,1);
09438                 e->set_value_at(2,2,2,1);
09439 
09440                 Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
09441                 e->clip_inplace(r);
09442         }
09443 
09444         Dict conv_parms;
09445         conv_parms["with"] = e;
09446         image->process_inplace("math.convolution", conv_parms);
09447         image->process_inplace("xform.phaseorigin.tocenter");
09448 
09449         delete e;
09450 }


Member Data Documentation

const string XGradientProcessor::NAME = "math.edge.xgradient" [static]

Definition at line 582 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:09:35 2012 for EMAN2 by  doxygen 1.4.7