Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::AddNoiseProcessor Class Reference

add noise to an image More...

#include <processor.h>

Inheritance diagram for EMAN::AddNoiseProcessor:

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

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 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

ProcessorNEW ()

Static Public Attributes

const string NAME = "math.addnoise"

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


Member Function Documentation

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

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

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

04648                 {
04649                         return NAME;
04650                 }

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

References EMAN::TypeDict::put().

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

virtual float EMAN::AddNoiseProcessor::get_sigma EMData  )  [inline, protected, virtual]
 

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4673 of file processor.h.

Referenced by process_inplace().

04674                 {
04675                         return 1.0;
04676                 }

Processor* EMAN::AddNoiseProcessor::NEW  )  [inline, static]
 

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 4652 of file processor.h.

04653                 {
04654                         return new AddNoiseProcessor();
04655                 }

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 4489 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::Randnum::set_seed(), and EMAN::EMData::update().

04490 {
04491         if (!image) {
04492                 LOGWARN("NULL Image");
04493                 return;
04494         }
04495 
04496         Randnum * randnum = Randnum::Instance();
04497         if(params.has_key("seed")) {
04498                 randnum->set_seed((int)params["seed"]);
04499         }
04500 
04501         float addnoise = params["noise"];
04502         addnoise *= get_sigma(image);
04503         float *dat = image->get_data();
04504 
04505         for (size_t j = 0; j < image->get_size(); ++j) {
04506                 dat[j] += randnum->get_gauss_rand(addnoise, addnoise / 2);
04507         }
04508 
04509         image->update();
04510 }


Member Data Documentation

const string AddNoiseProcessor::NAME = "math.addnoise" [static]
 

Reimplemented in EMAN::AddSigmaNoiseProcessor.

Definition at line 159 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Fri Aug 10 16:37:25 2012 for EMAN2 by  doxygen 1.3.9.1