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

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

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

References NAME.

06018                         {
06019                                 return NAME;
06020                         }

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

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

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

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

Definition at line 6027 of file processor.h.

06028                         {
06029                                 return new TestImageLineWave();
06030                         }

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 7165 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.

07166 {
07167         preprocess(image);
07168 
07169         float period = params.set_default("period",10.0f);
07170         size_t n = (size_t)image->get_xsize()*image->get_ysize()*image->get_zsize();
07171 
07172         for(size_t i = 0; i < n; ++i) {
07173                 float x = fmod((float)i,period);
07174                 x /= period;
07175                 x = (float)sin(x*EMConsts::pi*2.0);
07176                 image->set_value_at_fast(i,x);
07177         }
07178 }


Member Data Documentation

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

Definition at line 6039 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:10:49 2012 for EMAN2 by  doxygen 1.4.7