add spectral noise to a complex image More...

#include <processor.h>

Inheritance diagram for EMAN::AddRandomNoiseProcessor:

Collaboration diagram for EMAN::AddRandomNoiseProcessor:

[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 TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

virtual string	get_desc () const
	Get the descrition of this specific processor. 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::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 = "math.addspectralnoise"

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 Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

add spectral noise to a complex image

Parameters

n
x0
dx
y
interpolation
seed	seed for random number generator

Definition at line 6563 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "add spectral noise to a complex image.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("n", EMObject::INT);
                        d.put("x0", EMObject::FLOAT);
                        d.put("dx", EMObject::FLOAT);
                        d.put("y", EMObject::FLOATARRAY);
                        d.put("interpolation", EMObject::INT);
                        d.put("seed", EMObject::INT, "seed for random number generator");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 6573 of file processor.h.

                {
                        return new AddRandomNoiseProcessor();
                }

◆ process_inplace()

void AddRandomNoiseProcessor::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 7010 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        if (!image->is_complex()) {
                LOGERR("AddRandomNoise Processor only works for complex image");
                throw ImageFormatException("only work for complex image");
        }
 
        int n = params["n"];
        float x0 = params["x0"];
        float dx = params["dx"];
        vector < float >y = params["y"];
 
        int interpolation = 1;
        if (params.has_key("interpolation")) {
                interpolation = params["interpolation"];
        }
 
        Randnum * randnum = Randnum::Instance();
        if(params.has_key("seed")) {
                randnum->set_seed((int)params["seed"]);
        }
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
 
        image->ap2ri();
        float *rdata = image->get_data();
 
        size_t k = 0;
        float half_nz = 0;
        if (nz > 1) {
                half_nz = nz / 2.0f;
        }
 
        const float sqrt_2 = sqrt((float) 2);
 
        float r;
        for (int h = 0; h < nz; h++) {
                for (int j = 0; j < ny; j++) {
                        for (int i = 0; i < nx; i += 2, k += 2) {
                                r = (Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz));
//                              r = sqrt(Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz)); // I don't think this sqrt was supposed to be here --steve
                                r = (r - x0) / dx;
                                int l = 0;
                                if (interpolation) {
                                        l = Util::fast_floor(r);
                                }
                                else {
                                        l = Util::fast_floor(r + 0.5f);
                                }
                                r -= l;
                                float f = 0;
                                if (l >= n - 2) {
                                        f = y[n - 1];
                                }
                                else if (l < 0) {
                                        l = 0;
                                }
                                else {
                                        if (interpolation) {
                                                f = (y[l] * (1 - r) + y[l + 1] * r);
                                        }
                                        else {
                                                f = y[l];
                                        }
                                }
                                f = randnum->get_gauss_rand(sqrt(f), sqrt(f) / 3);
                                float a = randnum->get_frand(0.0f, (float)(2 * M_PI));
                                if (i == 0) {
                                        f *= sqrt_2;
                                }
                                rdata[k] += f * cos(a);
                                rdata[k + 1] += f * sin(a);
                        }
                }
        }
 
        image->update();
}

References EMAN::Util::fast_floor(), EMAN::Randnum::get_frand(), EMAN::Randnum::get_gauss_rand(), EMAN::Dict::has_key(), EMAN::Util::hypot3(), ImageFormatException, EMAN::Randnum::Instance(), LOGERR, LOGWARN, EMAN::Processor::params, rdata, EMAN::Randnum::set_seed(), sqrt(), and y.

Member Data Documentation

◆ NAME

const string AddRandomNoiseProcessor::NAME = "math.addspectralnoise"

static

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