This processor filters an image to improve the visibility of particles. More...

#include <processor.h>

Inheritance diagram for EMAN::EnhanceProcessor:

Collaboration diagram for EMAN::EnhanceProcessor:

[legend]

Public Member Functions
	EnhanceProcessor ()

string	get_name () const
	Get the processor's name. More...

virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. 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 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.enhance"

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

This processor filters an image to improve the visibility of particles.

The resulting images are primarily useful for visualization rather than processing. A/pix must be set correctly for it to work.

Author: Steve Ludtke

Date: 2019/02/09

Definition at line 785 of file processor.h.

Constructor & Destructor Documentation

◆ EnhanceProcessor()

EMAN::EnhanceProcessor::EnhanceProcessor ( )

inline

Definition at line 788 of file processor.h.

788{}

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                        {
                                return "Visual enhancement filter useful for localizing particles. Results not designed for reconstruction.";
                        }

◆ get_name()

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

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
//                              d.put("kx", EMObject::INT, "Kx location of the slice in Fourier pixels");
//                              d.put("ky", EMObject::INT, "Ky location of the slice in Fourier pixels");
//                              d.put("jkx", EMObject::INT, "Jx+Kx location of the slice in Fourier pixels");
//                              d.put("jky", EMObject::INT, "Jy+Ky location of the slice in Fourier pixels");
//                              d.put("k", EMObject::FLOAT, "Radius of slice in Fourier pixels, integrates over angle.");
//                              d.put("rfp", EMObject::INT, "Returns a non square 2-D image containing rotational invariants organized such that X=azimuth. Used for rotational alignment.");
//                              d.put("fp", EMObject::INT, "Returns a non-square 2-D image containing n rotationally integrated planes. R&T invariant.");
//                              d.put("ffp", EMObject::INT, "Returns a 3-D volume containing n rotationally integrated planes. R&T invariant. This is normally further processed with CTF info to produce fp equivalent.");
//                              d.put("size", EMObject::INT, "If specified, will determine the size (x/y) of the real-space bispectrum image. If not set, a size is selected automatically");
                                return d;
                        }

◆ NEW()

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

inlinestatic

Definition at line 799 of file processor.h.

                        {
                                return new EnhanceProcessor();
                        }

References EnhanceProcessor().

◆ process()

EMData * EnhanceProcessor::process ( const EMData *const image )

virtual

To proccess an image out-of-place.

For those processors which can only be processed out-of-place, override this function to give the right behavior.

Parameters

image The image will be copied, actual process happen on copy of image.

Returns: the image processing result, may or may not be the same size of the input image

Reimplemented from EMAN::Processor.

Definition at line 10362 of file processor.cpp.

{
        int nx=image->get_xsize();
        int nz=image->get_xsize();
        EMData * result = image->process("filter.highpass.gauss",Dict("cutoff_freq",0.01f));
        if (nz==1) result->process_inplace("mask.decayedge2d",Dict("width",nx/50));
        result->add(-float(result->get_attr("minimum")));
        result->process_inplace("filter.lowpass.tophat",Dict("cutoff_freq",0.05));
        result->process_inplace("math.squared");
        result->process_inplace("filter.lowpass.gauss",Dict("cutoff_freq",10.0f/(nx/40*(float)image->get_attr("apix_x"))));
        result->process_inplace("normalize.edgemean");
        
        return result;
}

Referenced by process_inplace().

◆ process_inplace()

void EnhanceProcessor::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 10377 of file processor.cpp.

{
        // slightly inefficient, but best we can easily do
        EMData *tmp = process(image);
        memcpy(image->get_data(),tmp->get_data(),image->get_size()*sizeof(float));
        delete tmp;
        return;
}

References process().

Member Data Documentation

◆ NAME

const string EnhanceProcessor::NAME = "filter.enhance"

static

Definition at line 824 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EnhanceProcessor()

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process()

◆ process_inplace()

Member Data Documentation

◆ NAME