EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all 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]

Public Member Functions

 ClampingProcessor ()
 
string get_name () const
 Get the processor's name. More...
 
void process_inplace (EMData *image)
 To process an image in-place. More...
 
TypeDict get_param_types () const
 Get processor parameter information in a dictionary. More...
 
string get_desc () const
 Get the descrition of this specific processor. More...
 
- Public Member Functions inherited from EMAN::Processor
virtual ~Processor ()
 
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place. More...
 
virtual void process_list_inplace (vector< EMData * > &images)
 To process multiple images using the same algorithm. More...
 
virtual Dict get_params () const
 Get the processor parameters in a key/value dictionary. More...
 
virtual void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. More...
 

Static Public Member Functions

static ProcessorNEW ()
 
- Static Public Member Functions inherited from EMAN::Processor
static string get_group_desc ()
 Get the description of this group of processors. More...
 
static void EMFourierFilterInPlace (EMData *fimage, Dict params)
 Compute a Fourier-filter processed image in place. More...
 
static EMDataEMFourierFilter (EMData *fimage, Dict params)
 Compute a Fourier-processor processed image without altering the original image. More...
 

Static Public Attributes

static const string NAME = "threshold.clampminmax"
 

Protected Attributes

float default_max
 
float default_min
 
- Protected Attributes inherited from EMAN::Processor
Dict params
 

Additional Inherited Members

- Public Types inherited from EMAN::Processor
enum  fourier_filter_types {
  TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,
  GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,
  GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,
  KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,
  SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,
  TANH_BAND_PASS , RADIAL_TABLE , CTF_
}
 Fourier filter Processor type enum. More...
 

Detailed Description

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

Parameters
minvalthe minimum value to clamp to
maxvalthe maximum value to clamp to @tomean Replace outlying pixels values with the mean pixel value instead

Definition at line 3032 of file processor.h.

Constructor & Destructor Documentation

◆ ClampingProcessor()

EMAN::ClampingProcessor::ClampingProcessor ( )
inline

Definition at line 3035 of file processor.h.

Referenced by NEW().

Member Function Documentation

◆ get_desc()

string EMAN::ClampingProcessor::get_desc ( ) const
inlinevirtual

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

3059 {
3060 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.";
3061 }

◆ get_name()

string EMAN::ClampingProcessor::get_name ( ) const
inlinevirtual

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

3038 {
3039 return NAME;
3040 }
static const string NAME
Definition: processor.h:3063

References NAME.

◆ get_param_types()

TypeDict EMAN::ClampingProcessor::get_param_types ( ) const
inlinevirtual

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

3049 {
3050 TypeDict d;
3051 d.put("minval", EMObject::FLOAT, "The pixel values that bounds the smallest pixel value in the output image" );
3052 d.put("maxval", EMObject::FLOAT, "The pixel values that bounds the largest pixel value in the output image" );
3053 d.put("tomean", EMObject::BOOL, "Replace outlying pixels values with the mean pixel value instead" );
3054 d.put("tozero", EMObject::BOOL, "Replace outlying pixels values with zero" );
3055 return d;
3056 }
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305
void put(const string &key, EMObject::ObjectType o, const string &desc="")
Definition: emobject.h:330

References EMAN::EMObject::BOOL, EMAN::EMObject::FLOAT, and EMAN::TypeDict::put().

◆ NEW()

static Processor * EMAN::ClampingProcessor::NEW ( )
inlinestatic

Definition at line 3041 of file processor.h.

3042 {
3043 return new ClampingProcessor();
3044 }

References ClampingProcessor().

◆ process_inplace()

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
imageThe image to be processed.

Implements EMAN::Processor.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 12210 of file processor.cpp.

12211{
12212
12213 if ( image->is_complex() ) throw ImageFormatException("Error: clamping processor does not work on complex images");
12214
12215 float min = params.set_default("minval",default_min);
12216 float max = params.set_default("maxval",default_max);
12217 bool tomean = params.set_default("tomean",false);
12218 bool tozero = params.set_default("tozero",false);
12219 float new_min_vals = min;
12220 float new_max_vals = max;
12221 if (tomean) new_min_vals = new_max_vals = image->get_attr("mean");
12222 if (tozero) new_min_vals = new_max_vals = 0.0;
12223
12224 // Okay, throwing such an error is probably overkill - but atleast the user will get a loud message
12225 // saying what went wrong.
12226 if ( max < min ) throw InvalidParameterException("Error: minval was greater than maxval, aborting");
12227
12228 size_t size = image->get_size();
12229 for(size_t i = 0; i < size; ++i )
12230 {
12231 float * data = &image->get_data()[i];
12232 if ( *data < min ) *data = new_min_vals;
12233 else if ( *data > max ) *data = new_max_vals;
12234 }
12235 image->update();
12236}
type set_default(const string &key, type val)
Default setting behavior This can be achieved using a template - d.woolford Jan 2008 (before there wa...
Definition: emobject.h:569
#define InvalidParameterException(desc)
Definition: exception.h:361
#define ImageFormatException(desc)
Definition: exception.h:147

References default_max, default_min, ImageFormatException, InvalidParameterException, EMAN::Processor::params, and EMAN::Dict::set_default().

Referenced by EMAN::NSigmaClampingProcessor::process_inplace().

Member Data Documentation

◆ default_max

float EMAN::ClampingProcessor::default_max
protected

Definition at line 3066 of file processor.h.

Referenced by process_inplace().

◆ default_min

float EMAN::ClampingProcessor::default_min
protected

Definition at line 3066 of file processor.h.

Referenced by process_inplace().

◆ NAME

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

Definition at line 3063 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files: