EMAN::RealPixelProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::RealPixelProcessor:

Collaboration diagram for EMAN::RealPixelProcessor:

Public Member Functions
	RealPixelProcessor ()
void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...
virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...
virtual string	get_name () const =0
	Get the processor's name. More...
virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...
virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
virtual string	get_desc () const =0
	Get the descrition of this specific processor. More...

Static Public Member Functions
static string	get_group_desc ()
Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...
static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...
static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

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
Protected Attributes inherited from EMAN::Processor
Dict	params

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types {   TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,   GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,   GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,   KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,   SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,   TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

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 2178 of file processor.h.

Constructor & Destructor Documentation

RealPixelProcessor()

EMAN::RealPixelProcessor::RealPixelProcessor ( )

inline

Definition at line 2181 of file processor.h.

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

Member Function Documentation

calc_locals()

virtual void EMAN::RealPixelProcessor::calc_locals ( EMData *  )

inlineprotectedvirtual

Definition at line 2202 of file processor.h.

                {
                }

Referenced by process_inplace().

get_group_desc()

static string EMAN::RealPixelProcessor::get_group_desc ( )

inlinestatic

Definition at line 2195 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.";
                }

normalize()

virtual void EMAN::RealPixelProcessor::normalize ( EMData *  ) const

inlineprotectedvirtual

Definition at line 2205 of file processor.h.

                {
                }

process_inplace()

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

image

The image to be processed.

Implements EMAN::Processor.

Definition at line 2243 of file processor.cpp.

{
        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();
}

References calc_locals(), LOGWARN, maxval, mean, process_pixel(), and sigma.

process_pixel()

virtual void EMAN::RealPixelProcessor::process_pixel ( float *  x ) const

protectedpure virtual

Implemented in EMAN::AbsoluteValueProcessor, EMAN::FloorValueProcessor, EMAN::FixSignProcessor, EMAN::BooleanProcessor, EMAN::RecipCarefullyProcessor, EMAN::ValuePowProcessor, EMAN::ValueSquaredProcessor, EMAN::ValueSqrtProcessor, EMAN::DiscritizeProcessor, EMAN::ToZeroProcessor, EMAN::AboveToZeroProcessor, EMAN::CutToZeroProcessor, EMAN::BinarizeProcessor, EMAN::CollapseProcessor, EMAN::LinearXformProcessor, EMAN::ExpProcessor, EMAN::FiniteProcessor, EMAN::RangeThresholdProcessor, EMAN::SigmaProcessor, EMAN::LogProcessor, and EMAN::ReplaceValuefromListProcessor.

Referenced by process_inplace().

set_params()

virtual void EMAN::RealPixelProcessor::set_params ( const Dict &  new_params )

inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters

new_params

A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

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

Definition at line 2186 of file processor.h.

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

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

Member Data Documentation

maxval

float EMAN::RealPixelProcessor::maxval

protected

Definition at line 2210 of file processor.h.

Referenced by process_inplace().

mean

float EMAN::RealPixelProcessor::mean

protected

Definition at line 2211 of file processor.h.

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

sigma

float EMAN::RealPixelProcessor::sigma

protected

Definition at line 2212 of file processor.h.

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

value

float EMAN::RealPixelProcessor::value

protected

Definition at line 2209 of file processor.h.

Referenced by EMAN::ToZeroProcessor::process_pixel(), EMAN::AboveToZeroProcessor::process_pixel(), EMAN::CutToZeroProcessor::process_pixel(), EMAN::BinarizeProcessor::process_pixel(), EMAN::CollapseProcessor::process_pixel(), set_params(), and EMAN::CollapseProcessor::set_params().

---

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

• processor.h
• processor.cpp