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:

[legend]

Collaboration diagram for EMAN::ClampingProcessor:

[legend]

List of all members.

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 ()
Protected Attributes
float	default_max
float	default_min

---

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 Replace outlying pixels values with the mean pixel value instead

Definition at line 1492 of file processor.h.

---

Constructor & Destructor Documentation

EMAN::ClampingProcessor::ClampingProcessor

(

)

[inline]

Definition at line 1495 of file processor.h.

Referenced by NEW().

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

---

Member Function Documentation

string EMAN::ClampingProcessor::get_name

(

)

const [inline, virtual]

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

                {
                        return "threshold.clampminmax";
                }

static Processor* EMAN::ClampingProcessor::NEW

(

)

[inline, static]

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1501 of file processor.h.

References ClampingProcessor().

                {
                        return new ClampingProcessor();
                }

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 8234 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().

{

        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);
        float new_min_vals = min;
        float new_max_vals = max;
        if (tomean){

                new_min_vals = image->get_attr("mean");
                new_max_vals = image->get_attr("mean");
        }

        // 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();
}

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.

Returns:

A dictionary containing the parameter info.

Reimplemented from EMAN::Processor.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1508 of file processor.h.

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

                {
                        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" );
                        return d;
                }

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

Implements EMAN::Processor.

Reimplemented in EMAN::NSigmaClampingProcessor.

Definition at line 1517 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.";
                }

---

Member Data Documentation

float EMAN::ClampingProcessor::default_max [protected]

Definition at line 1523 of file processor.h.

Referenced by process_inplace().

float EMAN::ClampingProcessor::default_min [protected]

Definition at line 1523 of file processor.h.

Referenced by process_inplace().

---

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

• processor.h
• processor.cpp