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

EMAN::ClampingProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::ClampingProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ClampingProcessor ()
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.clampminmax"

Protected Attributes

float default_max
float default_min

Detailed Description

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

Parameters:
minval the minimum value to clamp to
maxval the maximum value to clamp to Replace outlying pixels values with the mean pixel value instead

Definition at line 1449 of file processor.h.


Constructor & Destructor Documentation

EMAN::ClampingProcessor::ClampingProcessor  )  [inline]
 

Definition at line 1452 of file processor.h.

01452 : default_max(1.0), default_min(0.0) {}


Member Function Documentation

string EMAN::ClampingProcessor::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.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1474 of file processor.h.

01475                 {
01476                         return "This function clamps the min and max vals in the image at minval and maxval, respectively. In a sense this a bi-truncation of the data.";
01477                 }

string EMAN::ClampingProcessor::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.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1454 of file processor.h.

01455                 {
01456                         return NAME;
01457                 }

TypeDict EMAN::ClampingProcessor::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.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1465 of file processor.h.

References EMAN::TypeDict::put().

01466                 {
01467                         TypeDict d;
01468                         d.put("minval", EMObject::FLOAT, "The pixel values that bounds the smallest pixel value in the output image" );
01469                         d.put("maxval", EMObject::FLOAT, "The pixel values that bounds the largest pixel value in the output image" );
01470                         d.put("tomean", EMObject::BOOL, "Replace outlying pixels values with the mean pixel value instead" );
01471                         return d;
01472                 }

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

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1458 of file processor.h.

01459                 {
01460                         return new ClampingProcessor();
01461                 }

void ClampingProcessor::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.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 8662 of file processor.cpp.

References data, default_max, default_min, EMAN::EMData::get_attr(), EMAN::EMData::get_data(), EMAN::EMData::get_size(), ImageFormatException, InvalidParameterException, EMAN::EMData::is_complex(), max, min, EMAN::Dict::set_default(), and EMAN::EMData::update().

08663 {
08664 
08665         if ( image->is_complex() ) throw ImageFormatException("Error: clamping processor does not work on complex images");
08666 
08667         float min = params.set_default("minval",default_min);
08668         float max = params.set_default("maxval",default_max);
08669         bool tomean = params.set_default("tomean",false);
08670         float new_min_vals = min;
08671         float new_max_vals = max;
08672         if (tomean){
08673 
08674                 new_min_vals = image->get_attr("mean");
08675                 new_max_vals = image->get_attr("mean");
08676         }
08677 
08678         // Okay, throwing such an error is probably overkill - but atleast the user will get a loud message
08679         // saying what went wrong.
08680         if ( max < min ) throw InvalidParameterException("Error: minval was greater than maxval, aborting");
08681 
08682         size_t size = image->get_size();
08683         for(size_t i = 0; i < size; ++i )
08684         {
08685                 float * data = &image->get_data()[i];
08686                 if ( *data < min ) *data = new_min_vals;
08687                 else if ( *data > max ) *data = new_max_vals;
08688         }
08689         image->update();
08690 }


Member Data Documentation

float EMAN::ClampingProcessor::default_max [protected]
 

Definition at line 1482 of file processor.h.

Referenced by process_inplace().

float EMAN::ClampingProcessor::default_min [protected]
 

Definition at line 1482 of file processor.h.

Referenced by process_inplace().

const string ClampingProcessor::NAME = "threshold.clampminmax" [static]
 

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 85 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