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 = "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 4674 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 4701 of file processor.h.

04702                 {
04703                         return "add spectral noise to a complex image.";
04704                 }

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

References NAME.

04680                 {
04681                         return NAME;
04682                 }

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

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

04690                 {
04691                         TypeDict d;
04692                         d.put("n", EMObject::INT);
04693                         d.put("x0", EMObject::FLOAT);
04694                         d.put("dx", EMObject::FLOAT);
04695                         d.put("y", EMObject::FLOATARRAY);
04696                         d.put("interpolation", EMObject::INT);
04697                         d.put("seed", EMObject::INT, "seed for random number generator");
04698                         return d;
04699                 }

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

Definition at line 4684 of file processor.h.

04685                 {
04686                         return new AddRandomNoiseProcessor();
04687                 }

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

05463 {
05464         if (!image) {
05465                 LOGWARN("NULL Image");
05466                 return;
05467         }
05468 
05469         if (!image->is_complex()) {
05470                 LOGERR("AddRandomNoise Processor only works for complex image");
05471                 throw ImageFormatException("only work for complex image");
05472         }
05473 
05474         int n = params["n"];
05475         float x0 = params["x0"];
05476         float dx = params["dx"];
05477         vector < float >y = params["y"];
05478 
05479         int interpolation = 1;
05480         if (params.has_key("interpolation")) {
05481                 interpolation = params["interpolation"];
05482         }
05483 
05484         Randnum * randnum = Randnum::Instance();
05485         if(params.has_key("seed")) {
05486                 randnum->set_seed((int)params["seed"]);
05487         }
05488 
05489         int nx = image->get_xsize();
05490         int ny = image->get_ysize();
05491         int nz = image->get_zsize();
05492 
05493         image->ap2ri();
05494         float *rdata = image->get_data();
05495 
05496         size_t k = 0;
05497         float half_nz = 0;
05498         if (nz > 1) {
05499                 half_nz = nz / 2.0f;
05500         }
05501 
05502         const float sqrt_2 = sqrt((float) 2);
05503 
05504         float r;
05505         for (int h = 0; h < nz; h++) {
05506                 for (int j = 0; j < ny; j++) {
05507                         for (int i = 0; i < nx; i += 2, k += 2) {
05508                                 r = (Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz));
05509 //                              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
05510                                 r = (r - x0) / dx;
05511                                 int l = 0;
05512                                 if (interpolation) {
05513                                         l = Util::fast_floor(r);
05514                                 }
05515                                 else {
05516                                         l = Util::fast_floor(r + 0.5f);
05517                                 }
05518                                 r -= l;
05519                                 float f = 0;
05520                                 if (l >= n - 2) {
05521                                         f = y[n - 1];
05522                                 }
05523                                 else if (l < 0) {
05524                                         l = 0;
05525                                 }
05526                                 else {
05527                                         if (interpolation) {
05528                                                 f = (y[l] * (1 - r) + y[l + 1] * r);
05529                                         }
05530                                         else {
05531                                                 f = y[l];
05532                                         }
05533                                 }
05534                                 f = randnum->get_gauss_rand(sqrt(f), sqrt(f) / 3);
05535                                 float a = randnum->get_frand(0.0f, (float)(2 * M_PI));
05536                                 if (i == 0) {
05537                                         f *= sqrt_2;
05538                                 }
05539                                 rdata[k] += f * cos(a);
05540                                 rdata[k + 1] += f * sin(a);
05541                         }
05542                 }
05543         }
05544 
05545         image->update();
05546 }


Member Data Documentation

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

Definition at line 4706 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:43:49 2010 for EMAN2 by  doxygen 1.4.7