Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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

ProcessorNEW ()

Static Public Attributes

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:
npeaks the number of surrounding peaks allow to >= pixel values

Definition at line 2950 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 2977 of file processor.h.

02978                 {
02979                         return "peak processor -> if npeaks or more surrounding values >= value, value->0";
02980                 }

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

02954                 {
02955                         return NAME;
02956                 }

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

References EMAN::TypeDict::put().

02971                 {
02972                         TypeDict d;
02973                         d.put("npeaks", EMObject::INT, "the number of surrounding peaks allow to >= pixel values");
02974                         return d;
02975                 }

Processor* EMAN::PeakOnlyProcessor::NEW  )  [inline, static]
 

Definition at line 2957 of file processor.h.

02958                 {
02959                         return new PeakOnlyProcessor();
02960                 }

void EMAN::PeakOnlyProcessor::process_pixel float *  pixel,
const float *  data,
int  n
const [inline, protected, virtual]
 

Implements EMAN::BoxStatProcessor.

Definition at line 2985 of file processor.h.

References data.

02986                 {
02987                         int r = 0;
02988 
02989                         for (int i = 0; i < n; i++)
02990                         {
02991                                 if (data[i] >= *pixel) {
02992                                         r++;
02993                                 }
02994                         }
02995 
02996                         if (r > npeaks)
02997                         {
02998                                 *pixel = 0;
02999                         }
03000                 }

void EMAN::PeakOnlyProcessor::set_params const Dict new_params  )  [inline, virtual]
 

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

02962                 {
02963                         params = new_params;
02964                         npeaks = params["npeaks"];
02965                         if (npeaks == 0) {
02966                                 npeaks = 1;
02967                         }
02968                 }


Member Data Documentation

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

Definition at line 115 of file processor.cpp.

int EMAN::PeakOnlyProcessor::npeaks [private]
 

Definition at line 3002 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:47:56 2010 for EMAN2 by  doxygen 1.3.9.1