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

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

#include <processor.h>

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

List of all members.

Public Member Functions

 MaskSoftProcessor ()
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.soft"

Protected Member Functions

void process_dist_pixel (float *pixel, float dist) const

Protected Attributes

float value
float width

Detailed Description

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

Parameters:
valuestep cutoff to this value

Definition at line 2611 of file processor.h.


Constructor & Destructor Documentation

EMAN::MaskSoftProcessor::MaskSoftProcessor ( ) [inline]

Definition at line 2614 of file processor.h.

Referenced by NEW().

                                   :value(0)
                {
                }

Member Function Documentation

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

                {
                        return "Outer (optionally also inner) mask to a user-provided value with a soft Gaussian edge.";
                }
string EMAN::MaskSoftProcessor::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 2618 of file processor.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::MaskSoftProcessor::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 2634 of file processor.h.

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

                {
                        TypeDict d = CircularMaskProcessor::get_param_types();
                        d.put("value", EMObject::FLOAT, "cutoff to this value. default=0");
                        d.put("width", EMObject::FLOAT, "1/e width of Gaussian falloff (both inner and outer) in pixels. default=4");
                        return d;
                }
static Processor* EMAN::MaskSoftProcessor::NEW ( ) [inline, static]

Definition at line 2622 of file processor.h.

References MaskSoftProcessor().

                {
                        return new MaskSoftProcessor();
                }
void EMAN::MaskSoftProcessor::process_dist_pixel ( float *  pixel,
float  dist 
) const [inline, protected, virtual]
void EMAN::MaskSoftProcessor::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::CircularMaskProcessor.

Definition at line 2627 of file processor.h.

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

                {
                        CircularMaskProcessor::set_params(new_params);
                        value = params.set_default("value",0.0f);
                        width = params.set_default("width",4.0f);
                }

Member Data Documentation

const string MaskSoftProcessor::NAME = "mask.soft" [static]

Definition at line 2647 of file processor.h.

Referenced by get_name().

float EMAN::MaskSoftProcessor::value [protected]

Definition at line 2658 of file processor.h.

Referenced by process_dist_pixel(), and set_params().

float EMAN::MaskSoftProcessor::width [protected]

Definition at line 2658 of file processor.h.

Referenced by process_dist_pixel(), and set_params().


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