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

01935                 {
01936                         return "f(x): if v-r<x<v+r -> v; if x>v+r -> x-r; if x<v-r -> x+r";
01937                 }

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

01911                 {
01912                         return NAME;
01913                 }

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

References EMAN::TypeDict::put().

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

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

Definition at line 1914 of file processor.h.

01915                 {
01916                         return new CollapseProcessor();
01917                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1942 of file processor.h.

References x.

01943                 {
01944                         if (*x>value+range) *x-=range;
01945                         else if (*x<value-range) *x+=range;
01946                         else *x=value;
01947                 }

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

01920                 {
01921                         params = new_params;
01922                         range = params["range"];
01923                         value = params["value"];
01924                 }


Member Data Documentation

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

Definition at line 103 of file processor.cpp.

float EMAN::CollapseProcessor::range [protected]
 

Definition at line 1948 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:51:56 2011 for EMAN2 by  doxygen 1.3.9.1