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

#include <processor.h>

Inheritance diagram for EMAN::ClampingProcessor:

Collaboration diagram for EMAN::ClampingProcessor:

[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 EMData *	process (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 Processor *	NEW ()

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 EMData *	EMFourierFilter (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

minval	the minimum value to clamp to
maxval	the 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.

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

EMAN::ClampingProcessor::default_min

float default_min

Definition: processor.h:3066

EMAN::ClampingProcessor::default_max

float default_max

Definition: processor.h:3066

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.

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

◆ 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.

                {
                        return NAME;
                }

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.

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

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.

                {
                        return new ClampingProcessor();
                }

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

image The image to be processed.

Implements EMAN::Processor.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 12210 of file processor.cpp.

{
 
        if ( image->is_complex() ) throw ImageFormatException("Error: clamping processor does not work on complex images");
 
        float min = params.set_default("minval",default_min);
        float max = params.set_default("maxval",default_max);
        bool tomean = params.set_default("tomean",false);
        bool tozero = params.set_default("tozero",false);
        float new_min_vals = min;
        float new_max_vals = max;
        if (tomean) new_min_vals = new_max_vals = image->get_attr("mean");
        if (tozero) new_min_vals = new_max_vals = 0.0;
 
        // Okay, throwing such an error is probably overkill - but atleast the user will get a loud message
        // saying what went wrong.
        if ( max < min ) throw InvalidParameterException("Error: minval was greater than maxval, aborting");
 
        size_t size = image->get_size();
        for(size_t i = 0; i < size; ++i )
        {
                float * data = &image->get_data()[i];
                if ( *data < min ) *data = new_min_vals;
                else if ( *data > max ) *data = new_max_vals;
        }
        image->update();
}

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:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClampingProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ default_max

◆ default_min

◆ NAME