EMAN::AddNoiseProcessor Class Reference

add noise to an image More...

#include <processor.h>

Inheritance diagram for EMAN::AddNoiseProcessor:

[legend]

Collaboration diagram for EMAN::AddNoiseProcessor:

[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 TypeDict	get_param_types () const
	Get processor parameter information in a dictionary.
virtual string	get_desc () const
	Get the descrition of this specific processor.
Static Public Member Functions
static Processor *	NEW ()
Protected Member Functions
virtual float	get_sigma (EMData *)

---

Detailed Description

add noise to an image

Parameters:

	noise	noise factor used to generate Gaussian distribution random noise
	seed	seed for random number generator

Definition at line 4274 of file processor.h.

---

Member Function Documentation

void AddNoiseProcessor::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 3900 of file processor.cpp.

References EMAN::EMData::get_data(), EMAN::Randnum::get_gauss_rand(), get_sigma(), EMAN::EMData::get_size(), EMAN::Dict::has_key(), EMAN::Randnum::Instance(), LOGWARN, EMAN::Processor::params, EMAN::Randnum::set_seed(), and EMAN::EMData::update().

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }

        Randnum * randnum = Randnum::Instance();
        if(params.has_key("seed")) {
                randnum->set_seed((int)params["seed"]);
        }

        float addnoise = params["noise"];
        addnoise *= get_sigma(image);
        float *dat = image->get_data();

        for (size_t j = 0; j < image->get_size(); ++j) {
                dat[j] += randnum->get_gauss_rand(addnoise, addnoise / 2);
        }

        image->update();
}

virtual string EMAN::AddNoiseProcessor::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.

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4279 of file processor.h.

                {
                        return "math.addnoise";
                }

static Processor* EMAN::AddNoiseProcessor::NEW

(

)

[inline, static]

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4284 of file processor.h.

                {
                        return new AddNoiseProcessor();
                }

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

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

                {
                        TypeDict d;
                        d.put("noise", EMObject::FLOAT, "noise factor used to generate Gaussian distribution random noise");
                        d.put("seed", EMObject::INT, "seed for random number generator");
                        return d;
                }

virtual string EMAN::AddNoiseProcessor::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.

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4297 of file processor.h.

                {
                        return "add noise to an image, image multiply by noise then add a random value";
                }

virtual float EMAN::AddNoiseProcessor::get_sigma

(

EMData *

)

[inline, protected, virtual]

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4303 of file processor.h.

Referenced by process_inplace().

                {
                        return 1.0;
                }

---

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

• processor.h
• processor.cpp