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:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void process_inplace (EMData *image)
 To process an image in-place.
virtual string get_name () const
 Get the processor's name.
virtual string get_desc () const
 Get the descrition of this specific processor.
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "testimage.linewave"

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


Member Function Documentation

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

Definition at line 5908 of file processor.h.

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

virtual string EMAN::TestImageLineWave::get_name (  )  const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 5903 of file processor.h.

References NAME.

05904                         {
05905                                 return NAME;
05906                         }

virtual TypeDict EMAN::TestImageLineWave::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 5918 of file processor.h.

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

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

static Processor* EMAN::TestImageLineWave::NEW (  )  [inline, static]

Definition at line 5913 of file processor.h.

05914                         {
05915                                 return new TestImageLineWave();
05916                         }

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 6979 of file processor.cpp.

References EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::Processor::params, EMAN::EMConsts::pi, EMAN::TestImageProcessor::preprocess(), EMAN::Dict::set_default(), EMAN::EMData::set_value_at_fast(), and x.

06980 {
06981         preprocess(image);
06982 
06983         float period = params.set_default("period",10.0f);
06984         size_t n = (size_t)image->get_xsize()*image->get_ysize()*image->get_zsize();
06985 
06986         for(size_t i = 0; i < n; ++i) {
06987                 float x = fmod((float)i,period);
06988                 x /= period;
06989                 x = (float)sin(x*EMConsts::pi*2.0);
06990                 image->set_value_at_fast(i,x);
06991         }
06992 }


Member Data Documentation

const string TestImageLineWave::NAME = "testimage.linewave" [static]

Definition at line 5925 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon May 2 13:31:00 2011 for EMAN2 by  doxygen 1.4.7