This processor can be used to correct errors when reading signed data as unsigned and vice-versa. More...

#include <processor.h>

Inheritance diagram for EMAN::FixSignProcessor:

Collaboration diagram for EMAN::FixSignProcessor:

[legend]

Public Member Functions
string	get_name () const
	Get the processor's name. More...

void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

Public Member Functions inherited from EMAN::RealPixelProcessor
	RealPixelProcessor ()

void	process_inplace (EMData *image)
	To process an image in-place. 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 = "math.fixmode"

Protected Member Functions
void	process_pixel (float *x) const

string	get_desc () const
	Get the descrition of this specific processor. More...

Protected Member Functions inherited from EMAN::RealPixelProcessor
virtual void	calc_locals (EMData *)

virtual void	normalize (EMData *) const

Protected Attributes
int	mode

Protected Attributes inherited from EMAN::RealPixelProcessor
float	value

float	maxval

float	mean

float	sigma

Protected Attributes inherited from EMAN::Processor
Dict	params

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

Detailed Description

This processor can be used to correct errors when reading signed data as unsigned and vice-versa.

Definition at line 2309 of file processor.h.

Member Function Documentation

◆ get_desc()

string EMAN::FixSignProcessor::get_desc ( ) const

inlineprotectedvirtual

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

                {
                        return "Fixes errors with reading signed/unsigned data. Need to specify the correct mode.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
                                d.put("byte_stou", EMObject::BOOL, "8 bit data signed read -> unsigned");
                                d.put("byte_utos", EMObject::BOOL, "8 bit data unsigned read -> signed");
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 2316 of file processor.h.

                {
                        return new FixSignProcessor();
                }

◆ process_pixel()

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

inlineprotectedvirtual

Implements EMAN::RealPixelProcessor.

Definition at line 2340 of file processor.h.

                {
                        switch (mode) {
                        case 1:
                                if (*x<0) *x+=256;
                                break;
                        case 2:
                                if (*x>127) *x-=256;
                                break;
                        }
 
                }

References mode, and x.

◆ set_params()

void EMAN::FixSignProcessor::set_params ( const Dict & new_params )

inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters

new_params A dictionary containing the new parameters.

Reimplemented from EMAN::RealPixelProcessor.

Definition at line 2323 of file processor.h.

                        {
                                params = new_params;
                                if (params.set_default("byte_stou",0)) mode=1;
                                else if (params.set_default("byte_utos",1)) mode=2;
                                else mode=0;
                        }

References mode, EMAN::Processor::params, and EMAN::Dict::set_default().

Member Data Documentation

◆ mode

int EMAN::FixSignProcessor::mode

protected

Definition at line 2358 of file processor.h.

Referenced by process_pixel(), and set_params().

◆ NAME

const string FixSignProcessor::NAME = "math.fixmode"

static

Definition at line 2321 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_pixel()

◆ set_params()

Member Data Documentation

◆ mode

◆ NAME