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

#include <processor.h>

Inheritance diagram for EMAN::TestImageSinewave:

Collaboration diagram for EMAN::TestImageSinewave:

[legend]

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

virtual string	get_name () const
	Get the processor's name. More...

virtual string	get_desc () const
	Get the descrition of this specific processor. More...

virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::TestImageProcessor
static string	get_group_desc ()

Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...

static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...

static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "testimage.sinewave"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types { TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC , GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE , GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC , KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE , SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC , TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

Protected Member Functions inherited from EMAN::TestImageProcessor
void	preprocess (EMData *image)

Protected Attributes inherited from EMAN::TestImageProcessor
int	nx

int	ny

int	nz

Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

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

Parameters

wavelength	wavelength in equation sin(x2PI/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 8523 of file processor.h.

Member Function Documentation

◆ get_desc()

virtual string EMAN::TestImageSinewave::get_desc ( ) const

inlinevirtual

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

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

◆ get_name()

virtual string EMAN::TestImageSinewave::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns: The processor's name.

Implements EMAN::Processor.

Definition at line 8528 of file processor.h.

                {
                        return NAME;
                }

References NAME.

Referenced by process_inplace().

◆ get_param_types()

virtual TypeDict EMAN::TestImageSinewave::get_param_types ( ) const

inlinevirtual

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

                {
                        TypeDict d;
                        d.put("wavelength", EMObject::FLOAT, "wavelength in equation sin(x*2*PI/wavelength - phase*180/PI)");
                        d.put("axis", EMObject::STRING, "(optional) specify a major axis for asymmetric features, default x axis");
                        d.put("phase", EMObject::FLOAT, "(optional) the phase in radians");
                        d.put("az", EMObject::FLOAT, "(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");
                        d.put("alt", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, alt for euler angle, default is zero");
                        d.put("phi", EMObject::FLOAT, "(optional) angle in degree. only in 3D case, phi for euler angle, default is zero");
                        return d;
                }

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

◆ NEW()

static Processor * EMAN::TestImageSinewave::NEW ( )

inlinestatic

Definition at line 8538 of file processor.h.

                {
                        return new TestImageSinewave();
                }

◆ process_inplace()

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 9601 of file processor.cpp.

{
        preprocess(image);
 
        if(!params.has_key("wavelength")) {
                LOGERR("%s wavelength is required parameter", get_name().c_str());
                throw InvalidParameterException("wavelength parameter is required.");
        }
        float wavelength = params["wavelength"];
 
        string axis = "";
        if(params.has_key("axis")) {
                axis = (const char*)params["axis"];
        }
 
        float phase = 0;
        if(params.has_key("phase")) {
                phase = params["phase"];
        }
 
        int ndim = image->get_ndim();
        float * dat = image->get_data();
 
        if(ndim==1) {   //1D
                for(int i=0; i<nx; ++i, ++dat) {
                        *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
                }
        }
        else if(ndim==2) {      //2D
                float alpha = 0;
                if(params.has_key("az")) {
                        alpha = params["az"];
                }
                for(int j=0; j<ny; ++j) {
                        for(int i=0; i<nx; ++i, ++dat) {
                                if(alpha != 0) {
                                        *dat = sin((i*sin((180-alpha)*M_PI/180)+j*cos((180-alpha)*M_PI/180))*(2.0f*M_PI/wavelength) + phase);
                                }
                                else if(axis.compare("y")==0 || axis.compare("Y")==0) {
                                        *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
                                }
                                else {
                                        *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
                                }
                        }
                }
        }
        else {  //3D
                float az = 0;
                if(params.has_key("az")) {
                        az = params["az"];
                }
                float alt = 0;
                if(params.has_key("alt")) {
                        alt = params["alt"];
                }
                float phi = 0;
                if(params.has_key("phi")) {
                        phi = params["phi"];
                }
 
                for(int k=0; k<nz; ++k) {
                        for(int j=0; j<ny; ++j) {
                                for(int i=0; i<nx; ++i, ++dat) {
                                        if(axis.compare("z")==0 || axis.compare("Z")==0) {
                                                *dat = sin(k*(2.0f*M_PI/wavelength) + phase);
                                        }
                                        else if(axis.compare("y")==0 || axis.compare("Y")==0) {
                                                *dat = sin(j*(2.0f*M_PI/wavelength) + phase);
                                        }
                                        else {
                                                *dat = sin(i*(2.0f*M_PI/wavelength) + phase);
                                        }
                                }
                        }
                }
 
                if(az != 0 || alt != 0 || phi != 0) {
                        Dict d("type","eman");
                        d["az"] = az; d["phi"] = phi; d["alt"] = alt;
                        image->transform(Transform(d));
                }
        }
 
        image->update();
}

References get_name(), EMAN::Dict::has_key(), InvalidParameterException, LOGERR, EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, phase(), EMAN::TestImageProcessor::preprocess(), and EMAN::EMData::transform().

Member Data Documentation

◆ NAME

const string TestImageSinewave::NAME = "testimage.sinewave"

static

Definition at line 8556 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME