#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 | |
| Processor * | NEW () |
Static Public Attributes | |
| 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 1668 of file processor.h.
|
|
Definition at line 1671 of file processor.h. 01671 : default_max(1.0), default_min(0.0) {}
|
|
|
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 1693 of file processor.h. 01694 {
01695 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.";
01696 }
|
|
|
Get the processor's name. Each processor is identified by a unique name.
Implements EMAN::Processor. Reimplemented in EMAN::NSigmaClampingProcessor. Definition at line 1673 of file processor.h. 01674 {
01675 return NAME;
01676 }
|
|
|
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 1684 of file processor.h. References EMAN::TypeDict::put(). 01685 {
01686 TypeDict d;
01687 d.put("minval", EMObject::FLOAT, "The pixel values that bounds the smallest pixel value in the output image" );
01688 d.put("maxval", EMObject::FLOAT, "The pixel values that bounds the largest pixel value in the output image" );
01689 d.put("tomean", EMObject::BOOL, "Replace outlying pixels values with the mean pixel value instead" );
01690 return d;
01691 }
|
|
|
Reimplemented in EMAN::NSigmaClampingProcessor. Definition at line 1677 of file processor.h. 01678 {
01679 return new ClampingProcessor();
01680 }
|
|
|
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.
Implements EMAN::Processor. Reimplemented in EMAN::NSigmaClampingProcessor. Definition at line 8741 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(). 08742 {
08743
08744 if ( image->is_complex() ) throw ImageFormatException("Error: clamping processor does not work on complex images");
08745
08746 float min = params.set_default("minval",default_min);
08747 float max = params.set_default("maxval",default_max);
08748 bool tomean = params.set_default("tomean",false);
08749 float new_min_vals = min;
08750 float new_max_vals = max;
08751 if (tomean){
08752
08753 new_min_vals = image->get_attr("mean");
08754 new_max_vals = image->get_attr("mean");
08755 }
08756
08757 // Okay, throwing such an error is probably overkill - but atleast the user will get a loud message
08758 // saying what went wrong.
08759 if ( max < min ) throw InvalidParameterException("Error: minval was greater than maxval, aborting");
08760
08761 size_t size = image->get_size();
08762 for(size_t i = 0; i < size; ++i )
08763 {
08764 float * data = &image->get_data()[i];
08765 if ( *data < min ) *data = new_min_vals;
08766 else if ( *data > max ) *data = new_max_vals;
08767 }
08768 image->update();
08769 }
|
|
|
Definition at line 1701 of file processor.h. Referenced by process_inplace(). |
|
|
Definition at line 1701 of file processor.h. Referenced by process_inplace(). |
|
|
Reimplemented in EMAN::NSigmaClampingProcessor. Definition at line 96 of file processor.cpp. |
1.3.9.1