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

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

ProcessorNEW ()

Static Public Attributes

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

01624                 {
01625                         return "f(x) = 0 if x < value; f(x) = 1 if x >= value.";
01626                 }

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

01609                 {
01610                         return NAME;
01611                 }

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

References EMAN::TypeDict::put().

01617                 {
01618                         TypeDict d;
01619                         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" );
01620                         return d;
01621                 }

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

Definition at line 1612 of file processor.h.

01613                 {
01614                         return new BinarizeProcessor();
01615                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1631 of file processor.h.

References x.

01632                 {
01633                         if (*x < value)
01634                         {
01635                                 *x = 0;
01636                         }
01637                         else
01638                         {
01639                                 *x = 1;
01640                         }
01641                 }


Member Data Documentation

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

Definition at line 89 of file processor.cpp.


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