#include <processor.h>

Inheritance diagram for EMAN::SetBitsProcessor:

Collaboration diagram for EMAN::SetBitsProcessor:

[legend]

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

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

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

Static Public Member Functions
static Processor *	NEW ()

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

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::Processor
Dict	params

Detailed Description

Definition at line 2755 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Converts each pixel value to an integer using the specified number of total bits. This will make the data more compressible, and allows you to handle conversion to integer data modes.\
The data itself will remain stored in single precision floating point format, so using >23 bits would be a bad idea.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
                                d.put("bits", EMObject::INT, "Number of bits to retain (default 5)");
                                d.put("nsigma", EMObject::FLOAT, "Number of standard deviations to include in the n bit mapping. eg - max=min(mean+nsigma*sigma,max)");
                                d.put("floatbits", EMObject::INT, "If set to a >0 number, alters the algorithm, so the specified number of significant floating point bits is retained. The floating point exponent is not modified. This will produce less compressible data, but the values will be less perturbed.");
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 2762 of file processor.h.

                {
                        return new SetBitsProcessor();
                }

◆ process_inplace()

void SetBitsProcessor::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

image The image to be processed.

Implements EMAN::Processor.

Definition at line 2599 of file processor.cpp.

{
        if (!image) return;
 
        float nsigma = params.set_default("nsigma",3.0f);
        int bits = params.set_default("bits",5);
        int floatbits = params.set_default("floatbits",-1);
        float sigma = image->get_attr("sigma");
        float mean = image->get_attr("mean");
        float bitmax=pow(2.,bits);
        
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
        size_t total_size = (size_t)nx * (size_t)ny * (size_t)nz;
        
        if (floatbits<=0) {
                float min=image->get_attr("minimum");
                float max=image->get_attr("maximum");
                
                // our max/min are either the actual max/min, or mean+-nsigma*sigma
                // whichever produces the smaller range. That way by specifying a large
                // nsigma you can get the actual min/max of the image easily
                if (mean-nsigma*sigma>min) min=mean-nsigma*sigma;
                if (mean+nsigma*sigma<max) max=mean+nsigma*sigma;
                
 
                for (size_t i=0; i<total_size; i++) {
                        float newval=floor((image->get_value_at_index(i)-min)*bitmax/(max-min)
                                
                        );
                        if (newval<0) newval=0;
                        if (newval>=bitmax) newval=bitmax-1.0f;
                        image->set_value_at_index(i,newval);
                }
        }
        else {
                // In this version, we keep a specified number of significant bits in the floating point significand, leaving the exponent and sign alone
                if (floatbits>22) throw InvalidValueException(floatbits,"floatbits must be <23");
                unsigned int bitmask= 0xffffffff << (23-floatbits); // this will leave 1 in the sign and exponent bits, along with the specified number of significand bits
                for (size_t i=0; i<total_size; i++) {
                        float newval=image->get_value_at_index(i);
                        unsigned int *newvali = (unsigned int*)&newval;
                        *newvali&=bitmask;
                        image->set_value_at_index(i,newval);
                }
        }
}

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

Member Data Documentation

◆ NAME

const string SetBitsProcessor::NAME = "math.setbits"

static

Definition at line 2784 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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME