Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::AreaProcessor Class Reference

AreaProcessor use pixel values and coordinates of a real-space square area. More...

#include <processor.h>

Inheritance diagram for EMAN::AreaProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AreaProcessor ()
void process_inplace (EMData *image)
 To process an image in-place.
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
string get_desc () const
 Get the descrition of this specific processor.

Protected Member Functions

virtual void process_pixel (float *pixel, float, float, float, float *area_matrix) const
virtual void create_kernel () const =0

Protected Attributes

int areasize
int matrix_size
float * kernel
int nx
int ny
int nz

Detailed Description

AreaProcessor use pixel values and coordinates of a real-space square area.

This is the base class. Specific AreaProcessor needs to implement function create_kernel().

Parameters:
areasize The width of the area to process (not radius)

Definition at line 2645 of file processor.h.


Constructor & Destructor Documentation

EMAN::AreaProcessor::AreaProcessor  )  [inline]
 

Definition at line 2648 of file processor.h.

References nx, and ny.

02648                                :areasize(0), kernel(0), nx(0), ny(0), nz(0)
02649                 {
02650                 }


Member Function Documentation

virtual void EMAN::AreaProcessor::create_kernel  )  const [protected, pure virtual]
 

Implemented in EMAN::LaplacianProcessor, and EMAN::ZeroConstantProcessor.

Referenced by process_inplace().

string EMAN::AreaProcessor::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.

Reimplemented in EMAN::LaplacianProcessor, and EMAN::ZeroConstantProcessor.

Definition at line 2667 of file processor.h.

02668                 {
02669                         return "AreaProcessor use pixel values and coordinates of a real-space square area. This is the base class. Specific AreaProcessor needs to implement function create_kernel().";
02670                 }

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

References EMAN::TypeDict::put().

02661                 {
02662                         TypeDict d;
02663                         d.put("areasize", EMObject::INT, "The width of the area to process (not radius)");
02664                         return d;
02665                 }

void AreaProcessor::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 1503 of file processor.cpp.

References areasize, create_kernel(), data, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), kernel, LOGWARN, matrix(), matrix_size, nx, ny, nz, process_pixel(), EMAN::EMData::update(), x, and y.

01504 {
01505         if (!image) {
01506                 LOGWARN("NULL Image");
01507                 return;
01508         }
01509 
01510         float *data = image->get_data();
01511 
01512         nx = image->get_xsize();
01513         ny = image->get_ysize();
01514         nz = image->get_zsize();
01515 
01516         int n = (areasize - 1) / 2;
01517         matrix_size = areasize * areasize;
01518 
01519         if (nz > 1) {
01520                 matrix_size *= areasize;
01521         }
01522 
01523         float *matrix = new float[matrix_size];
01524         kernel = new float[matrix_size];
01525 
01526         int cpysize = areasize * (int) sizeof(float);
01527         int start = (nx * ny + nx + 1) * n;
01528 
01529         int xend = nx - n;
01530         int yend = ny - n;
01531 
01532         int zstart = n;
01533         int zend = nz - n;
01534 
01535         int zbox_start = 0;
01536         int zbox_end = areasize;
01537 
01538         if (nz == 1) {
01539                 zstart = 0;
01540                 zend = 1;
01541                 zbox_end = 1;
01542         }
01543 
01544         size_t nsec = (size_t)nx * (size_t)ny;
01545         int box_nsec = areasize * areasize;
01546 
01547         create_kernel();
01548 
01549         size_t total_size = (size_t)nx * (size_t)ny * (size_t)nz;
01550         float *data2 = new float[total_size];
01551         memcpy(data2, data, total_size * sizeof(float));
01552 
01553         size_t k;
01554         for (int z = zstart; z < zend; z++) {
01555                 for (int y = n; y < yend; y++) {
01556                         for (int x = n; x < xend; x++) {
01557 
01558                                 k = z * nsec + y * nx + x;
01559 
01560                                 for (int bz = zbox_start; bz < zbox_end; bz++) {
01561                                         for (int by = 0; by < areasize; by++) {
01562                                                 memcpy(&matrix[bz * box_nsec + by * areasize],
01563                                                            &data2[k - start + bz * nsec + by * nx], cpysize);
01564                                         }
01565                                 }
01566 
01567                                 process_pixel(&data[k], (float) x, (float) y, (float) z, matrix);
01568                         }
01569                 }
01570         }
01571 
01572         if( matrix )
01573         {
01574                 delete[]matrix;
01575                 matrix = 0;
01576         }
01577 
01578         if( kernel )
01579         {
01580                 delete[]kernel;
01581                 kernel = 0;
01582         }
01583         image->update();
01584 }

virtual void EMAN::AreaProcessor::process_pixel float *  pixel,
float  ,
float  ,
float  ,
float *  area_matrix
const [inline, protected, virtual]
 

Reimplemented in EMAN::ZeroConstantProcessor.

Definition at line 2673 of file processor.h.

Referenced by process_inplace().

02674                 {
02675                         for (int i = 0; i < matrix_size; i++)
02676                         {
02677                                 *pixel += area_matrix[i] * kernel[i];
02678                         }
02679                 }

void EMAN::AreaProcessor::set_params const Dict new_params  )  [inline, virtual]
 

Set the processor parameters using a key/value dictionary.

Parameters:
new_params A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 2654 of file processor.h.

02655                 {
02656                         params = new_params;
02657                         areasize = params["areasize"];
02658                 }


Member Data Documentation

int EMAN::AreaProcessor::areasize [protected]
 

Definition at line 2683 of file processor.h.

Referenced by process_inplace().

float* EMAN::AreaProcessor::kernel [protected]
 

Definition at line 2685 of file processor.h.

Referenced by process_inplace().

int EMAN::AreaProcessor::matrix_size [protected]
 

Definition at line 2684 of file processor.h.

Referenced by process_inplace().

int EMAN::AreaProcessor::nx [protected]
 

Definition at line 2686 of file processor.h.

Referenced by process_inplace().

int EMAN::AreaProcessor::ny [protected]
 

Definition at line 2687 of file processor.h.

Referenced by process_inplace().

int EMAN::AreaProcessor::nz [protected]
 

Definition at line 2688 of file processor.h.

Referenced by process_inplace().


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:53 2010 for EMAN2 by  doxygen 1.3.9.1