EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes
EMAN::PeakOnlyProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::PeakOnlyProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::PeakOnlyProcessor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

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

Detailed Description

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

Parameters:
npeaksthe number of surrounding peaks allow to >= pixel values

Definition at line 3359 of file processor.h.


Member Function Documentation

string EMAN::PeakOnlyProcessor::get_desc ( ) const [inline, virtual]

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

                {
                        return "peak processor -> if npeaks or more surrounding values >= value, value->0";
                }
string EMAN::PeakOnlyProcessor::get_name ( ) const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 3362 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::PeakOnlyProcessor::get_param_types ( ) const [inline, virtual]

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

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

                {
                        TypeDict d;
                        d.put("npeaks", EMObject::INT, "the number of surrounding peaks allow to >= pixel values");
                        return d;
                }
static Processor* EMAN::PeakOnlyProcessor::NEW ( ) [inline, static]

Definition at line 3366 of file processor.h.

                {
                        return new PeakOnlyProcessor();
                }
void EMAN::PeakOnlyProcessor::process_pixel ( float *  pixel,
const float *  data,
int  n 
) const [inline, protected, virtual]

Implements EMAN::BoxStatProcessor.

Definition at line 3394 of file processor.h.

References npeaks.

                {
                        int r = 0;

                        for (int i = 0; i < n; i++)
                        {
                                if (data[i] >= *pixel) {
                                        r++;
                                }
                        }

                        if (r > npeaks)
                        {
                                *pixel = 0;
                        }
                }
void EMAN::PeakOnlyProcessor::set_params ( const Dict new_params) [inline, virtual]

Set the processor parameters using a key/value dictionary.

Parameters:
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 3370 of file processor.h.

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

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

Member Data Documentation

const string PeakOnlyProcessor::NAME = "mask.onlypeaks" [static]

Definition at line 3391 of file processor.h.

Referenced by get_name().

Definition at line 3411 of file processor.h.

Referenced by process_pixel(), and set_params().


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