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

09510 {
09511         if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
09512 
09513         EMData* e = new EMData();
09514         int nx = image->get_xsize();
09515         int ny = image->get_ysize();
09516         int nz = image->get_zsize();
09517 
09518         if ( nz == 1 && ny == 1 ) {
09519                 throw ImageDimensionException("Error - cannot detect Y edges for an image that that is 1D!");
09520         } else if ( nz == 1 ) {
09521                 if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09522                 e->set_size(3,3,1);
09523                 e->set_value_at(0,0,-1);
09524                 e->set_value_at(1,0,-2);
09525                 e->set_value_at(2,0,-1);
09526 
09527                 e->set_value_at(0,2,1);
09528                 e->set_value_at(1,2,2);
09529                 e->set_value_at(2,2,1);
09530                 Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
09531                 e->clip_inplace(r);
09532         } else {
09533                 if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
09534                 e->set_size(3,3,3);
09535                 e->set_value_at(0,0,0,-1);
09536                 e->set_value_at(1,0,0,-1);
09537                 e->set_value_at(2,0,0,-1);
09538                 e->set_value_at(0,0,1,-1);
09539                 e->set_value_at(1,0,1,-8);
09540                 e->set_value_at(2,0,1,-1);
09541                 e->set_value_at(0,0,2,-1);
09542                 e->set_value_at(1,0,2,-1);
09543                 e->set_value_at(2,0,2,-1);
09544 
09545                 e->set_value_at(0,2,0,1);
09546                 e->set_value_at(1,2,0,1);
09547                 e->set_value_at(2,2,0,1);
09548                 e->set_value_at(0,2,1,1);
09549                 e->set_value_at(1,2,1,8);
09550                 e->set_value_at(2,2,1,1);
09551                 e->set_value_at(0,2,2,1);
09552                 e->set_value_at(1,2,2,1);
09553                 e->set_value_at(2,2,2,1);
09554 
09555                 Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
09556                 e->clip_inplace(r);
09557         }
09558 
09559         Dict conv_parms;
09560         conv_parms["with"] = e;
09561         image->process_inplace("math.convolution", conv_parms);
09562 
09563         delete e;
09564 }


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 Thu Nov 17 12:45:51 2011 for EMAN2 by  doxygen 1.4.7