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

EMAN::MaskSharpProcessor Class Reference

step cutoff to a user-given value in both inner and outer circles. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskSharpProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MaskSharpProcessor ()
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.sharp"

Protected Member Functions

void process_dist_pixel (float *pixel, float dist) const

Protected Attributes

float value

Detailed Description

step cutoff to a user-given value in both inner and outer circles.

Parameters:
value step cutoff to this value

Definition at line 2387 of file processor.h.


Constructor & Destructor Documentation

EMAN::MaskSharpProcessor::MaskSharpProcessor  )  [inline]
 

Definition at line 2390 of file processor.h.

02390                                     :value(0)
02391                 {
02392                 }


Member Function Documentation

string EMAN::MaskSharpProcessor::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.

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 2416 of file processor.h.

02417                 {
02418                         return "step cutoff to a user-given value in both inner and outer circles.";
02419                 }

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

02395                 {
02396                         return NAME;
02397                 }

TypeDict EMAN::MaskSharpProcessor::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::CircularMaskProcessor.

Definition at line 2409 of file processor.h.

References EMAN::TypeDict::put().

02410                 {
02411                         TypeDict d = CircularMaskProcessor::get_param_types();
02412                         d.put("value", EMObject::FLOAT, "step cutoff to this value. Default is 0.");
02413                         return d;
02414                 }

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

Definition at line 2398 of file processor.h.

02399                 {
02400                         return new MaskSharpProcessor();
02401                 }

void EMAN::MaskSharpProcessor::process_dist_pixel float *  pixel,
float  dist
const [inline, protected, virtual]
 

Implements EMAN::CircularMaskProcessor.

Definition at line 2424 of file processor.h.

References dist().

02425                 {
02426                         if (dist >= outer_radius_square || dist < inner_radius_square)
02427                         {
02428                                 *pixel = value;
02429                         }
02430                 }

void EMAN::MaskSharpProcessor::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::CircularMaskProcessor.

Definition at line 2403 of file processor.h.

02404                 {
02405                         CircularMaskProcessor::set_params(new_params);
02406                         value = params.set_default("value",0.0f);
02407                 }


Member Data Documentation

const string MaskSharpProcessor::NAME = "mask.sharp" [static]
 

Definition at line 110 of file processor.cpp.

float EMAN::MaskSharpProcessor::value [protected]
 

Definition at line 2432 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:52:00 2011 for EMAN2 by  doxygen 1.3.9.1