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:

[legend]
Collaboration diagram for EMAN::MaskSharpProcessor:
[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 2384 of file processor.h.


Constructor & Destructor Documentation

EMAN::MaskSharpProcessor::MaskSharpProcessor  )  [inline]
 

Definition at line 2387 of file processor.h.

02387                                     :value(0)
02388                 {
02389                 }


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

02414                 {
02415                         return "step cutoff to a user-given value in both inner and outer circles.";
02416                 }

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

02392                 {
02393                         return NAME;
02394                 }

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

References EMAN::TypeDict::put().

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

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

Definition at line 2395 of file processor.h.

02396                 {
02397                         return new MaskSharpProcessor();
02398                 }

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2421 of file processor.h.

References dist().

02422                 {
02423                         if (dist >= outer_radius_square || dist < inner_radius_square)
02424                         {
02425                                 *pixel = value;
02426                         }
02427                 }

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

02401                 {
02402                         CircularMaskProcessor::set_params(new_params);
02403                         value = params.set_default("value",0.0f);
02404                 }


Member Data Documentation

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

Definition at line 104 of file processor.cpp.

float EMAN::MaskSharpProcessor::value [protected]
 

Definition at line 2429 of file processor.h.


The documentation for this class was generated from the following files:
Generated on Fri Apr 30 15:39:21 2010 for EMAN2 by  doxygen 1.3.9.1