peak processor -> if npeaks or more surrounding values >= value, value->0 More...

#include <processor.h>

Inheritance diagram for EMAN::PeakOnlyProcessor:

Collaboration diagram for EMAN::PeakOnlyProcessor:

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

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

Public Member Functions inherited from EMAN::BoxStatProcessor
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

virtual EMData *	process (EMData *image)

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::BoxStatProcessor
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 = "mask.onlypeaks"

Protected Member Functions
void	process_pixel (float pixel, const float data, int n) const

Private Attributes
int	npeaks

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

peak processor -> if npeaks or more surrounding values >= value, value->0

Parameters

npeaks the number of surrounding peaks allow to >= pixel values

Definition at line 4701 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Zeros all pixels with adjacent pixels >= the value being considered. That is, it leaves behind only local maxima.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::PeakOnlyProcessor::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::BoxStatProcessor.

Definition at line 4721 of file processor.h.

                {
                        TypeDict d;
                        d.put("npeaks", EMObject::INT, "The number of pixels adjacent to the pixel under consideration which may be higher and still be a valid peak. If 0, finds pure peaks");
                        d.put("usemean", EMObject::BOOL, "Count all pixels with value higher than the mean of adjacent pixels as peaks. Overwrite npeaks.");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 4708 of file processor.h.

                {
                        return new PeakOnlyProcessor();
                }

◆ process_pixel()

void EMAN::PeakOnlyProcessor::process_pixel	(	float *	pixel,
		const float *	data,
		int	n
	)		const

inlineprotectedvirtual

Implements EMAN::BoxStatProcessor.

Definition at line 4737 of file processor.h.

                {
                        if (params["usemean"]){
                                float mean=0;
                                for (int i = 0; i < n; i++)
                                {
                                        mean+=data[i];
                                }
 
                                if (*pixel < mean/float(n))
                                {
                                        *pixel = 0;
                                }
                        }
                        else{
                                int r = 0;
 
                                for (int i = 0; i < n; i++)
                                {
                                        if (data[i] >= *pixel) {
                                                r++;
                                        }
                                }
 
                                if (r > npeaks)
                                {
                                        *pixel = 0;
                                }
                        }
                }

References npeaks, and EMAN::Processor::params.

◆ set_params()

void EMAN::PeakOnlyProcessor::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::Processor.

Definition at line 4712 of file processor.h.

                {
                        params = new_params;
                        npeaks = params["npeaks"];
                        if (npeaks == 0) {
                                npeaks = 1;
                        }
                }

References npeaks, and EMAN::Processor::params.

Member Data Documentation

◆ NAME

const string PeakOnlyProcessor::NAME = "mask.onlypeaks"

static

Definition at line 4734 of file processor.h.

Referenced by get_name().

◆ npeaks

int EMAN::PeakOnlyProcessor::npeaks

private

Definition at line 4768 of file processor.h.

Referenced by process_pixel(), and set_params().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_pixel()

◆ set_params()

Member Data Documentation

◆ NAME

◆ npeaks