MeVisLabToolboxReference
ml::StdDeviationFilter Class Reference

This class is a kernel filtering operator, which calculates the standard deviation in the (defined by the kernel) neighborhood of a voxel. More...

#include <mlStdDeviationFilter.h>

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

List of all members.

Public Member Functions

 StdDeviationFilter ()
 Constructor.
BoolFieldgetCalcVarianceFld ()
 If enabled then the variance is calculated instead of the standard deviation.

Protected Member Functions

virtual void calculateOutputImageProperties (int outIndex)
 Computes the output image properties for output outIndex.
 CALC_ROW_H ()
 The implementation of the calculateOutputSubImage() method overloaded from Module is done in this macro.
template<typename DATATYPE >
void calcRow (MLsoffset *indexTab, size_t indexTabSize, MLsoffset srcVoxelOffset, size_t numVox, DATATYPE *inCursor, DATATYPE *outCursor, const ImageVector &)
 In this virtual template method the filtering of one row needs to be implemented.

Detailed Description

This class is a kernel filtering operator, which calculates the standard deviation in the (defined by the kernel) neighborhood of a 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 33 of file mlStdDeviationFilter.h.


Constructor & Destructor Documentation

ml::StdDeviationFilter::StdDeviationFilter ( )

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:

Also available are the fields access methods from KernelBaseModule:


Member Function Documentation

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

The implementation of the calculateOutputSubImage() method overloaded from Module is done in this macro.

It implements page border handling and a dispatcher to call the correct template version of calcRow() with the correct parameters. Note that CALC_ROW_CPP() also needs to be added in the .cpp file.

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

In this virtual 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::StdDeviationFilter::calculateOutputImageProperties ( int  outIndex) [protected, virtual]

Computes the output image properties for output outIndex.

Reimplemented from ml::KernelModule.

BoolField* ml::StdDeviationFilter::getCalcVarianceFld ( ) [inline]

If enabled then the variance is calculated instead of the standard deviation.

Default is off (= false).

Definition at line 60 of file mlStdDeviationFilter.h.


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