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:

Collaboration diagram for EMAN::CutToZeroProcessor:

Public Member Functions
string	get_name () const
	Get the processor's name. More...
TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
string	get_desc () const
	Get the descrition of this specific processor. More...
Public Member Functions inherited from EMAN::RealPixelProcessor
	RealPixelProcessor ()
void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...
virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...
virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
Static Public Member Functions inherited from EMAN::RealPixelProcessor
static string	get_group_desc ()
Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...
static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...
static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "threshold.belowtozero_cut"

Protected Member Functions
void	process_pixel (float *x) const
Protected Member Functions inherited from EMAN::RealPixelProcessor
virtual void	calc_locals (EMData *)
virtual void	normalize (EMData *) const

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types {   TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,   GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,   GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,   KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,   SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,   TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...
Protected Attributes inherited from EMAN::RealPixelProcessor
float	value
float	maxval
float	mean
float	sigma
Protected Attributes inherited from EMAN::Processor
Dict	params

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

Member Function Documentation

get_desc()

string EMAN::CutToZeroProcessor::get_desc ( ) const

inlinevirtual

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

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

get_name()

string EMAN::CutToZeroProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns

The processor's name.

Implements EMAN::Processor.

Definition at line 3155 of file processor.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

TypeDict EMAN::CutToZeroProcessor::get_param_types ( ) const

inlinevirtual

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

                {
                        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;
                }

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

NEW()

static Processor * EMAN::CutToZeroProcessor::NEW ( )

inlinestatic

Definition at line 3159 of file processor.h.

                {
                        return new CutToZeroProcessor();
                }

process_pixel()

void EMAN::CutToZeroProcessor::process_pixel ( float *  x ) const

inlineprotectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 3178 of file processor.h.

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

References EMAN::RealPixelProcessor::value, and x.

Member Data Documentation

NAME

const string CutToZeroProcessor::NAME = "threshold.belowtozero_cut"

static

Definition at line 3175 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp