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

#include <processor.h>

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

Public Member Functions

 YGradientProcessor ()
 
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 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 = "math.edge.ygradient"
 

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

Definition at line 908 of file processor.h.

Constructor & Destructor Documentation

◆ YGradientProcessor()

EMAN::YGradientProcessor::YGradientProcessor ( )
inline

Definition at line 911 of file processor.h.

911{}

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

926 {
927 return "Determines the image gradient in the y direction";
928 }

◆ get_name()

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

914 {
915 return NAME;
916 }
EMAN::YGradientProcessor::NAME
static const string NAME
Definition: processor.h:937

References NAME.

◆ get_param_types()

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

932 {
933 TypeDict d;
934 return d;
935 }
EMAN::TypeDict
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305

◆ NEW()

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

Definition at line 920 of file processor.h.

921 {
922 return new YGradientProcessor();
923 }

References YGradientProcessor().

◆ process_inplace()

void YGradientProcessor::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 12890 of file processor.cpp.

12891{
12892 if (image->is_complex()) throw ImageFormatException("Cannot edge detect a complex image");
12893
12894 EMData* e = new EMData();
12895 int nx = image->get_xsize();
12896 int ny = image->get_ysize();
12897 int nz = image->get_zsize();
12898
12899 if ( nz == 1 && ny == 1 ) {
12900 throw ImageDimensionException("Error - cannot detect Y edges for an image that that is 1D!");
12901 } else if ( nz == 1 ) {
12902 if ( nx < 3 || ny < 3 ) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
12903 e->set_size(3,3,1);
12904 e->set_value_at(0,0,-1);
12905 e->set_value_at(1,0,-2);
12906 e->set_value_at(2,0,-1);
12907
12908 e->set_value_at(0,2,1);
12909 e->set_value_at(1,2,2);
12910 e->set_value_at(2,2,1);
12911 Region r = Region(-nx/2+1,-ny/2+1,nx,ny);
12912 e->clip_inplace(r);
12913 } else {
12914 if ( nx < 3 || ny < 3 || nz < 3) throw ImageDimensionException("Error - cannot edge detect an image with less than three pixels");
12915 e->set_size(3,3,3);
12916 e->set_value_at(0,0,0,-1);
12917 e->set_value_at(1,0,0,-1);
12918 e->set_value_at(2,0,0,-1);
12919 e->set_value_at(0,0,1,-1);
12920 e->set_value_at(1,0,1,-8);
12921 e->set_value_at(2,0,1,-1);
12922 e->set_value_at(0,0,2,-1);
12923 e->set_value_at(1,0,2,-1);
12924 e->set_value_at(2,0,2,-1);
12925
12926 e->set_value_at(0,2,0,1);
12927 e->set_value_at(1,2,0,1);
12928 e->set_value_at(2,2,0,1);
12929 e->set_value_at(0,2,1,1);
12930 e->set_value_at(1,2,1,8);
12931 e->set_value_at(2,2,1,1);
12932 e->set_value_at(0,2,2,1);
12933 e->set_value_at(1,2,2,1);
12934 e->set_value_at(2,2,2,1);
12935
12936 Region r = Region(-nx/2+1,-ny/2+1,-nz/2+1,nx,ny,nz);
12937 e->clip_inplace(r);
12938 }
12939
12940 Dict conv_parms;
12941 conv_parms["with"] = e;
12942 image->process_inplace("math.convolution", conv_parms);
12943 image->process_inplace("xform.phaseorigin.tocenter");
12944
12945 delete e;
12946}
EMAN::Dict
Dict is a dictionary to store <string, EMObject> pair.
Definition: emobject.h:385
EMAN::EMData
EMData stores an image's data and defines core image processing routines.
Definition: emdata.h:82
EMAN::EMData::clip_inplace
void clip_inplace(const Region &area, const float &fill_value=0)
Clip the image inplace - clipping region must be smaller than the current region internally memory is...
Definition: emdata.cpp:350
EMAN::Region
Region defines a 2D or 3D rectangular region specified by its origin coordinates and all edges' sizes...
Definition: geometry.h:497
ImageFormatException
#define ImageFormatException(desc)
Definition: exception.h:147
ImageDimensionException
#define ImageDimensionException(desc)
Definition: exception.h:166

References EMAN::EMData::clip_inplace(), ImageDimensionException, and ImageFormatException.

Member Data Documentation

◆ NAME

const string YGradientProcessor::NAME = "math.edge.ygradient"
static

Definition at line 937 of file processor.h.

Referenced by get_name().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.2