EMAN2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
EMAN::RealPixelProcessor Class Reference

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

#include <processor.h>

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

List of all members.

Public Member Functions

 RealPixelProcessor ()
void process_inplace (EMData *image)
 To process an image in-place.
virtual void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.

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
virtual void calc_locals (EMData *)
virtual void normalize (EMData *) const

Protected Attributes

float value
float maxval
float mean
float sigma

Detailed Description

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

The processor won't consider the pixel's coordinates and neighbors.

Definition at line 1218 of file processor.h.


Constructor & Destructor Documentation

EMAN::RealPixelProcessor::RealPixelProcessor ( ) [inline]

Definition at line 1221 of file processor.h.

                                    :value(0), maxval(1), mean(0), sigma(0)
                {
                }

Member Function Documentation

virtual void EMAN::RealPixelProcessor::calc_locals ( EMData ) [inline, protected, virtual]

Definition at line 1242 of file processor.h.

Referenced by process_inplace().

                {
                }
static string EMAN::RealPixelProcessor::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 1235 of file processor.h.

                {
                        return "The base class for real space processor working on individual pixels. The processor won't consider the pixel's coordinates and neighbors.";
                }
virtual void EMAN::RealPixelProcessor::normalize ( EMData ) const [inline, protected, virtual]

Definition at line 1245 of file processor.h.

                {
                }
void RealPixelProcessor::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 1456 of file processor.cpp.

References calc_locals(), data, EMAN::EMData::get_attr(), EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), LOGWARN, maxval, mean, process_pixel(), sigma, and EMAN::EMData::update().

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }

        maxval = image->get_attr("maximum");
        mean = image->get_attr("mean");
        sigma = image->get_attr("sigma");

        calc_locals(image);

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

        for (size_t i = 0; i < size; ++i) {
                process_pixel(&data[i]);
        }
        image->update();
}
virtual void EMAN::RealPixelProcessor::process_pixel ( float *  x) const [protected, pure virtual]
virtual void EMAN::RealPixelProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Reimplemented in EMAN::RecipCarefullyProcessor, EMAN::ValuePowProcessor, EMAN::CollapseProcessor, EMAN::LinearXformProcessor, EMAN::ExpProcessor, EMAN::FiniteProcessor, EMAN::RangeThresholdProcessor, and EMAN::SigmaProcessor.

Definition at line 1226 of file processor.h.

References EMAN::Processor::params, EMAN::Dict::size(), value, and EMAN::Dict::values().

                {
                        params = new_params;
                        if (params.size() == 1) {
                                vector < EMObject > dict_values = params.values();
                                value = dict_values[0];
                        }
                }

Member Data Documentation

Definition at line 1250 of file processor.h.

Referenced by process_inplace().

float EMAN::RealPixelProcessor::mean [protected]

Definition at line 1251 of file processor.h.

Referenced by process_inplace(), and EMAN::SigmaProcessor::process_pixel().

Definition at line 1252 of file processor.h.

Referenced by process_inplace(), and EMAN::SigmaProcessor::process_pixel().


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