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:
range The range about 'value' which will be collapsed to 'value'
value The pixel value where the focus of the collapse operation is

Definition at line 1903 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 1930 of file processor.h.

01931                 {
01932                         return "f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r";
01933                 }

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

References NAME.

01907                 {
01908                         return NAME;
01909                 }

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

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

01923                 {
01924                         TypeDict d;
01925                         d.put("range", EMObject::FLOAT, "The range about 'value' which will be collapsed to 'value'");
01926                         d.put("value", EMObject::FLOAT, "The pixel value where the focus of the collapse operation is");
01927                         return d;
01928                 }

static Processor* EMAN::CollapseProcessor::NEW (  )  [inline, static]

Definition at line 1910 of file processor.h.

01911                 {
01912                         return new CollapseProcessor();
01913                 }

void EMAN::CollapseProcessor::process_pixel ( float *  x  )  const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 1938 of file processor.h.

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

01939                 {
01940                         if (*x>value+range) *x-=range;
01941                         else if (*x<value-range) *x+=range;
01942                         else *x=value;
01943                 }

void EMAN::CollapseProcessor::set_params ( const Dict new_params  )  [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_params A dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 1915 of file processor.h.

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

01916                 {
01917                         params = new_params;
01918                         range = params["range"];
01919                         value = params["value"];
01920                 }


Member Data Documentation

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

Definition at line 1935 of file processor.h.

Referenced by get_name().

float EMAN::CollapseProcessor::range [protected]

Definition at line 1944 of file processor.h.

Referenced by process_pixel(), and set_params().


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:46:06 2011 for EMAN2 by  doxygen 1.4.7