EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
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:
minvalthe 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 1962 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 1980 of file processor.h.

                {
                        return "f(x) = x-minval if x >= minval; f(x) = 0 if x < minval.";
                }
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 1965 of file processor.h.

References NAME.

                {
                        return NAME;
                }
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 1973 of file processor.h.

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

                {
                        TypeDict d;
                        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" );
                        return d;
                }
static Processor* EMAN::CutToZeroProcessor::NEW ( ) [inline, static]

Definition at line 1969 of file processor.h.

                {
                        return new CutToZeroProcessor();
                }
void EMAN::CutToZeroProcessor::process_pixel ( float *  x) const [inline, protected, virtual]

Implements EMAN::RealPixelProcessor.

Definition at line 1988 of file processor.h.

References EMAN::RealPixelProcessor::value.

                {
                        *x = *x - value;
                        if (*x < 0) {
                                *x = 0;
                        }
                }

Member Data Documentation

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

Definition at line 1985 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files: