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 radians
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 6321 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 6331 of file processor.h.

06332                 {
06333                         return "Replace a source image as a sine wave in specified wave length";
06334                 }

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

References NAME.

Referenced by process_inplace().

06327                 {
06328                         return NAME;
06329                 }

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

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

06342                 {
06343                         TypeDict d;
06344                         d.put("wavelength", EMObject::FLOAT, "wavelength in equation sin(x*2*PI/wavelength - phase*180/PI)");
06345                         d.put("axis", EMObject::STRING, "(optional) specify a major axis for asymmetric features, default x axis");
06346                         d.put("phase", EMObject::FLOAT, "(optional) the phase in radians");
06347                         d.put("az", EMObject::FLOAT, "(optional) angle in degree. for 2D image, this is the rotated angle of the image, \
06348                                                                                                 in 3D image, it's az for euler angle. default is zero");
06349                         d.put("alt", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, alt for euler angle, default is zero");
06350                         d.put("phi", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, phi for euler angle, default is zero");
06351                         return d;
06352                 }

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

Definition at line 6336 of file processor.h.

06337                 {
06338                         return new TestImageSinewave();
06339                 }

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 7566 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().

07567 {
07568         preprocess(image);
07569 
07570         if(!params.has_key("wavelength")) {
07571                 LOGERR("%s wavelength is required parameter", get_name().c_str());
07572                 throw InvalidParameterException("wavelength parameter is required.");
07573         }
07574         float wavelength = params["wavelength"];
07575 
07576         string axis = "";
07577         if(params.has_key("axis")) {
07578                 axis = (const char*)params["axis"];
07579         }
07580 
07581         float phase = 0;
07582         if(params.has_key("phase")) {
07583                 phase = params["phase"];
07584         }
07585 
07586         int ndim = image->get_ndim();
07587         float * dat = image->get_data();
07588 
07589         if(ndim==1) {   //1D
07590                 for(int i=0; i<nx; ++i, ++dat) {
07591                         *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07592                 }
07593         }
07594         else if(ndim==2) {      //2D
07595                 float alpha = 0;
07596                 if(params.has_key("az")) {
07597                         alpha = params["az"];
07598                 }
07599                 for(int j=0; j<ny; ++j) {
07600                         for(int i=0; i<nx; ++i, ++dat) {
07601                                 if(alpha != 0) {
07602                                         *dat = sin((i*sin((180-alpha)*M_PI/180)+j*cos((180-alpha)*M_PI/180))*(2.0f*M_PI/wavelength) + phase);
07603                                 }
07604                                 else if(axis.compare("y")==0 || axis.compare("Y")==0) {
07605                                         *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
07606                                 }
07607                                 else {
07608                                         *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07609                                 }
07610                         }
07611                 }
07612         }
07613         else {  //3D
07614                 float az = 0;
07615                 if(params.has_key("az")) {
07616                         az = params["az"];
07617                 }
07618                 float alt = 0;
07619                 if(params.has_key("alt")) {
07620                         alt = params["alt"];
07621                 }
07622                 float phi = 0;
07623                 if(params.has_key("phi")) {
07624                         phi = params["phi"];
07625                 }
07626 
07627                 for(int k=0; k<nz; ++k) {
07628                         for(int j=0; j<ny; ++j) {
07629                                 for(int i=0; i<nx; ++i, ++dat) {
07630                                         if(axis.compare("z")==0 || axis.compare("Z")==0) {
07631                                                 *dat = sin(k*(2.0f*M_PI/wavelength) + phase);
07632                                         }
07633                                         else if(axis.compare("y")==0 || axis.compare("Y")==0) {
07634                                                 *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
07635                                         }
07636                                         else {
07637                                                 *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
07638                                         }
07639                                 }
07640                         }
07641                 }
07642 
07643                 if(az != 0 || alt != 0 || phi != 0) {
07644                         Dict d("type","eman");
07645                         d["az"] = az; d["phi"] = phi; d["alt"] = alt;
07646                         image->transform(Transform(d));
07647                 }
07648         }
07649 
07650         image->update();
07651 }


Member Data Documentation

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

Definition at line 6354 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:44:42 2013 for EMAN2 by  doxygen 1.4.7