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

06248                 {
06249                         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)";
06250                 }

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

References NAME.

Referenced by process_inplace().

06243                 {
06244                         return NAME;
06245                 }

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

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

06258                 {
06259                         TypeDict d;
06260                         d.put("wavelength", EMObject::FLOAT, "cos(2*pi*r/wavelength+phase)");
06261                         d.put("phase", EMObject::FLOAT, "in radians");
06262                         d.put("x", EMObject::FLOAT, "center of the spherical wave");
06263                         d.put("y", EMObject::FLOAT, "center of the spherical wave");
06264                         d.put("z", EMObject::FLOAT, "center of the spherical wave");
06265                         return d;
06266                 }

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

Definition at line 6252 of file processor.h.

06253                 {
06254                         return new TestImageSphericalWave();
06255                 }

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

07434 {
07435         preprocess(image);
07436 
07437         if(!params.has_key("wavelength")) {
07438                 LOGERR("%s wavelength is required parameter", get_name().c_str());
07439                 throw InvalidParameterException("wavelength parameter is required.");
07440         }
07441         float wavelength = params["wavelength"];
07442 
07443         float phase = 0;
07444         if(params.has_key("phase")) {
07445                 phase = params["phase"];
07446         }
07447 
07448         float x = (float)(nx/2);
07449         if (params.has_key("x")) x=params["x"];
07450         float y = (float)(ny/2);
07451         if (params.has_key("y")) y=params["y"];
07452         float z = (float)(nz/2);
07453         if (params.has_key("z")) z=params["z"];
07454 
07455         int ndim = image->get_ndim();
07456 
07457         if(ndim==2) {   //2D
07458                 for(int j=0; j<ny; ++j) {
07459                         for(int i=0; i<nx; ++i) {
07460 #ifdef _WIN32
07461                                 float r=_hypotf(x-(float)i,y-(float)j);
07462 #else
07463                                 float r=hypot(x-(float)i,y-(float)j);
07464 #endif  //_WIN32
07465                                 if (r<.5) continue;
07466                                 image->set_value_at(i,j,cos(2*(float)pi*r/wavelength+phase)/r);
07467                         }
07468                 }
07469         }
07470         else {  //3D
07471                 for(int k=0; k<nz; ++k) {
07472                         for(int j=0; j<ny; ++j) {
07473                                 for(int i=0; i<nx; ++i) {
07474                                         float r=Util::hypot3(x-(float)i,y-(float)j,z-(float)k);
07475                                         if (r<.5) continue;
07476                                         image->set_value_at(i,j,k,cos(2*(float)pi*r/wavelength+phase)/(r*r));
07477                                 }
07478                         }
07479                 }
07480         }
07481 
07482         image->update();
07483 }


Member Data Documentation

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

Definition at line 6268 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:53 2012 for EMAN2 by  doxygen 1.4.7