EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
EMAN::BinaryExternalGradientProcessor Class Reference

Computes an external morphological gradient operation on an image. More...

#include <processor.h>

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

Public Member Functions

 BinaryExternalGradientProcessor ()
 
string get_name () const
 Get the processor's name. More...
 
virtual EMDataprocess (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 ProcessorNEW ()
 
- 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 = "morph.ext_grad.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

Computes an external morphological gradient operation on an image.

Author
James Michael Bell
Date
06/27/2015

Definition at line 1442 of file processor.h.

Constructor & Destructor Documentation

◆ BinaryExternalGradientProcessor()

EMAN::BinaryExternalGradientProcessor::BinaryExternalGradientProcessor ( )
inline

Definition at line 1445 of file processor.h.

1445{}

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

1462 {
1463 return "Computes an external morphological graduent using k-pixel-width operations on a (binary) image.";
1464 }

◆ get_name()

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

1448 {
1449 return NAME;
1450 }

References NAME.

◆ get_param_types()

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

1467 {
1468 TypeDict d;
1469 d.put("radius", EMObject::INT, "The number of pixels (radius) to dilate the input image.");
1470 d.put("iters",EMObject::INT, "The number of times to apply this process to the input image.");
1471 d.put("thresh", EMObject::FLOAT,"Only considers densities above the threshold");
1472 return d;
1473 }
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::EMObject::INT, and EMAN::TypeDict::put().

◆ NEW()

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

Definition at line 1456 of file processor.h.

1457 {
1459 }

References BinaryExternalGradientProcessor().

◆ process()

EMData * BinaryExternalGradientProcessor::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
imageThe 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 15302 of file processor.cpp.

15303{
15304 EMData* proc = image->copy();
15305 proc->process_inplace("morph.gradient.external",params);
15306 return proc;
15307}
EMData stores an image's data and defines core image processing routines.
Definition: emdata.h:82

References EMAN::Processor::params.

◆ process_inplace()

void BinaryExternalGradientProcessor::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
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 15309 of file processor.cpp.

15310{
15311 int iters = params.set_default("iters",1);
15312 float thresh = params.set_default("thresh",0.5);
15313 image->process_inplace("threshold.binary",Dict("value",thresh));
15314
15315 for (int i = 0; i < iters; i++){
15316 EMData *cpy = image->copy();
15317 image->process_inplace("morph.dilate.binary",params);
15318 image->sub(*cpy);
15319 delete cpy;
15320 }
15321}
Dict is a dictionary to store <string, EMObject> pair.
Definition: emobject.h:385
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, and EMAN::Dict::set_default().

Member Data Documentation

◆ NAME

const string BinaryExternalGradientProcessor::NAME = "morph.ext_grad.binary"
static

Definition at line 1475 of file processor.h.

Referenced by get_name().


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