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

01767                 {
01768                         return "f(x) = x if x >= minval; f(x) = minval|newval if x < minval.";
01769                 }

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

01748                 {
01749                         return NAME;
01750                 }

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

References EMAN::TypeDict::put().

01759                 {
01760                         TypeDict d;
01761                         d.put("minval", EMObject::FLOAT, "Everything below this value is set to this value");
01762                         d.put("newval", EMObject::FLOAT, "If set, values below minval will be set to newval instead of minval ");
01763                         return d;
01764                 }

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

Definition at line 1751 of file processor.h.

01752                 {
01753                         return new ToMinvalProcessor();
01754                 }

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

01506 {
01507         if (!image) {
01508                 LOGWARN("NULL Image");
01509                 return;
01510         }
01511 
01512         float minval = params.set_default("minval",0.0f);
01513         float newval = params.set_default("newval",minval);
01514 
01515         size_t size = (size_t)image->get_xsize() *
01516                           (size_t)image->get_ysize() *
01517                           (size_t)image->get_zsize();
01518         float *data = image->get_data();
01519 
01520 
01521 
01522         for (size_t i = 0; i < size; ++i) {
01523                 if (data[i]<minval) data[i]=newval;
01524         }
01525         image->update();
01526 }


Member Data Documentation

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

Definition at line 92 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:45:57 2011 for EMAN2 by  doxygen 1.3.9.1