EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
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:
Inheritance graph
[legend]
Collaboration diagram for EMAN::TestImageSinewaveCircular:
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.circular"

Detailed Description

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

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

Definition at line 6735 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 6745 of file processor.h.

                {
                        return "Replace a source image as a circular sine wave in specified wave length";
                }
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 6740 of file processor.h.

References NAME.

                {
                        return NAME;
                }
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 6755 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("wavelength", EMObject::FLOAT, "(required)this value is the d in function |sin(x/d)|, unit: pixel");
                        d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
                        d.put("c", EMObject::FLOAT, "distance between focus and the center of an ellipse");
                        d.put("phase", EMObject::FLOAT, "(optional)phase for sine wave, default is 0");
                        return d;
                }
static Processor* EMAN::TestImageSinewaveCircular::NEW ( ) [inline, static]

Definition at line 6750 of file processor.h.

                {
                        return new TestImageSinewaveCircular();
                }
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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 8091 of file processor.cpp.

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

{
        preprocess(image);

        float wavelength = params["wavelength"];
        string axis = (const char*)params["axis"];
        float c = params["c"];
        float phase = params["phase"];

        float *dat = image->get_data();
        float r; //this is the distance of pixel from the image center(nx/2, ny/2, nz/2)
        float x2, y2, z2; //this is the coordinates of this pixel from image center
        for (int k = 0; k < nz; ++k) {
                for (int j = 0; j < ny; ++j) {
                        for (int i = 0; i < nx; ++i, ++dat) {
                                x2 = (float)( i - nx/2 );
                                y2 = (float)( j - ny/2 );
                                z2 = (float)( k - nz/2 );
                                if(axis == ""){
                                        r = (float)sqrt(x2*x2+y2*y2+z2*z2);
                                }
                                else if(axis == "x"){
                                        float lc = -c;
                                        float rc = c;
                                        r = ( (float)sqrt((x2-lc)*(x2-lc)+y2*y2+z2*z2) +
                                                  (float)sqrt((x2-rc)*(x2-rc)+y2*y2+z2*z2) ) /2.0f - c;
                                }
                                else if(axis == "y"){
                                        float lc = -c;
                                        float rc = c;
                                        r = ( (float)sqrt(x2*x2+(y2-lc)*(y2-lc)+z2*z2) +
                                                  (float)sqrt(x2*x2+(y2-rc)*(y2-rc)+z2*z2) ) /2.0f - c;
                                }
                                else if(axis == "z"){
                                        if( nz == 1 ){
                                                throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
                                        }
                                        float lc = -c;
                                        float rc = c;
                                        r = ( (float)sqrt(x2*x2+y2*y2+(z2-lc)*(z2-lc)) +
                                                  (float)sqrt(x2*x2+y2*y2+(z2-rc)*(z2-rc)) ) /2.0f - c;
                                }
                                else{
                                        throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
                                }
                                *dat = sin( r * (2.0f*M_PI/wavelength) - phase*180/M_PI);
                        }
                }
        }

        image->update();
}

Member Data Documentation

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

Definition at line 6765 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files: