EMAN::TestImageSphericalWave Class Reference

Replace a source image as a sine wave in specified wave length. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageSphericalWave:

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

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.sphericalwave"

Detailed Description

Replace a source image as a sine wave in specified wave length.

Parameters:
wavelength cos(2*pi*r/wavelength+phase)
phase in radians
x center of the spherical wave
y center of the spherical wave
z center of the spherical wave

Definition at line 6161 of file processor.h.


Member Function Documentation

virtual string EMAN::TestImageSphericalWave::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 6171 of file processor.h.

06172                 {
06173                         return "Replace a source image in 2d or 3d with a spherical wave cos(2*pi*r/wavelength+phase) also 1/r (2d) or 1/r^2 (3d)";
06174                 }

virtual string EMAN::TestImageSphericalWave::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 6166 of file processor.h.

References NAME.

Referenced by process_inplace().

06167                 {
06168                         return NAME;
06169                 }

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

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

06182                 {
06183                         TypeDict d;
06184                         d.put("wavelength", EMObject::FLOAT, "cos(2*pi*r/wavelength+phase)");
06185                         d.put("phase", EMObject::FLOAT, "in radians");
06186                         d.put("x", EMObject::FLOAT, "center of the spherical wave");
06187                         d.put("y", EMObject::FLOAT, "center of the spherical wave");
06188                         d.put("z", EMObject::FLOAT, "center of the spherical wave");
06189                         return d;
06190                 }

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

Definition at line 6176 of file processor.h.

06177                 {
06178                         return new TestImageSphericalWave();
06179                 }

void TestImageSphericalWave::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 7275 of file processor.cpp.

References get_name(), EMAN::EMData::get_ndim(), EMAN::Dict::has_key(), EMAN::Util::hypot3(), InvalidParameterException, LOGERR, EMAN::Processor::params, phase(), pi, EMAN::TestImageProcessor::preprocess(), EMAN::EMData::set_value_at(), EMAN::EMData::update(), and x.

07276 {
07277         preprocess(image);
07278 
07279         if(!params.has_key("wavelength")) {
07280                 LOGERR("%s wavelength is required parameter", get_name().c_str());
07281                 throw InvalidParameterException("wavelength parameter is required.");
07282         }
07283         float wavelength = params["wavelength"];
07284 
07285         float phase = 0;
07286         if(params.has_key("phase")) {
07287                 phase = params["phase"];
07288         }
07289 
07290         float x = (float)(nx/2);
07291         if (params.has_key("x")) x=params["x"];
07292         float y = (float)(ny/2);
07293         if (params.has_key("y")) y=params["y"];
07294         float z = (float)(nz/2);
07295         if (params.has_key("z")) z=params["z"];
07296 
07297         int ndim = image->get_ndim();
07298 
07299         if(ndim==2) {   //2D
07300                 for(int j=0; j<ny; ++j) {
07301                         for(int i=0; i<nx; ++i) {
07302 #ifdef _WIN32
07303                                 float r=_hypotf(x-(float)i,y-(float)j);
07304 #else
07305                                 float r=hypot(x-(float)i,y-(float)j);
07306 #endif  //_WIN32
07307                                 if (r<.5) continue;
07308                                 image->set_value_at(i,j,cos(2*(float)pi*r/wavelength+phase)/r);
07309                         }
07310                 }
07311         }
07312         else {  //3D
07313                 for(int k=0; k<nz; ++k) {
07314                         for(int j=0; j<ny; ++j) {
07315                                 for(int i=0; i<nx; ++i) {
07316                                         float r=Util::hypot3(x-(float)i,y-(float)j,z-(float)k);
07317                                         if (r<.5) continue;
07318                                         image->set_value_at(i,j,k,cos(2*(float)pi*r/wavelength+phase)/(r*r));
07319                                 }
07320                         }
07321                 }
07322         }
07323 
07324         image->update();
07325 }


Member Data Documentation

const string TestImageSphericalWave::NAME = "testimage.sphericalwave" [static]

Definition at line 6192 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:49:40 2011 for EMAN2 by  doxygen 1.4.7