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:

Inheritance graph
[legend]
Collaboration diagram for EMAN::TestImageNoiseUniformRand:

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.uniform.rand"

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 6413 of file processor.h.


Member Function Documentation

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 6423 of file processor.h.

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

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 6418 of file processor.h.

References NAME.

06419                 {
06420                         return NAME;
06421                 }

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 6433 of file processor.h.

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

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

static Processor* EMAN::TestImageNoiseUniformRand::NEW (  )  [inline, static]

Definition at line 6428 of file processor.h.

06429                 {
06430                         return new TestImageNoiseUniformRand();
06431                 }

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 7735 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().

07736 {
07737         preprocess(image);
07738 
07739         Randnum * r = Randnum::Instance();
07740         if(params.has_key("seed")) {
07741                 r->set_seed((int)params["seed"]);
07742         }
07743 
07744         float *dat = image->get_data();
07745         size_t size = (size_t)nx*ny*nz;
07746         for (size_t i=0; i<size; ++i) {
07747                 dat[i] = r->get_frand();
07748         }
07749 
07750         image->update();
07751 }


Member Data Documentation

const string TestImageNoiseUniformRand::NAME = "testimage.noise.uniform.rand" [static]

Definition at line 6440 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon May 2 13:31:08 2011 for EMAN2 by  doxygen 1.4.7