MeVisLab/Standard/Sources/ML/MLKernel/mlSurroundFilter.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
// Prevent multiple including of this file.
#if !defined(__mlSurroundFilter_H)
#define __mlSurroundFilter_H

// ML-includes
#ifndef __mlInitSystemKernel_H
#include "mlInitSystemKernel.h"
#endif
#ifndef __mlKernelModule_H
#include "mlKernelModule.h"
#endif

ML_START_NAMESPACE

  //--------------------------------------------------
  //--------------------------------------------------
  class MLKERNELEXPORT SurroundFilter : public KernelModule{

  public:

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    enum DimensionSelect{USE2D                = 0,
                         USE3D                ,

                         NUM_DIMENSION_SELECTS};

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    static const char* const DimensionSelectNames[];

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    enum Neighbourhood2DSelect{USE4                        = 0,
                               USE8                        ,

                               NUM_NEIGHBOURHOOD_2D_SELECTS};

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    static const char* const Neighbourhood2DSelectNames[];

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    enum Neighbourhood3DSelect{USE6                        = 0,
                               USE18                       ,
                               USE26                       ,

                               NUM_NEIGHBOURHOOD_3D_SELECTS};

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    static const char* const Neighbourhood3DSelectNames[];

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    enum BorderLocation {SET_INNER_BORDER    = 0,
                         SET_OUTER_BORDER    ,
                         SET_BOTH_BORDERS    ,

                         NUM_BORDER_LOCATIONS};

    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    static const char* const BorderLocationNames[];



    //-------------------------------------------------------------------
    //-------------------------------------------------------------------
    SurroundFilter();

    //-------------------------------------------------------------------

    //-------------------------------------------------------------------
    EnumField  * getDimensionSelectFld      () const { return _dimensionSelectFld      ; }
    EnumField  * getNeighbourhood2DSelectFld() const { return _neighbourhood2DSelectFld; }
    EnumField  * getNeighbourhood3DSelectFld() const { return _neighbourhood3DSelectFld; }
    EnumField  * getBorderLocationFld       () const { return _borderLocationFld       ; }
    DoubleField* getOuterBorderValueFld     () const { return _outerBorderValueFld     ; }
    DoubleField* getInnerBorderValueFld     () const { return _innerBorderValueFld     ; }
    DoubleField* getLowerThresholdFld       () const { return _lowerThresholdFld       ; }
    DoubleField* getUpperThresholdFld       () const { return _upperThresholdFld       ; }
    BoolField  * getOnlyBorderFld           () const { return _onlyBorderFld           ; }
    BoolField  * getTakeMaxFld              () const { return _takeMaxFld              ; }
    BoolField  * getTakeMiddleFld           () const { return _takeMiddleFld           ; }

protected:

    CALC_ROW_H();

    template <typename DATATYPE>
      void calcRow(MLsoffset    *indexTab,
                   size_t       indexTabSize,
                   MLsoffset    /*srcVoxelOffset*/,
                   size_t       numVox,
                   DATATYPE     *inCursor,
                   DATATYPE     *outCursor,
                   const ImageVector &/*rowStart*/);

    virtual void handleNotification(Field* field);

    virtual void calculateOutputImageProperties(int outIndex);

    // We overload this kernel update method to overwrite kernel settings resulting
    // from inherited functionality.
    virtual void _userKernelPostUpdate();


  private:

    EnumField*   _dimensionSelectFld;

    EnumField*   _neighbourhood2DSelectFld;

    EnumField*   _neighbourhood3DSelectFld;

    EnumField*   _borderLocationFld;

    DoubleField* _outerBorderValueFld;

    DoubleField* _innerBorderValueFld;

    DoubleField* _lowerThresholdFld;

    DoubleField* _upperThresholdFld;

    BoolField*   _onlyBorderFld;

    BoolField*   _takeMaxFld;

    BoolField*   _takeMiddleFld;

    BoolField*   _twoDimFld;



    MLint          _voxelIndex;

    KernelDataType _values2D[9];

    KernelDataType _values3D[27];

    static bool    _mask2Duse4[9];

    static bool    _mask2Duse8[9];

    static bool    _mask3Duse6[27];

    static bool    _mask3Duse18[27];

    static bool    _mask3Duse26[27];

    ML_MODULE_CLASS_HEADER(SurroundFilter);
 };

ML_END_NAMESPACE

#endif //of __mlSurroundFilter_H