MeVisLabToolboxReference
ml::LocalMaximaFilter Class Reference

Class searching local maxima in images using a kernel based filtering. More...

#include <mlLocalMaximaFilter.h>

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

List of all members.

Public Member Functions

 LocalMaximaFilter ()
 Constructor.
Field access. Refer to field documentation for more infos.
BoolFieldgetReturnSourceValueField () const
BoolFieldgetCalculateMinimaField () const
BoolFieldgetCalculateRealMaximaField () const

Protected Member Functions

virtual void calculateOutputImageProperties (int outIndex)
 Computes the output image properties for output outIndex.
 CALC_ROW_H ()
 Macro which needs to be added to the implementation of a class derived from KernelModule or KernelBaseModule.
template<typename DATATYPE >
void calcRow (MLsoffset *indexTab, size_t indexTabSize, MLsoffset srcVoxelOffset, size_t numVox, DATATYPE *inCursor, DATATYPE *outCursor, const ImageVector &)
 In this template method the filtering of one row needs to be implemented.

Detailed Description

Class searching local maxima in images using a kernel based filtering.

This module calculates whether a voxel is a local maxima in a user-defined neighborhood (defined by the size of the kernel).

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 35 of file mlLocalMaximaFilter.h.


Constructor & Destructor Documentation

ml::LocalMaximaFilter::LocalMaximaFilter ( )

Constructor.

Initializes the fields, the members and the field connections with the image output.

Note that with the following method calls an additional field interface is created as described in KernelModule and KernelBaseModule:

  • _createKernelExtentFields (6, ImageVector(5,5,1,1,1,1));
  • _createMakeSphericalField (false);
  • _createNormalizeField (true);
  • _createExternalKernelFields (true, false);
  • _createKernelInfoField();
  • _createKernelOutputField();
  • _createImageIntervalFields (0.1, 2000, true, false);
  • _createKernelIntervalFields (30, 50, true, false);
  • _createMinMaxCalcFields (true, true);
  • _createMinMaxFields (true);

Also available are the fields access methods from KernelBaseModule:


Member Function Documentation

ml::LocalMaximaFilter::CALC_ROW_H ( ) [protected]

Macro which needs to be added to the implementation of a class derived from KernelModule or KernelBaseModule.

It guarantees that the correct template functions are called for images with any data type. It also overloads calculateOutputSubImage() of the base class Module. Note that CALC_ROW_CPP() also needs to be added to the .cpp file.

template<typename DATATYPE >
void ml::LocalMaximaFilter::calcRow ( MLsoffset indexTab,
size_t  indexTabSize,
MLsoffset  srcVoxelOffset,
size_t  numVox,
DATATYPE *  inCursor,
DATATYPE *  outCursor,
const ImageVector  
) [protected]

In this template method the filtering of one row needs to be implemented.

It will be called by the CALC_ROW_H() / CALC_ROW_CPP() macro.

virtual void ml::LocalMaximaFilter::calculateOutputImageProperties ( int  outIndex) [protected, virtual]

Computes the output image properties for output outIndex.

Reimplemented from ml::KernelModule.

BoolField& ml::LocalMaximaFilter::getCalculateMinimaField ( ) const [inline]

Definition at line 69 of file mlLocalMaximaFilter.h.

BoolField& ml::LocalMaximaFilter::getCalculateRealMaximaField ( ) const [inline]

Definition at line 70 of file mlLocalMaximaFilter.h.

BoolField& ml::LocalMaximaFilter::getReturnSourceValueField ( ) const [inline]

Definition at line 68 of file mlLocalMaximaFilter.h.


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