MeVisLabToolboxReference
Public Types | Public Member Functions | Static Public Attributes
ml::CompassFilter Class Reference

A class implementing different compass filters. More...

#include <mlCompassFilter.h>

Inheritance diagram for ml::CompassFilter:
ml::KernelModule ml::KernelBaseModule ml::Module ml::FieldContainer ml::Base

List of all members.

Public Types

enum  CompassFilterSelect {
  PREWITT = 0, KIRSCH, ROBINSON_3_LEVEL, ROBINSON_5_LEVEL,
  NUM_COMPASS_FILTER_SELECTS
}
 Enum to describe the possible kernels available for compass filtering. More...
enum  DirectionSelect {
  EAST = 0, NORTH_EAST, NORTH, NORTH_WEST,
  WEST, SOUTH_WEST, SOUTH, SOUTH_EAST,
  ALL_DIRECTIONS, NUM_DIRECTION_SELECTS
}
 Directions in which the compass filtering can take place. More...

Public Member Functions

 CompassFilter ()
 Constructor.
Field access. Refer to field documentation for more infos.
EnumField * getCompassFilterSelectFld () const
EnumField * getDirectionFld () const
IntField * getDirectionIntFld () const

Static Public Attributes

static const char *const CompassFilterSelectNames []
 Null terminated string names corresponding to the CompassFilterSelect enum.
static const char *const DirectionNames []
 Null terminated string names corresponding to the DirectionSelect enum.

Detailed Description

A class implementing different compass filters.

It is possible to filter with a certain direction or all directions together where the maximum results to the output voxel. For related code and more information see mlKernelExample.h, mlKernel.h, mlKernelBaseModule.h, mlKernelModule.h, mlKernelEditor.h, mlRankFilter.h, mlExtConvolutionFilter.h, mlKernelMacros, mlKernelTools.h and mlConvolutionFilter.h.

Definition at line 34 of file mlCompassFilter.h.

Member Enumeration Documentation

enum ml::CompassFilter::CompassFilterSelect

Enum to describe the possible kernels available for compass filtering.

Enumerator:
PREWITT 
KIRSCH 
ROBINSON_3_LEVEL 
ROBINSON_5_LEVEL 
NUM_COMPASS_FILTER_SELECTS 

Definition at line 41 of file mlCompassFilter.h.

enum ml::CompassFilter::DirectionSelect

Directions in which the compass filtering can take place.

Enumerator:
EAST 
NORTH_EAST 
NORTH 
NORTH_WEST 
WEST 
SOUTH_WEST 
SOUTH 
SOUTH_EAST 
ALL_DIRECTIONS 
NUM_DIRECTION_SELECTS 

Definition at line 59 of file mlCompassFilter.h.

Constructor & Destructor Documentation

ml::CompassFilter::CompassFilter ( )

Constructor.

Initializes the fields, the members and the field connections with the field container.

Also available are the fields access methods from KernelBaseModule:

Member Function Documentation

EnumField* ml::CompassFilter::getCompassFilterSelectFld ( ) const [inline]

Definition at line 95 of file mlCompassFilter.h.

EnumField* ml::CompassFilter::getDirectionFld ( ) const [inline]

Definition at line 96 of file mlCompassFilter.h.

IntField* ml::CompassFilter::getDirectionIntFld ( ) const [inline]

Definition at line 97 of file mlCompassFilter.h.

Member Data Documentation

const char* const ml::CompassFilter::CompassFilterSelectNames[] [static]

Null terminated string names corresponding to the CompassFilterSelect enum.

Definition at line 52 of file mlCompassFilter.h.

const char* const ml::CompassFilter::DirectionNames[] [static]

Null terminated string names corresponding to the DirectionSelect enum.

Definition at line 77 of file mlCompassFilter.h.

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