EMAN::TestImageLineWave Class Reference

Treats the pixels as though they are 1D (even if the image is 2D or 3D), inserting a sine wave of pixel period extracted from the parameters (default is 10) More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageLineWave:

Collaboration diagram for EMAN::TestImageLineWave:

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual string	get_name () const
	Get the processor's name. More...
virtual string	get_desc () const
	Get the descrition of this specific processor. More...
virtual TypeDict	get_param_types () const
	Get processor parameter information in a 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 Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
Static Public Member Functions inherited from EMAN::TestImageProcessor
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...

Static Public Attributes
static const string	NAME = "testimage.linewave"

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...
Protected Member Functions inherited from EMAN::TestImageProcessor
void	preprocess (EMData *image)
Protected Attributes inherited from EMAN::TestImageProcessor
int	nx
int	ny
int	nz
Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Treats the pixels as though they are 1D (even if the image is 2D or 3D), inserting a sine wave of pixel period extracted from the parameters (default is 10)

Parameters

period

the period of the sine wave

Definition at line 8255 of file processor.h.

Member Function Documentation

get_desc()

virtual string EMAN::TestImageLineWave::get_desc ( ) const

inlinevirtual

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

                        {
                                return "Insert an oscillating sine wave into the pixel data";
                        }

get_name()

virtual string EMAN::TestImageLineWave::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns

The processor's name.

Implements EMAN::Processor.

Definition at line 8260 of file processor.h.

                        {
                                return NAME;
                        }

References NAME.

get_param_types()

virtual TypeDict EMAN::TestImageLineWave::get_param_types ( ) const

inlinevirtual

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

                        {
                                TypeDict d;
                                d.put("period", EMObject::FLOAT, "The period of the oscillating sine wave. Default 10.");
                                return d;
                        }

References EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().

NEW()

static Processor * EMAN::TestImageLineWave::NEW ( )

inlinestatic

Definition at line 8270 of file processor.h.

                        {
                                return new TestImageLineWave();
                        }

process_inplace()

void TestImageLineWave::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 9288 of file processor.cpp.

{
        preprocess(image);
 
        float period = params.set_default("period",10.0f);
        size_t n = (size_t)image->get_xsize()*image->get_ysize()*image->get_zsize();
 
        for(size_t i = 0; i < n; ++i) {
                float x = fmod((float)i,period);
                x /= period;
                x = (float)sin(x*EMConsts::pi*2.0);
                image->set_value_at_fast(i,x);
        }
}

References EMAN::Processor::params, EMAN::EMConsts::pi, EMAN::TestImageProcessor::preprocess(), EMAN::Dict::set_default(), and x.

Member Data Documentation

NAME

const string TestImageLineWave::NAME = "testimage.linewave"

static

Definition at line 8282 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp