EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
EMAN::MaskEdgeMeanProcessor Class Reference

A step cutoff to the the mean value in a ring centered on the outer radius. More...

#include <processor.h>

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

Public Member Functions

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.ringmean"
 

Protected Member Functions

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

Private Attributes

int ring_width
 
float ring_avg
 

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...
 
- 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
 

Detailed Description

A step cutoff to the the mean value in a ring centered on the outer radius.

Parameters
ring_widthThe width of the mask ring.

Definition at line 3907 of file processor.h.

Member Function Documentation

◆ calc_locals()

void MaskEdgeMeanProcessor::calc_locals ( EMData image)
protectedvirtual

Reimplemented from EMAN::CircularMaskProcessor.

Definition at line 2399 of file processor.cpp.

2400{
2401 if (!image) {
2402 throw NullPointerException("NULL image");
2403 }
2404 int nitems = 0;
2405 float sum = 0;
2406 float *data = image->get_data();
2407 size_t i = 0;
2408
2409 xc = Util::fast_floor(nx/2.0f) + dx;
2410 yc = Util::fast_floor(ny/2.0f) + dy;
2411 zc = Util::fast_floor(nz/2.0f) + dz;
2412
2413 for (int z = 0; z < nz; ++z) {
2414 for (int y = 0; y < ny; ++y) {
2415 for (int x = 0; x < nx; ++x) {
2416 float x1 = sqrt((x - xc) * (x - xc) + (y - yc) * (y - yc) + (z - zc) * (z - zc));
2417 if (x1 <= outer_radius + ring_width && x1 >= outer_radius - ring_width) {
2418 sum += data[i];
2419 ++nitems;
2420 }
2421 ++i;
2422 }
2423 }
2424 }
2425
2426 ring_avg = sum / nitems;
2427}
static int fast_floor(float x)
A fast way to calculate a floor, which is largest integral value not greater than argument.
Definition: util.h:874
EMData * sqrt() const
return square root of current image
#define NullPointerException(desc)
Definition: exception.h:241
#define y(i, j)
Definition: projector.cpp:1516
#define x(i)
Definition: projector.cpp:1517

References EMAN::CircularMaskProcessor::dx, EMAN::CircularMaskProcessor::dy, EMAN::CircularMaskProcessor::dz, EMAN::Util::fast_floor(), NullPointerException, EMAN::CoordinateProcessor::nx, EMAN::CoordinateProcessor::ny, EMAN::CoordinateProcessor::nz, EMAN::CircularMaskProcessor::outer_radius, ring_avg, ring_width, sqrt(), x, EMAN::CircularMaskProcessor::xc, y, EMAN::CircularMaskProcessor::yc, and EMAN::CircularMaskProcessor::zc.

◆ get_desc()

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

3936 {
3937 return "A step cutoff to the the mean value in a ring centered on the outer radius";
3938 }

◆ get_name()

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

3911 {
3912 return NAME;
3913 }
static const string NAME
Definition: processor.h:3940

References NAME.

◆ get_param_types()

TypeDict EMAN::MaskEdgeMeanProcessor::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 3928 of file processor.h.

3929 {
3931 d.put("ring_width", EMObject::INT, "The width of the mask ring.");
3932 return d;
3933 }
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::CircularMaskProcessor::get_param_types(), EMAN::EMObject::INT, and EMAN::TypeDict::put().

◆ NEW()

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

Definition at line 3914 of file processor.h.

3915 {
3916 return new MaskEdgeMeanProcessor();
3917 }
A step cutoff to the the mean value in a ring centered on the outer radius.
Definition: processor.h:3908

◆ process_dist_pixel()

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

◆ set_params()

void EMAN::MaskEdgeMeanProcessor::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 3919 of file processor.h.

3920 {
3922 ring_width = params["ring_width"];
3923 if (ring_width == 0) {
3924 ring_width = 1;
3925 }
3926 }
void set_params(const Dict &new_params)
Set the processor parameters using a key/value dictionary.
Definition: processor.h:3728

References EMAN::Processor::params, ring_width, and EMAN::CircularMaskProcessor::set_params().

Member Data Documentation

◆ NAME

const string MaskEdgeMeanProcessor::NAME = "mask.ringmean"
static

Definition at line 3940 of file processor.h.

Referenced by get_name().

◆ ring_avg

float EMAN::MaskEdgeMeanProcessor::ring_avg
private

Definition at line 3955 of file processor.h.

Referenced by calc_locals(), and process_dist_pixel().

◆ ring_width

int EMAN::MaskEdgeMeanProcessor::ring_width
private

Definition at line 3954 of file processor.h.

Referenced by calc_locals(), and set_params().


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