EMAN::BinarizeProcessor Class Reference

f(x) = 0 if x < value; f(x) = 1 if x >= value. More...

#include <processor.h>

Inheritance diagram for EMAN::BinarizeProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
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.binary"

Protected Member Functions

void process_pixel (float *x) const

Detailed Description

f(x) = 0 if x < value; f(x) = 1 if x >= value.

Parameters:
value The thresholding value. If a pixel value is equal to or above the threshold it is set to 1. If it is below it is set to 0

Definition at line 1867 of file processor.h.


Member Function Documentation

string EMAN::BinarizeProcessor::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 1885 of file processor.h.

01886                 {
01887                         return "f(x) = 0 if x < value; f(x) = 1 if x >= value.";
01888                 }

string EMAN::BinarizeProcessor::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 1870 of file processor.h.

References NAME.

01871                 {
01872                         return NAME;
01873                 }

TypeDict EMAN::BinarizeProcessor::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 1878 of file processor.h.

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

01879                 {
01880                         TypeDict d;
01881                         d.put("value", EMObject::FLOAT, "The thresholding value. If a pixel value is equal to or above the threshold it is set to 1. If it is below it is set to 0" );
01882                         return d;
01883                 }

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

Definition at line 1874 of file processor.h.

01875                 {
01876                         return new BinarizeProcessor();
01877                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1893 of file processor.h.

References EMAN::RealPixelProcessor::value.

01894                 {
01895                         if (*x < value)
01896                         {
01897                                 *x = 0;
01898                         }
01899                         else
01900                         {
01901                                 *x = 1;
01902                         }
01903                 }


Member Data Documentation

const string BinarizeProcessor::NAME = "threshold.binary" [static]

Definition at line 1890 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:43:44 2013 for EMAN2 by  doxygen 1.4.7