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

#include <processor.h>

Inheritance diagram for EMAN::TestImageSphericalWave:

Collaboration diagram for EMAN::TestImageSphericalWave:

[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.sphericalwave"

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	cos(2pir/wavelength+phase)
phase	in radians
x	center of the spherical wave
y	center of the spherical wave
z	center of the spherical wave

Definition at line 8480 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Replace a source image in 2d or 3d with a spherical wave cos(2*pi*r/wavelength+phase) also 1/r (2d) or 1/r^2 (3d)";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

Referenced by process_inplace().

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("wavelength", EMObject::FLOAT, "cos(2*pi*r/wavelength+phase)");
                        d.put("phase", EMObject::FLOAT, "in radians");
                        d.put("x", EMObject::FLOAT, "center of the spherical wave");
                        d.put("y", EMObject::FLOAT, "center of the spherical wave");
                        d.put("z", EMObject::FLOAT, "center of the spherical wave");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 8495 of file processor.h.

                {
                        return new TestImageSphericalWave();
                }

◆ process_inplace()

void TestImageSphericalWave::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 9552 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"];
 
        float phase = 0;
        if(params.has_key("phase")) {
                phase = params["phase"];
        }
 
        float x = (float)(nx/2);
        if (params.has_key("x")) x=params["x"];
        float y = (float)(ny/2);
        if (params.has_key("y")) y=params["y"];
        float z = (float)(nz/2);
        if (params.has_key("z")) z=params["z"];
 
        int ndim = image->get_ndim();
 
        if(ndim==2) {   //2D
                for(int j=0; j<ny; ++j) {
                        for(int i=0; i<nx; ++i) {
                                float r=hypot(x-(float)i,y-(float)j);
                                if (r<.5) continue;
                                image->set_value_at(i,j,cos(2*(float)pi*r/wavelength+phase)/r);
                        }
                }
        }
        else {  //3D
                for(int k=0; k<nz; ++k) {
                        for(int j=0; j<ny; ++j) {
                                for(int i=0; i<nx; ++i) {
                                        float r=Util::hypot3(x-(float)i,y-(float)j,z-(float)k);
                                        if (r<.5) continue;
                                        image->set_value_at(i,j,k,cos(2*(float)pi*r/wavelength+phase)/(r*r));
                                }
                        }
                }
        }
 
        image->update();
}

References get_name(), EMAN::Dict::has_key(), EMAN::Util::hypot3(), InvalidParameterException, LOGERR, EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, phase(), EMAN::TestImageProcessor::preprocess(), x, and y.

Member Data Documentation

◆ NAME

const string TestImageSphericalWave::NAME = "testimage.sphericalwave"

static

Definition at line 8511 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