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

EMAN::TestImageSinewave Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::TestImageSinewave:

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

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

Detailed Description

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

Parameters:
wavelength wavelength in equation sin(x*2*PI/wavelength - phase*180/PI)
axis (optional) specify a major axis for asymmetric features, default x axis
phase (optional) the phase in equation sin(x*2*PI/wavelength - phase*180/PI)
az (optional) angle in degree. for 2D image, this is the rotated angle of the image, in 3D image, it's az for euler angle. default is zero
alt (optional) angle in degree. only in 3D case, alt for euler angle, default is zero
phi (optional) angle in degree. only in 3D case, phi for euler angle, default is zero

Definition at line 6238 of file processor.h.


Member Function Documentation

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

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

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

References NAME.

Referenced by process_inplace().

06244                 {
06245                         return NAME;
06246                 }

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

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

06259                 {
06260                         TypeDict d;
06261                         d.put("wavelength", EMObject::FLOAT, "wavelength in equation sin(x*2*PI/wavelength - phase*180/PI)");
06262                         d.put("axis", EMObject::STRING, "(optional) specify a major axis for asymmetric features, default x axis");
06263                         d.put("phase", EMObject::FLOAT, "(optional) the phase in equation sin(x*2*PI/wavelength - phase*180/PI)");
06264                         d.put("az", EMObject::FLOAT, "(optional) angle in degree. for 2D image, this is the rotated angle of the image, \
06265                                                                                                 in 3D image, it's az for euler angle. default is zero");
06266                         d.put("alt", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, alt for euler angle, default is zero");
06267                         d.put("phi", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, phi for euler angle, default is zero");
06268                         return d;
06269                 }

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

Definition at line 6253 of file processor.h.

06254                 {
06255                         return new TestImageSinewave();
06256                 }

void TestImageSinewave::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 7336 of file processor.cpp.

References EMAN::EMData::get_data(), get_name(), EMAN::EMData::get_ndim(), EMAN::Dict::has_key(), InvalidParameterException, LOGERR, EMAN::Processor::params, phase(), phi, EMAN::TestImageProcessor::preprocess(), EMAN::EMData::transform(), and EMAN::EMData::update().

07337 {
07338         preprocess(image);
07339 
07340         if(!params.has_key("wavelength")) {
07341                 LOGERR("%s wavelength is required parameter", get_name().c_str());
07342                 throw InvalidParameterException("wavelength parameter is required.");
07343         }
07344         float wavelength = params["wavelength"];
07345 
07346         string axis = "";
07347         if(params.has_key("axis")) {
07348                 axis = (const char*)params["axis"];
07349         }
07350 
07351         float phase = 0;
07352         if(params.has_key("phase")) {
07353                 phase = params["phase"];
07354         }
07355 
07356         int ndim = image->get_ndim();
07357         float * dat = image->get_data();
07358 
07359         if(ndim==1) {   //1D
07360                 for(int i=0; i<nx; ++i, ++dat) {
07361                         *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07362                 }
07363         }
07364         else if(ndim==2) {      //2D
07365                 float alpha = 0;
07366                 if(params.has_key("az")) {
07367                         alpha = params["az"];
07368                 }
07369                 for(int j=0; j<ny; ++j) {
07370                         for(int i=0; i<nx; ++i, ++dat) {
07371                                 if(alpha != 0) {
07372                                         *dat = sin((i*sin((180-alpha)*M_PI/180)+j*cos((180-alpha)*M_PI/180))*(2.0f*M_PI/wavelength) + phase);
07373                                 }
07374                                 else if(axis.compare("y")==0 || axis.compare("Y")==0) {
07375                                         *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
07376                                 }
07377                                 else {
07378                                         *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07379                                 }
07380                         }
07381                 }
07382         }
07383         else {  //3D
07384                 float az = 0;
07385                 if(params.has_key("az")) {
07386                         az = params["az"];
07387                 }
07388                 float alt = 0;
07389                 if(params.has_key("alt")) {
07390                         alt = params["alt"];
07391                 }
07392                 float phi = 0;
07393                 if(params.has_key("phi")) {
07394                         phi = params["phi"];
07395                 }
07396 
07397                 for(int k=0; k<nz; ++k) {
07398                         for(int j=0; j<ny; ++j) {
07399                                 for(int i=0; i<nx; ++i, ++dat) {
07400                                         if(axis.compare("z")==0 || axis.compare("Z")==0) {
07401                                                 *dat = sin(k*(2.0f*M_PI/wavelength) + phase);
07402                                         }
07403                                         else if(axis.compare("y")==0 || axis.compare("Y")==0) {
07404                                                 *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
07405                                         }
07406                                         else {
07407                                                 *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07408                                         }
07409                                 }
07410                         }
07411                 }
07412 
07413                 if(az != 0 || alt != 0 || phi != 0) {
07414                         Dict d("type","eman");
07415                         d["az"] = az; d["phi"] = phi; d["alt"] = alt;
07416                         image->transform(Transform(d));
07417                 }
07418         }
07419 
07420         image->update();
07421 }


Member Data Documentation

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

Definition at line 6271 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 13:07:24 2010 for EMAN2 by  doxygen 1.4.4