EMAN::CutToZeroProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::CutToZeroProcessor:

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

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_cut"

Protected Member Functions

void process_pixel (float *x) const

Detailed Description

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

Parameters:
minval the value that will be set to zero - all values below will also be set to zero. Values above get minval subtracted from them

Definition at line 1827 of file processor.h.


Member Function Documentation

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

01846                 {
01847                         return "f(x) = x-minval if x >= minval; f(x) = 0 if x < minval.";
01848                 }

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

References NAME.

01831                 {
01832                         return NAME;
01833                 }

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

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

01839                 {
01840                         TypeDict d;
01841                         d.put("minval", EMObject::FLOAT, "the value that will be set to zero - all values below will also be set to zero. Values above get minval subtracted from them" );
01842                         return d;
01843                 }

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

Definition at line 1834 of file processor.h.

01835                 {
01836                         return new CutToZeroProcessor();
01837                 }

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

Implements EMAN::RealPixelProcessor.

Definition at line 1853 of file processor.h.

References EMAN::RealPixelProcessor::value.

01854                 {
01855                         *x = *x - value;
01856                         if (*x < 0) {
01857                                 *x = 0;
01858                         }
01859                 }


Member Data Documentation

const string CutToZeroProcessor::NAME = "threshold.belowtozero_cut" [static]

Definition at line 1850 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:09:51 2012 for EMAN2 by  doxygen 1.4.7