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

EMAN::NSigmaClampingProcessor Class Reference

This function clamps the min and max vals in the image at minval and maxval at mean-n*sigma and mean+n*sigma, respectively. More...

#include <processor.h>

Inheritance diagram for EMAN::NSigmaClampingProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Member Functions

ProcessorNEW ()

Static Public Attributes

const string NAME = "threshold.clampminmax.nsigma"

Protected Attributes

float default_sigma

Detailed Description

This function clamps the min and max vals in the image at minval and maxval at mean-n*sigma and mean+n*sigma, respectively.

The parameter specified by the user is n, the default value of n is 2.

Parameters:
nsigma The number (n) of sigmas to clamp min and max vals at, so that the clamped boundaries are mean-n*sigma and mean+n*sigma
tomean Replace outlying pixels values with the mean pixel value instead

Definition at line 1705 of file processor.h.


Constructor & Destructor Documentation

EMAN::NSigmaClampingProcessor::NSigmaClampingProcessor  )  [inline]
 

Definition at line 1708 of file processor.h.

01708 : default_sigma(2.0) {}


Member Function Documentation

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

Reimplemented from EMAN::ClampingProcessor.

Definition at line 1730 of file processor.h.

01731                         {
01732                                 return "This function clamps the min and max vals in the image at minval and maxval at mean-n*sigma and mean+n*sigma, respectively. The parameter specified by the user is n, the default value of n is 2.";
01733                         }

string EMAN::NSigmaClampingProcessor::get_name  )  const [inline, virtual]
 

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Reimplemented from EMAN::ClampingProcessor.

Definition at line 1710 of file processor.h.

01711                         {
01712                                 return NAME;
01713                         }

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

Definition at line 1720 of file processor.h.

References EMAN::TypeDict::put().

01721                         {
01722                                 TypeDict d;
01723                                 d.put("nsigma", EMObject::FLOAT, "The number (n) of sigmas to clamp min and max vals at, so that the clamped boundaries are mean-n*sigma and mean+n*sigma" );
01724                                 d.put("tomean", EMObject::BOOL, "Replace outlying pixels values with the mean pixel value instead" );
01725                                 return d;
01726                         }

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

Reimplemented from EMAN::ClampingProcessor.

Definition at line 1715 of file processor.h.

01716                         {
01717                                 return new NSigmaClampingProcessor();
01718                         }

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

Reimplemented from EMAN::ClampingProcessor.

Definition at line 9243 of file processor.cpp.

References default_sigma, EMAN::EMData::get_attr(), process_inplace(), and EMAN::Dict::set_default().

09244 {
09245         float nsigma = params.set_default("nsigma",default_sigma);
09246         float sigma = image->get_attr("sigma");
09247         float mean = image->get_attr("mean");
09248         params.set_default("minval",mean - nsigma*sigma);
09249         params.set_default("maxval",mean + nsigma*sigma);
09250 
09251         ClampingProcessor::process_inplace(image);
09252 }


Member Data Documentation

float EMAN::NSigmaClampingProcessor::default_sigma [protected]
 

Definition at line 1738 of file processor.h.

Referenced by process_inplace().

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

Reimplemented from EMAN::ClampingProcessor.

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