EMAN::ToZeroProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::ToZeroProcessor:

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

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.belowtozero"

Protected Member Functions

void process_pixel (float *x) const

Detailed Description

f(x) = x if x >= minval; f(x) = 0 if x < minval

Parameters:
minval 

Definition at line 1441 of file processor.h.


Member Function Documentation

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

01460                         {
01461                                 return "f(x) = x if x >= minval; f(x) = 0 if x < minval.";
01462                         }

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

References NAME.

01445                         {
01446                                 return NAME;
01447                         }

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

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

01453                         {
01454                                 TypeDict d;
01455                                 d.put("minval", EMObject::FLOAT, "Everything below this value is set to zero");
01456                                 return d;
01457                         }

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

Definition at line 1448 of file processor.h.

01449                         {
01450                                 return new ToZeroProcessor();
01451                         }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1467 of file processor.h.

References EMAN::RealPixelProcessor::value.

01468                         {
01469                                 if (*x < value) {
01470                                         *x = 0;
01471                                 }
01472                         }


Member Data Documentation

const string ToZeroProcessor::NAME = "threshold.belowtozero" [static]

Definition at line 1464 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:39 2013 for EMAN2 by  doxygen 1.4.7