EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::TestImageNoiseGauss Class Reference

Replace a source image with gaussian distributed random noise If you don't provide a seed at all, it should be seeded using the best available source of randomness( time(0) in this implementation). More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageNoiseGauss:
Inheritance graph
[legend]
Collaboration diagram for EMAN::TestImageNoiseGauss:
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.noise.gauss"

Detailed Description

Replace a source image with gaussian distributed random noise If you don't provide a seed at all, it should be seeded using the best available source of randomness( time(0) in this implementation).

The testimage classes using random numbers should take an int 'seed' parameter. If this parameter is provided, it will be cast into an unsigned int. This will permit initialization to a known state if desired.

Parameters:
sigmasigma value of gausian distributed noise, default is 0.5
meanmean value of gausian distributed noise, default is zero
seedmean value of gausian distributed noise, default is zero

Definition at line 6980 of file processor.h.


Member Function Documentation

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

                {
                        return "Replace a source image as a random noise, the random value is gaussian distributed";
                }
virtual string EMAN::TestImageNoiseGauss::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 6985 of file processor.h.

References NAME.

                {
                        return NAME;
                }
virtual TypeDict EMAN::TestImageNoiseGauss::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 7000 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("sigma", EMObject::FLOAT, "sigma value of gausian distributed noise, default is 0.5");
                        d.put("mean", EMObject::FLOAT, "mean value of gausian distributed noise, default is zero.");
                        d.put("seed", EMObject::INT, "the seed for random number generator, default is not to reseed.");

                        return d;
                }
static Processor* EMAN::TestImageNoiseGauss::NEW ( ) [inline, static]

Definition at line 6995 of file processor.h.

                {
                        return new TestImageNoiseGauss();
                }
void TestImageNoiseGauss::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 8457 of file processor.cpp.

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

{
        preprocess(image);

        float sigma = params["sigma"];
        if (sigma<=0) { sigma = 1.0; }
        float mean = params["mean"];

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

        float *dat = image->get_data();
        size_t size = (size_t)nx*ny*nz;
        for (size_t i=0; i<size; ++i) {
                dat[i] = r->get_gauss_rand(mean, sigma);
        }

        image->update();
}

Member Data Documentation

const string TestImageNoiseGauss::NAME = "testimage.noise.gauss" [static]

Definition at line 7010 of file processor.h.

Referenced by get_name().


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