EMAN::AddRandomNoiseProcessor Class Reference

add spectral noise to a complex image More...

#include <processor.h>

Inheritance diagram for EMAN::AddRandomNoiseProcessor:

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

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

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "math.addspectralnoise"

Detailed Description

add spectral noise to a complex image

Parameters:
n 
x0 
dx 
y 
interpolation 
seed seed for random number generator

Definition at line 4713 of file processor.h.


Member Function Documentation

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

04741                 {
04742                         return "add spectral noise to a complex image.";
04743                 }

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

References NAME.

04719                 {
04720                         return NAME;
04721                 }

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

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

04729                 {
04730                         TypeDict d;
04731                         d.put("n", EMObject::INT);
04732                         d.put("x0", EMObject::FLOAT);
04733                         d.put("dx", EMObject::FLOAT);
04734                         d.put("y", EMObject::FLOATARRAY);
04735                         d.put("interpolation", EMObject::INT);
04736                         d.put("seed", EMObject::INT, "seed for random number generator");
04737                         return d;
04738                 }

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

Definition at line 4723 of file processor.h.

04724                 {
04725                         return new AddRandomNoiseProcessor();
04726                 }

void AddRandomNoiseProcessor::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 5571 of file processor.cpp.

References EMAN::EMData::ap2ri(), EMAN::Util::fast_floor(), EMAN::EMData::get_data(), EMAN::Randnum::get_frand(), EMAN::Randnum::get_gauss_rand(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::Dict::has_key(), EMAN::Util::hypot3(), ImageFormatException, EMAN::Randnum::Instance(), EMAN::EMData::is_complex(), LOGERR, LOGWARN, EMAN::Processor::params, rdata, EMAN::Randnum::set_seed(), sqrt(), and EMAN::EMData::update().

05572 {
05573         if (!image) {
05574                 LOGWARN("NULL Image");
05575                 return;
05576         }
05577 
05578         if (!image->is_complex()) {
05579                 LOGERR("AddRandomNoise Processor only works for complex image");
05580                 throw ImageFormatException("only work for complex image");
05581         }
05582 
05583         int n = params["n"];
05584         float x0 = params["x0"];
05585         float dx = params["dx"];
05586         vector < float >y = params["y"];
05587 
05588         int interpolation = 1;
05589         if (params.has_key("interpolation")) {
05590                 interpolation = params["interpolation"];
05591         }
05592 
05593         Randnum * randnum = Randnum::Instance();
05594         if(params.has_key("seed")) {
05595                 randnum->set_seed((int)params["seed"]);
05596         }
05597 
05598         int nx = image->get_xsize();
05599         int ny = image->get_ysize();
05600         int nz = image->get_zsize();
05601 
05602         image->ap2ri();
05603         float *rdata = image->get_data();
05604 
05605         size_t k = 0;
05606         float half_nz = 0;
05607         if (nz > 1) {
05608                 half_nz = nz / 2.0f;
05609         }
05610 
05611         const float sqrt_2 = sqrt((float) 2);
05612 
05613         float r;
05614         for (int h = 0; h < nz; h++) {
05615                 for (int j = 0; j < ny; j++) {
05616                         for (int i = 0; i < nx; i += 2, k += 2) {
05617                                 r = (Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz));
05618 //                              r = sqrt(Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz)); // I don't think this sqrt was supposed to be here --steve
05619                                 r = (r - x0) / dx;
05620                                 int l = 0;
05621                                 if (interpolation) {
05622                                         l = Util::fast_floor(r);
05623                                 }
05624                                 else {
05625                                         l = Util::fast_floor(r + 0.5f);
05626                                 }
05627                                 r -= l;
05628                                 float f = 0;
05629                                 if (l >= n - 2) {
05630                                         f = y[n - 1];
05631                                 }
05632                                 else if (l < 0) {
05633                                         l = 0;
05634                                 }
05635                                 else {
05636                                         if (interpolation) {
05637                                                 f = (y[l] * (1 - r) + y[l + 1] * r);
05638                                         }
05639                                         else {
05640                                                 f = y[l];
05641                                         }
05642                                 }
05643                                 f = randnum->get_gauss_rand(sqrt(f), sqrt(f) / 3);
05644                                 float a = randnum->get_frand(0.0f, (float)(2 * M_PI));
05645                                 if (i == 0) {
05646                                         f *= sqrt_2;
05647                                 }
05648                                 rdata[k] += f * cos(a);
05649                                 rdata[k + 1] += f * sin(a);
05650                         }
05651                 }
05652         }
05653 
05654         image->update();
05655 }


Member Data Documentation

const string AddRandomNoiseProcessor::NAME = "math.addspectralnoise" [static]

Definition at line 4745 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:10:31 2012 for EMAN2 by  doxygen 1.4.7