Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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

ProcessorNEW ()

Static Public Attributes

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

01756                 {
01757                         return "f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r";
01758                 }

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

01732                 {
01733                         return NAME;
01734                 }

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

References EMAN::TypeDict::put().

01748                 {
01749                         TypeDict d;
01750                         d.put("range", EMObject::FLOAT, "The range about 'value' which will be collapsed to 'value'");
01751                         d.put("value", EMObject::FLOAT, "The pixel value where the focus of the collapse operation is");
01752                         return d;
01753                 }

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

Definition at line 1735 of file processor.h.

01736                 {
01737                         return new CollapseProcessor();
01738                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1763 of file processor.h.

References x.

01764                 {
01765                         if (*x>value+range) *x-=range;
01766                         else if (*x<value-range) *x+=range;
01767                         else *x=value;
01768                 }

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

01741                 {
01742                         params = new_params;
01743                         range = params["range"];
01744                         value = params["value"];
01745                 }


Member Data Documentation

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

Definition at line 92 of file processor.cpp.

float EMAN::CollapseProcessor::range [protected]
 

Definition at line 1769 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:47 2010 for EMAN2 by  doxygen 1.3.9.1