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

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

04662                 {
04663                         return "add spectral noise to a complex image.";
04664                 }

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

References NAME.

04640                 {
04641                         return NAME;
04642                 }

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

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

04650                 {
04651                         TypeDict d;
04652                         d.put("n", EMObject::INT);
04653                         d.put("x0", EMObject::FLOAT);
04654                         d.put("dx", EMObject::FLOAT);
04655                         d.put("y", EMObject::FLOATARRAY);
04656                         d.put("interpolation", EMObject::INT);
04657                         d.put("seed", EMObject::INT, "seed for random number generator");
04658                         return d;
04659                 }

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

Definition at line 4644 of file processor.h.

04645                 {
04646                         return new AddRandomNoiseProcessor();
04647                 }

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

05356 {
05357         if (!image) {
05358                 LOGWARN("NULL Image");
05359                 return;
05360         }
05361 
05362         if (!image->is_complex()) {
05363                 LOGERR("AddRandomNoise Processor only works for complex image");
05364                 throw ImageFormatException("only work for complex image");
05365         }
05366 
05367         int n = params["n"];
05368         float x0 = params["x0"];
05369         float dx = params["dx"];
05370         vector < float >y = params["y"];
05371 
05372         int interpolation = 1;
05373         if (params.has_key("interpolation")) {
05374                 interpolation = params["interpolation"];
05375         }
05376 
05377         Randnum * randnum = Randnum::Instance();
05378         if(params.has_key("seed")) {
05379                 randnum->set_seed((int)params["seed"]);
05380         }
05381 
05382         int nx = image->get_xsize();
05383         int ny = image->get_ysize();
05384         int nz = image->get_zsize();
05385 
05386         image->ap2ri();
05387         float *rdata = image->get_data();
05388 
05389         size_t k = 0;
05390         float half_nz = 0;
05391         if (nz > 1) {
05392                 half_nz = nz / 2.0f;
05393         }
05394 
05395         const float sqrt_2 = sqrt((float) 2);
05396 
05397         float r;
05398         for (int h = 0; h < nz; h++) {
05399                 for (int j = 0; j < ny; j++) {
05400                         for (int i = 0; i < nx; i += 2, k += 2) {
05401                                 r = (Util::hypot3(i / 2.0f, j - ny / 2.0f, h - half_nz));
05402 //                              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
05403                                 r = (r - x0) / dx;
05404                                 int l = 0;
05405                                 if (interpolation) {
05406                                         l = Util::fast_floor(r);
05407                                 }
05408                                 else {
05409                                         l = Util::fast_floor(r + 0.5f);
05410                                 }
05411                                 r -= l;
05412                                 float f = 0;
05413                                 if (l >= n - 2) {
05414                                         f = y[n - 1];
05415                                 }
05416                                 else if (l < 0) {
05417                                         l = 0;
05418                                 }
05419                                 else {
05420                                         if (interpolation) {
05421                                                 f = (y[l] * (1 - r) + y[l + 1] * r);
05422                                         }
05423                                         else {
05424                                                 f = y[l];
05425                                         }
05426                                 }
05427                                 f = randnum->get_gauss_rand(sqrt(f), sqrt(f) / 3);
05428                                 float a = randnum->get_frand(0.0f, (float)(2 * M_PI));
05429                                 if (i == 0) {
05430                                         f *= sqrt_2;
05431                                 }
05432                                 rdata[k] += f * cos(a);
05433                                 rdata[k + 1] += f * sin(a);
05434                         }
05435                 }
05436         }
05437 
05438         image->update();
05439 }


Member Data Documentation

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

Definition at line 4666 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue May 25 17:37:32 2010 for EMAN2 by  doxygen 1.4.4