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

EMAN::ToMinvalProcessor Class Reference

f(x) = x if x >= minval; f(x) = minval if x < minval More...

#include <processor.h>

Inheritance diagram for EMAN::ToMinvalProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
void process_inplace (EMData *image)
 To process an image in-place.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

ProcessorNEW ()

Static Public Attributes

const string NAME = "threshold.belowtominval"

Detailed Description

f(x) = x if x >= minval; f(x) = minval if x < minval

Parameters:
minval Everything below this value is set to this value

Definition at line 1529 of file processor.h.


Member Function Documentation

string EMAN::ToMinvalProcessor::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 1551 of file processor.h.

01552                 {
01553                         return "f(x) = x if x >= minval; f(x) = minval|newval if x < minval.";
01554                 }

string EMAN::ToMinvalProcessor::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 1532 of file processor.h.

01533                 {
01534                         return NAME;
01535                 }

TypeDict EMAN::ToMinvalProcessor::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 1543 of file processor.h.

References EMAN::TypeDict::put().

01544                 {
01545                         TypeDict d;
01546                         d.put("minval", EMObject::FLOAT, "Everything below this value is set to this value");
01547                         d.put("newval", EMObject::FLOAT, "If set, values below minval will be set to newval instead of minval ");
01548                         return d;
01549                 }

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

Definition at line 1536 of file processor.h.

01537                 {
01538                         return new ToMinvalProcessor();
01539                 }

void ToMinvalProcessor::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 1450 of file processor.cpp.

References data, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), LOGWARN, EMAN::Dict::set_default(), and EMAN::EMData::update().

01451 {
01452         if (!image) {
01453                 LOGWARN("NULL Image");
01454                 return;
01455         }
01456 
01457         float minval = params.set_default("minval",0.0f);
01458         float newval = params.set_default("newval",minval);
01459 
01460         size_t size = (size_t)image->get_xsize() *
01461                           (size_t)image->get_ysize() *
01462                           (size_t)image->get_zsize();
01463         float *data = image->get_data();
01464 
01465 
01466 
01467         for (size_t i = 0; i < size; i++) {
01468                 if (data[i]<minval) data[i]=newval;
01469         }
01470         image->update();
01471 }


Member Data Documentation

const string ToMinvalProcessor::NAME = "threshold.belowtominval" [static]
 

Definition at line 87 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:45 2010 for EMAN2 by  doxygen 1.3.9.1