Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::TestImageSinewaveCircular Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::TestImageSinewaveCircular:

[legend]
Collaboration diagram for EMAN::TestImageSinewaveCircular:
[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

ProcessorNEW ()

Static Public Attributes

const string NAME = "testimage.sinewave.circular"

Detailed Description

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

Parameters:
wavelength float this value is the d in function |sin(x/d)|
axis char (optional) specify a major axis for asymmetric features
c distance (optional) float between focus and the center of an ellipse
phase degree (optional) phase for sine wave, default is 0

Definition at line 6239 of file processor.h.


Member Function Documentation

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

06250                 {
06251                         return "Replace a source image as a circular sine wave in specified wave length";
06252                 }

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

06245                 {
06246                         return NAME;
06247                 }

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

References EMAN::TypeDict::put().

06260                 {
06261                         TypeDict d;
06262                         d.put("wavelength", EMObject::FLOAT, "(required)this value is the d in function |sin(x/d)|, unit: pixel");
06263                         d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
06264                         d.put("c", EMObject::FLOAT, "distance between focus and the center of an ellipse");
06265                         d.put("phase", EMObject::FLOAT, "(optional)phase for sine wave, default is 0");
06266                         return d;
06267                 }

Processor* EMAN::TestImageSinewaveCircular::NEW  )  [inline, static]
 

Definition at line 6254 of file processor.h.

06255                 {
06256                         return new TestImageSinewaveCircular();
06257                 }

void TestImageSinewaveCircular::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 7285 of file processor.cpp.

References EMAN::EMData::get_data(), InvalidValueException, nx, ny, phase(), EMAN::TestImageProcessor::preprocess(), sqrt(), and EMAN::EMData::update().

07286 {
07287         preprocess(image);
07288 
07289         float wavelength = params["wavelength"];
07290         string axis = (const char*)params["axis"];
07291         float c = params["c"];
07292         float phase = params["phase"];
07293 
07294         float *dat = image->get_data();
07295         float r; //this is the distance of pixel from the image center(nx/2, ny/2, nz/2)
07296         float x2, y2, z2; //this is the coordinates of this pixel from image center
07297         for (int k = 0; k < nz; ++k) {
07298                 for (int j = 0; j < ny; ++j) {
07299                         for (int i = 0; i < nx; ++i, ++dat) {
07300                                 x2 = (float)( i - nx/2 );
07301                                 y2 = (float)( j - ny/2 );
07302                                 z2 = (float)( k - nz/2 );
07303                                 if(axis == ""){
07304                                         r = (float)sqrt(x2*x2+y2*y2+z2*z2);
07305                                 }
07306                                 else if(axis == "x"){
07307                                         float lc = -c;
07308                                         float rc = c;
07309                                         r = ( (float)sqrt((x2-lc)*(x2-lc)+y2*y2+z2*z2) +
07310                                                   (float)sqrt((x2-rc)*(x2-rc)+y2*y2+z2*z2) ) /2.0f - c;
07311                                 }
07312                                 else if(axis == "y"){
07313                                         float lc = -c;
07314                                         float rc = c;
07315                                         r = ( (float)sqrt(x2*x2+(y2-lc)*(y2-lc)+z2*z2) +
07316                                                   (float)sqrt(x2*x2+(y2-rc)*(y2-rc)+z2*z2) ) /2.0f - c;
07317                                 }
07318                                 else if(axis == "z"){
07319                                         if( nz == 1 ){
07320                                                 throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
07321                                         }
07322                                         float lc = -c;
07323                                         float rc = c;
07324                                         r = ( (float)sqrt(x2*x2+y2*y2+(z2-lc)*(z2-lc)) +
07325                                                   (float)sqrt(x2*x2+y2*y2+(z2-rc)*(z2-rc)) ) /2.0f - c;
07326                                 }
07327                                 else{
07328                                         throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
07329                                 }
07330                                 *dat = sin( r * (2.0f*M_PI/wavelength) - phase*180/M_PI);
07331                         }
07332                 }
07333         }
07334 
07335         image->update();
07336 }


Member Data Documentation

const string TestImageSinewaveCircular::NAME = "testimage.sinewave.circular" [static]
 

Definition at line 202 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Fri Apr 30 15:39:28 2010 for EMAN2 by  doxygen 1.3.9.1