EMAN2
Public Member Functions | Static Public Member Functions | Protected Member Functions
EMAN::ComplexPixelProcessor Class Reference

The base class for fourier space processor working on individual pixels. More...

#include <processor.h>

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

List of all members.

Public Member Functions

void process_inplace (EMData *image)
 To process an image in-place.

Static Public Member Functions

static string get_group_desc ()
 Get the description of this group of processors.

Protected Member Functions

virtual void process_pixel (float *x) const =0

Detailed Description

The base class for fourier space processor working on individual pixels.

ri2ap() is called before processing, so individual pixels will be A/P rather than R/I. The processor won't consider the pixel's coordinates and neighbors.

Definition at line 3009 of file processor.h.


Member Function Documentation

static string EMAN::ComplexPixelProcessor::get_group_desc ( ) [inline, static]

Get the description of this group of processors.

This function is defined in a parent class. It gives a introduction to a group of processors.

Returns:
The description of this group of processors.

Reimplemented from EMAN::Processor.

Definition at line 3014 of file processor.h.

                {
                        return "The base class for fourier space processor working on individual pixels. ri2ap() is called before processing, so individual pixels will be A/P rather than R/I. The processor won't consider the pixel's coordinates and neighbors.";
                }
void ComplexPixelProcessor::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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 1621 of file processor.cpp.

References EMAN::EMData::ap2ri(), data, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::EMData::is_complex(), LOGWARN, process_pixel(), EMAN::EMData::ri2ap(), and EMAN::EMData::update().

{
        if (!image) {
                LOGWARN("NULL image");
                return;
        }
        if (!image->is_complex()) {
                LOGWARN("cannot apply complex processor on a real image. Nothing is done.");
                return;
        }

        size_t size = (size_t)image->get_xsize() *
                          (size_t)image->get_ysize() *
                          (size_t)image->get_zsize();
        float *data = image->get_data();

        image->ri2ap();

        for (size_t i = 0; i < size; i += 2) {
                process_pixel(data);
                data += 2;
        }

        image->update();
        image->ap2ri();
}
virtual void EMAN::ComplexPixelProcessor::process_pixel ( float *  x) const [protected, pure virtual]

Implemented in EMAN::ComplexNormPixel.

Referenced by process_inplace().


The documentation for this class was generated from the following files: