EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
EMAN::CollapseProcessor Class Reference

f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r More...

#include <processor.h>

Inheritance diagram for EMAN::CollapseProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::CollapseProcessor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.
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 ProcessorNEW ()

Static Public Attributes

static const string NAME = "threshold.compress"

Protected Member Functions

void process_pixel (float *x) const

Protected Attributes

float range

Detailed Description

f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r

Parameters:
rangeThe range about 'value' which will be collapsed to 'value'
valueThe pixel value where the focus of the collapse operation is

Definition at line 2083 of file processor.h.


Member Function Documentation

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

Definition at line 2110 of file processor.h.

                {
                        return "f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r";
                }
string EMAN::CollapseProcessor::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.

Definition at line 2086 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::CollapseProcessor::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.

Definition at line 2102 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("range", EMObject::FLOAT, "The range about 'value' which will be collapsed to 'value'");
                        d.put("value", EMObject::FLOAT, "The pixel value where the focus of the collapse operation is");
                        return d;
                }
static Processor* EMAN::CollapseProcessor::NEW ( ) [inline, static]

Definition at line 2090 of file processor.h.

                {
                        return new CollapseProcessor();
                }
void EMAN::CollapseProcessor::process_pixel ( float *  x) const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 2118 of file processor.h.

References range, and EMAN::RealPixelProcessor::value.

                {
                        if (*x>value+range) *x-=range;
                        else if (*x<value-range) *x+=range;
                        else *x=value;
                }
void EMAN::CollapseProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 2095 of file processor.h.

References EMAN::Processor::params, range, and EMAN::RealPixelProcessor::value.

                {
                        params = new_params;
                        range = params["range"];
                        value = params["value"];
                }

Member Data Documentation

const string CollapseProcessor::NAME = "threshold.compress" [static]

Definition at line 2115 of file processor.h.

Referenced by get_name().

float EMAN::CollapseProcessor::range [protected]

Definition at line 2124 of file processor.h.

Referenced by process_pixel(), and set_params().


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