EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::ToMinvalProcessor Class Reference

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

#include <processor.h>

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

List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
void process_inplace (EMData *image)
 To process an image in-place.
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.belowtominval"

Detailed Description

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

Parameters:
minvalEverything below this value is set to this value

Definition at line 1924 of file processor.h.


Member Function Documentation

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

                {
                        return "f(x) = x if x >= minval; f(x) = minval|newval if x < minval.";
                }
string EMAN::ToMinvalProcessor::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 1927 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::ToMinvalProcessor::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 1938 of file processor.h.

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

                {
                        TypeDict d;
                        d.put("minval", EMObject::FLOAT, "Everything below this value is set to this value");
                        d.put("newval", EMObject::FLOAT, "If set, values below minval will be set to newval instead of minval ");
                        return d;
                }
static Processor* EMAN::ToMinvalProcessor::NEW ( ) [inline, static]

Definition at line 1931 of file processor.h.

                {
                        return new ToMinvalProcessor();
                }
void ToMinvalProcessor::process_inplace ( EMData image) [virtual]

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 1597 of file processor.cpp.

References data, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), LOGWARN, EMAN::Processor::params, EMAN::Dict::set_default(), and EMAN::EMData::update().

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }

        float minval = params.set_default("minval",0.0f);
        float newval = params.set_default("newval",minval);

        size_t size = (size_t)image->get_xsize() *
                          (size_t)image->get_ysize() *
                          (size_t)image->get_zsize();
        float *data = image->get_data();



        for (size_t i = 0; i < size; ++i) {
                if (data[i]<minval) data[i]=newval;
        }
        image->update();
}

Member Data Documentation

const string ToMinvalProcessor::NAME = "threshold.belowtominval" [static]

Definition at line 1951 of file processor.h.

Referenced by get_name().


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