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

static ProcessorNEW ()

Static Public Attributes

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


Constructor & Destructor Documentation

EMAN::MaskSharpProcessor::MaskSharpProcessor (  )  [inline]

Definition at line 2431 of file processor.h.

Referenced by NEW().

02431                                     :value(0)
02432                 {
02433                 }


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

02458                 {
02459                         return "step cutoff to a user-given value in both inner and outer circles.";
02460                 }

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

References NAME.

02436                 {
02437                         return NAME;
02438                 }

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

References EMAN::EMObject::FLOAT, EMAN::CircularMaskProcessor::get_param_types(), and EMAN::TypeDict::put().

02451                 {
02452                         TypeDict d = CircularMaskProcessor::get_param_types();
02453                         d.put("value", EMObject::FLOAT, "step cutoff to this value. Default is 0.");
02454                         return d;
02455                 }

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

Definition at line 2439 of file processor.h.

References MaskSharpProcessor().

02440                 {
02441                         return new MaskSharpProcessor();
02442                 }

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2465 of file processor.h.

References EMAN::CircularMaskProcessor::inner_radius_square, EMAN::CircularMaskProcessor::outer_radius_square, and value.

02466                 {
02467                         if (dist >= outer_radius_square || dist < inner_radius_square)
02468                         {
02469                                 *pixel = value;
02470                         }
02471                 }

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

References EMAN::Processor::params, EMAN::Dict::set_default(), EMAN::CircularMaskProcessor::set_params(), and value.

02445                 {
02446                         CircularMaskProcessor::set_params(new_params);
02447                         value = params.set_default("value",0.0f);
02448                 }


Member Data Documentation

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

Definition at line 2462 of file processor.h.

Referenced by get_name().

float EMAN::MaskSharpProcessor::value [protected]

Definition at line 2473 of file processor.h.

Referenced by process_dist_pixel(), and set_params().


The documentation for this class was generated from the following files:
Generated on Thu May 3 10:09:58 2012 for EMAN2 by  doxygen 1.4.7