EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all 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]

Public Member Functions

 MaskSharpProcessor ()
 
string get_name () const
 Get the processor's name. More...
 
void set_params (const Dict &new_params)
 Set the processor parameters using a key/value dictionary. More...
 
TypeDict get_param_types () const
 Get processor parameter information in a dictionary. More...
 
string get_desc () const
 Get the descrition of this specific processor. More...
 
- Public Member Functions inherited from EMAN::CircularMaskProcessor
 CircularMaskProcessor ()
 
- Public Member Functions inherited from EMAN::CoordinateProcessor
 CoordinateProcessor ()
 
void process_inplace (EMData *image)
 To process an image in-place. More...
 
- Public Member Functions inherited from EMAN::Processor
virtual ~Processor ()
 
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place. More...
 
virtual void process_list_inplace (vector< EMData * > &images)
 To process multiple images using the same algorithm. More...
 
virtual Dict get_params () const
 Get the processor parameters in a key/value dictionary. More...
 

Static Public Member Functions

static ProcessorNEW ()
 
- Static Public Member Functions inherited from EMAN::CoordinateProcessor
static string get_group_desc ()
 
- Static Public Member Functions inherited from EMAN::Processor
static string get_group_desc ()
 Get the description of this group of processors. More...
 
static void EMFourierFilterInPlace (EMData *fimage, Dict params)
 Compute a Fourier-filter processed image in place. More...
 
static EMDataEMFourierFilter (EMData *fimage, Dict params)
 Compute a Fourier-processor processed image without altering the original image. More...
 

Static Public Attributes

static const string NAME = "mask.sharp"
 

Protected Member Functions

void process_dist_pixel (float *pixel, float dist) const
 
- Protected Member Functions inherited from EMAN::CircularMaskProcessor
void calc_locals (EMData *image)
 
bool is_valid () const
 
void process_pixel (float *pixel, int xi, int yi, int zi) const
 

Protected Attributes

float value
 
- Protected Attributes inherited from EMAN::CircularMaskProcessor
float inner_radius
 
float outer_radius
 
float inner_radius_square
 
float outer_radius_square
 
float dx
 
float dy
 
float dz
 
float xc
 
float yc
 
float zc
 
- Protected Attributes inherited from EMAN::CoordinateProcessor
int nx
 
int ny
 
int nz
 
float mean
 
float sigma
 
float maxval
 
bool is_complex
 
- Protected Attributes inherited from EMAN::Processor
Dict params
 

Additional Inherited Members

- Public Types inherited from EMAN::Processor
enum  fourier_filter_types {
  TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,
  GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,
  GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,
  KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,
  SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,
  TANH_BAND_PASS , RADIAL_TABLE , CTF_
}
 Fourier filter Processor type enum. More...
 

Detailed Description

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

Parameters
valuestep cutoff to this value

Definition at line 3803 of file processor.h.

Constructor & Destructor Documentation

◆ MaskSharpProcessor()

EMAN::MaskSharpProcessor::MaskSharpProcessor ( )
inline

Definition at line 3806 of file processor.h.

3806 :value(0)
3807 {
3808 }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

string EMAN::MaskSharpProcessor::get_desc ( ) const
inlinevirtual

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

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

◆ get_name()

string EMAN::MaskSharpProcessor::get_name ( ) const
inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns
The processor's name.

Implements EMAN::Processor.

Definition at line 3810 of file processor.h.

3811 {
3812 return NAME;
3813 }
static const string NAME
Definition: processor.h:3837

References NAME.

◆ get_param_types()

TypeDict EMAN::MaskSharpProcessor::get_param_types ( ) const
inlinevirtual

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

3826 {
3828 d.put("value", EMObject::FLOAT, "step cutoff to this value. Default is 0.");
3829 return d;
3830 }
TypeDict get_param_types() const
Get processor parameter information in a dictionary.
Definition: processor.h:3760
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305
void put(const string &key, EMObject::ObjectType o, const string &desc="")
Definition: emobject.h:330

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

◆ NEW()

static Processor * EMAN::MaskSharpProcessor::NEW ( )
inlinestatic

Definition at line 3814 of file processor.h.

3815 {
3816 return new MaskSharpProcessor();
3817 }

References MaskSharpProcessor().

◆ process_dist_pixel()

void EMAN::MaskSharpProcessor::process_dist_pixel ( float *  pixel,
float  dist 
) const
inlineprotectedvirtual

Implements EMAN::CircularMaskProcessor.

Definition at line 3840 of file processor.h.

3841 {
3842 if (dist >= outer_radius_square || dist < inner_radius_square)
3843 {
3844 *pixel = value;
3845 }
3846 }

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

◆ set_params()

void EMAN::MaskSharpProcessor::set_params ( const Dict new_params)
inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters
new_paramsA dictionary containing the new parameters.

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 3819 of file processor.h.

3820 {
3822 value = params.set_default("value",0.0f);
3823 }
void set_params(const Dict &new_params)
Set the processor parameters using a key/value dictionary.
Definition: processor.h:3728
type set_default(const string &key, type val)
Default setting behavior This can be achieved using a template - d.woolford Jan 2008 (before there wa...
Definition: emobject.h:569

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

Member Data Documentation

◆ NAME

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

Definition at line 3837 of file processor.h.

Referenced by get_name().

◆ value

float EMAN::MaskSharpProcessor::value
protected

Definition at line 3848 of file processor.h.

Referenced by process_dist_pixel(), and set_params().


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