EMAN::YGradientProcessor Class Reference

#include <processor.h>

Inheritance diagram for EMAN::YGradientProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 YGradientProcessor ()
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.ygradient"

Detailed Description

Definition at line 560 of file processor.h.


Constructor & Destructor Documentation

EMAN::YGradientProcessor::YGradientProcessor (  )  [inline]

Definition at line 563 of file processor.h.

Referenced by NEW().

00563 {}


Member Function Documentation

string EMAN::YGradientProcessor::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 577 of file processor.h.

00578                         {
00579                                 return "Determines the image gradient in the y direction";
00580                         }

string EMAN::YGradientProcessor::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 565 of file processor.h.

References NAME.

00566                         {
00567                                 return NAME;
00568                         }

TypeDict EMAN::YGradientProcessor::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 583 of file processor.h.

00584                         {
00585                                 TypeDict d;
00586                                 return d;
00587                         }

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

Definition at line 572 of file processor.h.

References YGradientProcessor().

00573                         {
00574                                 return new YGradientProcessor();
00575                         }

void YGradientProcessor::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 9436 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().

09437 {
09438         if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
09439 
09440         EMData* e = new EMData();
09441         int nx = image->get_xsize();
09442         int ny = image->get_ysize();
09443         int nz = image->get_zsize();
09444 
09445         if ( nz == 1 && ny == 1 ) {
09446                 throw ImageDimensionException("Error - cannot detect Y edges for an image that that is 1D!");
09447         } else if ( nz == 1 ) {
09448                 if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09449                 e->set_size(3,3,1);
09450                 e->set_value_at(0,0,-1);
09451                 e->set_value_at(1,0,-2);
09452                 e->set_value_at(2,0,-1);
09453 
09454                 e->set_value_at(0,2,1);
09455                 e->set_value_at(1,2,2);
09456                 e->set_value_at(2,2,1);
09457                 Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
09458                 e->clip_inplace(r);
09459         } else {
09460                 if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09461                 e->set_size(3,3,3);
09462                 e->set_value_at(0,0,0,-1);
09463                 e->set_value_at(1,0,0,-1);
09464                 e->set_value_at(2,0,0,-1);
09465                 e->set_value_at(0,0,1,-1);
09466                 e->set_value_at(1,0,1,-8);
09467                 e->set_value_at(2,0,1,-1);
09468                 e->set_value_at(0,0,2,-1);
09469                 e->set_value_at(1,0,2,-1);
09470                 e->set_value_at(2,0,2,-1);
09471 
09472                 e->set_value_at(0,2,0,1);
09473                 e->set_value_at(1,2,0,1);
09474                 e->set_value_at(2,2,0,1);
09475                 e->set_value_at(0,2,1,1);
09476                 e->set_value_at(1,2,1,8);
09477                 e->set_value_at(2,2,1,1);
09478                 e->set_value_at(0,2,2,1);
09479                 e->set_value_at(1,2,2,1);
09480                 e->set_value_at(2,2,2,1);
09481 
09482                 Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
09483                 e->clip_inplace(r);
09484         }
09485 
09486         Dict conv_parms;
09487         conv_parms["with"] = e;
09488         image->process_inplace("math.convolution", conv_parms);
09489 
09490         delete e;
09491 }


Member Data Documentation

const string YGradientProcessor::NAME = "math.edge.ygradient" [static]

Definition at line 589 of file processor.h.

Referenced by get_name().


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