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

Determines the direction of an approximate image gradient using David's image gradient processors. More...

#include <processor.h>

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

Public Member Functions

 GradientDirectionProcessor ()
 
string get_name () const
 Get the processor's name. 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 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...
 
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 = "math.gradient.direction"
 

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

Determines the direction of an approximate image gradient using David's image gradient processors.

Author
James Michael Bell
Date
06/26/2015

Definition at line 1048 of file processor.h.

Constructor & Destructor Documentation

◆ GradientDirectionProcessor()

EMAN::GradientDirectionProcessor::GradientDirectionProcessor ( )
inline

Definition at line 1051 of file processor.h.

1051{}

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

1066 {
1067 return "Determines the direction of the gradient of a 2D image.";
1068 }

◆ get_name()

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

1054 {
1055 return NAME;
1056 }
static const string NAME
Definition: processor.h:1076

References NAME.

◆ get_param_types()

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

1071 {
1072 TypeDict d;
1073 return d;
1074 }
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305

◆ NEW()

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

Definition at line 1060 of file processor.h.

1061 {
1062 return new GradientDirectionProcessor();
1063 }

References GradientDirectionProcessor().

◆ process_inplace()

void GradientDirectionProcessor::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 13012 of file processor.cpp.

13013{
13014 EMData* d = new EMData();
13015 int size = image->get_xsize() * image->get_ysize();
13016 image->process_inplace("math.edge.xgradient");
13017 d = image->process("math.edge.ygradient");
13018 for ( int i = 0; i < size; ++i ) {
13019 image->set_value_at_index(i,atan2(d->get_value_at_index(i),image->get_value_at_index(i)));
13020 }
13021 delete d;
13022}
EMData stores an image's data and defines core image processing routines.
Definition: emdata.h:82

Member Data Documentation

◆ NAME

const string GradientDirectionProcessor::NAME = "math.gradient.direction"
static

Definition at line 1076 of file processor.h.

Referenced by get_name().


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