MeVisLabToolboxReference
ml::SigmaFilter Class Reference

A sigma filter class. More...

#include <mlSigmaFilter.h>

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

List of all members.

Public Member Functions

 SigmaFilter ()
 Constructor.
DoubleFieldgetSigmaFld () const
DoubleFieldgetStdDevMaxFld () const
BoolFieldgetMultSigmaWithLocalStdDevFld () const

Protected Member Functions

virtual void calculateOutputImageProperties (int outIndex)
 Computes the output image properties for output outIndex.
virtual void handleNotification (Field *field)
 Handle field changes.
virtual void activateAttachments ()
 Update internal state after loading.
 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.
 ML_MODULE_CLASS_HEADER (SigmaFilter)
 Macro to declare methods/functions of the runtime system interface of this class.

Detailed Description

A sigma filter class.

Definition at line 33 of file mlSigmaFilter.h.


Constructor & Destructor Documentation

ml::SigmaFilter::SigmaFilter ( )

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

virtual void ml::SigmaFilter::activateAttachments ( ) [protected, virtual]

Update internal state after loading.

Reimplemented from ml::KernelModule.

ml::SigmaFilter::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::SigmaFilter::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::SigmaFilter::calculateOutputImageProperties ( int  outIndex) [protected, virtual]

Computes the output image properties for output outIndex.

Reimplemented from ml::KernelModule.

BoolField& ml::SigmaFilter::getMultSigmaWithLocalStdDevFld ( ) const [inline]

Definition at line 62 of file mlSigmaFilter.h.

DoubleField& ml::SigmaFilter::getSigmaFld ( ) const [inline]

Definition at line 58 of file mlSigmaFilter.h.

DoubleField& ml::SigmaFilter::getStdDevMaxFld ( ) const [inline]

Definition at line 60 of file mlSigmaFilter.h.

virtual void ml::SigmaFilter::handleNotification ( Field field) [protected, virtual]

Handle field changes.

Reimplemented from ml::KernelModule.

ml::SigmaFilter::ML_MODULE_CLASS_HEADER ( SigmaFilter  ) [protected]

Macro to declare methods/functions of the runtime system interface of this class.

It is defined in mlRuntimeSubClass.h. Note that this class must be registered in the project initialization file by calling the initClass() function implemented in this macro.


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