Bins pixel values, similar to calculating a histogram. More...

#include <processor.h>

Inheritance diagram for EMAN::HistogramBin:

Collaboration diagram for EMAN::HistogramBin:

[legend]

Public Member Functions
	HistogramBin ()

void	process_inplace (EMData *image)
	To process an image in-place. More...

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::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 = "histogram.bin"

Protected Attributes
int	default_bins

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

Bins pixel values, similar to calculating a histogram.

The histogram is comprised of 'nbins' bins, and the value assigned to each pixel in the bin is the midpoint of the bin's upper and lower limits. Defaults to 256 bins

Parameters

nbins	The number of bins the pixel values will be compressed into
debug	Outputs debugging information (number of pixels per bin)

Definition at line 9201 of file processor.h.

Constructor & Destructor Documentation

◆ HistogramBin()

EMAN::HistogramBin::HistogramBin ( )

inline

Definition at line 9204 of file processor.h.

9204: default_bins(1024) {}

EMAN::HistogramBin::default_bins

int default_bins

Definition: processor.h:9234

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                        {
                                return "Bins pixel values, similar to calculating a histogram. The histogram is comprised of 'nbins' bins, and the value assigned to each pixel in the bin is the midpoint of the bin's upper and lower limits. Defaults to 256 bins";
                        }

◆ get_name()

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

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
                                d.put("nbins", EMObject::INT, "The number of bins the pixel values will be compressed into");
                                d.put("debug", EMObject::BOOL, "Outputs debugging information (number of pixels per bin)");
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 9213 of file processor.h.

                        {
                                return new HistogramBin();
                        }

References HistogramBin().

◆ process_inplace()

void HistogramBin::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 12635 of file processor.cpp.

{
        float min = image->get_attr("minimum");
        float max = image->get_attr("maximum");
        float nbins = (float)params.set_default("nbins",default_bins);
        bool debug = params.set_default("debug",false);
 
        vector<int> debugscores;
        if ( debug ) {
                debugscores = vector<int>((int)nbins, 0);
        }
 
        if ( nbins < 0 ) throw InvalidParameterException("nbins must be greater than 0");
 
        float bin_width = (max-min)/nbins;
        float bin_val_offset = bin_width/2.0f;
 
        size_t size = image->get_size();
        float* dat = image->get_data();
 
        for(size_t i = 0; i < size; ++i ) {
                float val = dat[i];
                val -= min;
                int bin = (int) (val/bin_width);
 
                // This makes the last interval [] and not [)
                if (bin == nbins) bin -= 1;
 
                dat[i] = min + bin*bin_width + bin_val_offset;
                if ( debug ) {
                        debugscores[bin]++;
                }
        }
 
        if ( debug ) {
                int i = 0;
                for( vector<int>::const_iterator it = debugscores.begin(); it != debugscores.end(); ++it, ++i)
                        cout << "Bin " << i << " has " << *it << " pixels in it" << endl;
        }
 
}

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

Member Data Documentation

◆ default_bins

int EMAN::HistogramBin::default_bins

protected

Definition at line 9234 of file processor.h.

Referenced by process_inplace().

◆ NAME

const string HistogramBin::NAME = "histogram.bin"

static

Definition at line 9231 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 Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HistogramBin()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ default_bins

◆ NAME