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 529 of file processor.h.


Constructor & Destructor Documentation

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

Definition at line 532 of file processor.h.

Referenced by NEW().

00532 {}


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 546 of file processor.h.

00547                 {
00548                         return "Determines the image gradient in the x direction";
00549                 }

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 534 of file processor.h.

References NAME.

00535                 {
00536                         return NAME;
00537                 }

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 551 of file processor.h.

00552                 {
00553                         TypeDict d;
00554                         return d;
00555                 }

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

Definition at line 541 of file processor.h.

References XGradientProcessor().

00542                 {
00543                         return new XGradientProcessor();
00544                 }

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 9200 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().

09201 {
09202         if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
09203 
09204         EMData* e = new EMData();
09205         int nx = image->get_xsize();
09206         int ny = image->get_ysize();
09207         int nz = image->get_zsize();
09208 
09209         if ( nz == 1 && ny == 1 ) {
09210                 if ( nx < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09211 
09212                 e->set_size(3,1,1);
09213                 e->set_value_at(0,-1);
09214                 e->set_value_at(2, 1);
09215 
09216                 Region r = Region(-nx/2+1,nx);
09217                 e->clip_inplace(r);
09218         } else if ( nz == 1 ) {
09219                 if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09220                 e->set_size(3,3,1);
09221                 e->set_value_at(0,0,-1);
09222                 e->set_value_at(0,1,-2);
09223                 e->set_value_at(0,2,-1);
09224 
09225                 e->set_value_at(2,0,1);
09226                 e->set_value_at(2,1,2);
09227                 e->set_value_at(2,2,1);
09228                 Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
09229                 e->clip_inplace(r);
09230         } else {
09231                 if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09232                 e->set_size(3,3,3);
09233                 e->set_value_at(0,0,0,-1);
09234                 e->set_value_at(0,1,0,-1);
09235                 e->set_value_at(0,2,0,-1);
09236                 e->set_value_at(0,0,1,-1);
09237                 e->set_value_at(0,1,1,-8);
09238                 e->set_value_at(0,2,1,-1);
09239                 e->set_value_at(0,0,2,-1);
09240                 e->set_value_at(0,1,2,-1);
09241                 e->set_value_at(0,2,2,-1);
09242 
09243                 e->set_value_at(2,0,0,1);
09244                 e->set_value_at(2,1,0,1);
09245                 e->set_value_at(2,2,0,1);
09246                 e->set_value_at(2,0,1,1);
09247                 e->set_value_at(2,1,1,8);
09248                 e->set_value_at(2,2,1,1);
09249                 e->set_value_at(2,0,2,1);
09250                 e->set_value_at(2,1,2,1);
09251                 e->set_value_at(2,2,2,1);
09252 
09253                 Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
09254                 e->clip_inplace(r);
09255         }
09256 
09257         Dict conv_parms;
09258         conv_parms["with"] = e;
09259         image->process_inplace("math.convolution", conv_parms);
09260         image->process_inplace("xform.phaseorigin.tocenter");
09261 
09262         delete e;
09263 }


Member Data Documentation

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

Definition at line 557 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:09:27 2011 for EMAN2 by  doxygen 1.4.7