EMAN::TestImageNoiseUniformRand Class Reference

Replace a source image as a uniform random noise, random number generated from gsl_rng_mt19937, the pixel value is from 0 to 1, [0, 1). More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageNoiseUniformRand:

[legend]

Collaboration diagram for EMAN::TestImageNoiseUniformRand:

[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 Processor *	NEW ()

---

Detailed Description

Replace a source image as a uniform random noise, random number generated from gsl_rng_mt19937, the pixel value is from 0 to 1, [0, 1).

Parameters:

seed

seed for random number generator

Definition at line 6057 of file processor.h.

---

Member Function Documentation

void TestImageNoiseUniformRand::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 7248 of file processor.cpp.

References EMAN::EMData::get_data(), EMAN::Randnum::get_frand(), EMAN::Dict::has_key(), EMAN::Randnum::Instance(), EMAN::Processor::params, EMAN::TestImageProcessor::preprocess(), EMAN::Randnum::set_seed(), and EMAN::EMData::update().

{
        preprocess(image);

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

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

        image->update();
}

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

                {
                        return "testimage.noise.uniform.rand";
                }

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

                {
                        return "Replace a source image as a uniform random noise, random number generated from gsl_rng_mt19937, the pixel value is [0, 1)";
                }

static Processor* EMAN::TestImageNoiseUniformRand::NEW

(

)

[inline, static]

Definition at line 6072 of file processor.h.

                {
                        return new TestImageNoiseUniformRand();
                }

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

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

                {
                        TypeDict d;
                        d.put("seed", EMObject::INT, "seed for random number generator");
                        return d;
                }

---

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

• processor.h
• processor.cpp