EMAN::BinaryTopHatProcessor Class Reference

Performs a morphological top hat operation on an image. More...

#include <processor.h>

Inheritance diagram for EMAN::BinaryTopHatProcessor:

Collaboration diagram for EMAN::BinaryTopHatProcessor:

Public Member Functions
	BinaryTopHatProcessor ()
string	get_name () const
	Get the processor's name. More...
virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...
void	process_inplace (EMData *image)
	To process an image in-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 = "morph.tophat.binary"

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

Performs a morphological top hat operation on an image.

Author

James Michael Bell

Date

06/27/2015

Definition at line 1526 of file processor.h.

Constructor & Destructor Documentation

BinaryTopHatProcessor()

EMAN::BinaryTopHatProcessor::BinaryTopHatProcessor ( )

inline

Definition at line 1529 of file processor.h.

{}

Referenced by NEW().

Member Function Documentation

get_desc()

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

                {
                        return "Performs a morphological top hat operation on a (binary) image.";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

                {
                        TypeDict d;
                        d.put("radius", EMObject::INT, "The number of pixels (radius) to dilate the input image.");
                        d.put("iters",EMObject::INT, "The number of times to apply this process to the input image.");
                        d.put("thresh", EMObject::FLOAT,"Only considers densities above the threshold");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 1540 of file processor.h.

                {
                        return new BinaryTopHatProcessor();
                }

References BinaryTopHatProcessor().

process()

EMData * BinaryTopHatProcessor::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 15344 of file processor.cpp.

{
        EMData* proc = image->copy();
        proc->process_inplace("morph.tophat.binary",params);
        return proc;
}

References EMAN::Processor::params.

process_inplace()

void BinaryTopHatProcessor::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 15351 of file processor.cpp.

{
        int iters=params.set_default("iters",1);
        float thresh = params.set_default("thresh",0.5);
        image->process_inplace("threshold.binary",Dict("value",thresh));
 
        for (int i = 0; i < iters; i++){
                EMData* open = image->process("morph.open.binary",params);
                image->sub(*open);
                delete open;
        }
}

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

Member Data Documentation

NAME

const string BinaryTopHatProcessor::NAME = "morph.tophat.binary"

static

Definition at line 1559 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp