EMAN::AzSharpProcessor Class Reference

Similar to FourierProcessor, but enhances or compresses azimuthal contrast rather than the typical radial linear filter. More...

#include <processor.h>

Inheritance diagram for EMAN::AzSharpProcessor:

Collaboration diagram for EMAN::AzSharpProcessor:

Public Member Functions
void	process_inplace (EMData *image)
	To process an image in-place. More...
string	get_name () const
	Get the processor's name. More...
string	get_desc () const
	Get the descrition of this specific processor. More...
TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (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...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
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 EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "filter.azimuthal.contrast"

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::Processor
Dict	params

Detailed Description

Similar to FourierProcessor, but enhances or compresses azimuthal contrast rather than the typical radial linear filter.

Parameters

az_scale

Scale factor, >1 enhances contrast <1 decreases

Definition at line 421 of file processor.h.

Member Function Documentation

get_desc()

string EMAN::AzSharpProcessor::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.

Implements EMAN::Processor.

Definition at line 436 of file processor.h.

                {
                        return "Typical linear filters are radial, but certain operations can lead to inhomogeneities so the balance between radial and azimuthal power is off. This processor permits enhancing or suppressing azimuthal contrast in Fourier space.";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

TypeDict EMAN::AzSharpProcessor::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::Processor.

Definition at line 441 of file processor.h.

                {
                        TypeDict d;
                        d.put("az_scale", EMObject::FLOAT, "Scale factor, >1 enhances contrast <1 decreases");
                        return d;
                }

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

NEW()

static Processor * EMAN::AzSharpProcessor::NEW ( )

inlinestatic

Definition at line 431 of file processor.h.

                {
                        return new AzSharpProcessor();
                }

process_inplace()

void AzSharpProcessor::process_inplace ( EMData *  image )

virtual

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters

image

The image to be processed.

Implements EMAN::Processor.

Definition at line 872 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        float az_scale=(float)params.set_default("az_scale",1.0);
        float cornerscale;
        EMData *fft;
 
        if (image->is_complex()) fft=image;
        else EMData *fft = image->do_fft();
 
        int nx=fft->get_xsize();
        int ny=fft->get_ysize();
        int nz=fft->get_zsize();
        if (nz!=1) {
        }
        else {
 
        }
        if (image->is_complex()) {
                EMData *ift = fft->do_ift();
 
                memcpy(image->get_data(),ift->get_data(),ift->get_xsize()*ift->get_ysize()*ift->get_zsize()*sizeof(float));
 
                delete fft;
                delete ift;
        }
 
        image->update();
}

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

Member Data Documentation

NAME

const string AzSharpProcessor::NAME = "filter.azimuthal.contrast"

static

Definition at line 448 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp