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
static Processor *	NEW ()
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 2324 of file processor.h.

---

Constructor & Destructor Documentation

EMAN::MaskSharpProcessor::MaskSharpProcessor

(

)

[inline]

Definition at line 2327 of file processor.h.

Referenced by NEW().

                                    :value(0)
                {
                }

---

Member Function Documentation

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

References NAME.

                {
                        return NAME;
                }

static Processor* EMAN::MaskSharpProcessor::NEW

(

)

[inline, static]

Definition at line 2335 of file processor.h.

References MaskSharpProcessor().

                {
                        return new MaskSharpProcessor();
                }

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

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

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

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

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

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

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

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

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

Implements EMAN::CircularMaskProcessor.

Definition at line 2361 of file processor.h.

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

                {
                        if (dist >= outer_radius_square || dist < inner_radius_square)
                        {
                                *pixel = value;
                        }
                }

---

Member Data Documentation

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

Definition at line 2358 of file processor.h.

Referenced by get_name().

float EMAN::MaskSharpProcessor::value [protected]

Definition at line 2369 of file processor.h.

Referenced by process_dist_pixel(), and set_params().

---

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

• processor.h
• processor.cpp