#include <processor.h>
Inheritance diagram for EMAN::ClampingProcessor:
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 | |
static Processor * | NEW () |
Static Public Attributes | |
static const string | NAME = "threshold.clampminmax" |
Protected Attributes | |
float | default_max |
float | default_min |
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 1709 of file processor.h.
EMAN::ClampingProcessor::ClampingProcessor | ( | ) | [inline] |
Definition at line 1712 of file processor.h.
Referenced by NEW().
01712 : default_max(1.0), default_min(0.0) {}
string EMAN::ClampingProcessor::get_desc | ( | ) | const [inline, virtual] |
Get the descrition of this specific processor.
This function must be overwritten by a subclass.
Implements EMAN::Processor.
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 1734 of file processor.h.
01735 { 01736 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."; 01737 }
string EMAN::ClampingProcessor::get_name | ( | ) | const [inline, virtual] |
Get the processor's name.
Each processor is identified by a unique name.
Implements EMAN::Processor.
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 1714 of file processor.h.
References NAME.
01715 { 01716 return NAME; 01717 }
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.
Reimplemented from EMAN::Processor.
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 1725 of file processor.h.
References EMAN::EMObject::BOOL, EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().
01726 { 01727 TypeDict d; 01728 d.put("minval", EMObject::FLOAT, "The pixel values that bounds the smallest pixel value in the output image" ); 01729 d.put("maxval", EMObject::FLOAT, "The pixel values that bounds the largest pixel value in the output image" ); 01730 d.put("tomean", EMObject::BOOL, "Replace outlying pixels values with the mean pixel value instead" ); 01731 return d; 01732 }
static Processor* EMAN::ClampingProcessor::NEW | ( | ) | [inline, static] |
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 1718 of file processor.h.
References ClampingProcessor().
01719 { 01720 return new ClampingProcessor(); 01721 }
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.
image | The image to be processed. |
Implements EMAN::Processor.
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 8899 of file processor.cpp.
References 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::Processor::params, EMAN::Dict::set_default(), and EMAN::EMData::update().
08900 { 08901 08902 if ( image->is_complex() ) throw ImageFormatException("Error: clamping processor does not work on complex images"); 08903 08904 float min = params.set_default("minval",default_min); 08905 float max = params.set_default("maxval",default_max); 08906 bool tomean = params.set_default("tomean",false); 08907 float new_min_vals = min; 08908 float new_max_vals = max; 08909 if (tomean){ 08910 08911 new_min_vals = image->get_attr("mean"); 08912 new_max_vals = image->get_attr("mean"); 08913 } 08914 08915 // Okay, throwing such an error is probably overkill - but atleast the user will get a loud message 08916 // saying what went wrong. 08917 if ( max < min ) throw InvalidParameterException("Error: minval was greater than maxval, aborting"); 08918 08919 size_t size = image->get_size(); 08920 for(size_t i = 0; i < size; ++i ) 08921 { 08922 float * data = &image->get_data()[i]; 08923 if ( *data < min ) *data = new_min_vals; 08924 else if ( *data > max ) *data = new_max_vals; 08925 } 08926 image->update(); 08927 }
float EMAN::ClampingProcessor::default_max [protected] |
float EMAN::ClampingProcessor::default_min [protected] |
const string ClampingProcessor::NAME = "threshold.clampminmax" [static] |
Reimplemented in EMAN::NSigmaClampingProcessor.
Definition at line 1739 of file processor.h.
Referenced by get_name().