MC3DFilterExport.h

Go to the documentation of this file.

/** 
* @file MC3DFilterExport.h
* @brief Function prototypes for filter functions
*
* @author LMI Technologies
*/

#ifndef _MC3DFilterExport_h
#define _MC3DFilterExport_h

#include <stddef.h>

#include "MC3DDefs.h"

#if defined(WIN32) || defined(WIN64)
#  define MC3D_EXPORT __declspec(dllexport)
#else
#  define MC3D_EXPORT    
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/**
Average filter

@param   pnOut          Output data array
@param   pnIn           Input data array
@param   pbValid        Input valid array
@param   nSizeX            Size in X
@param   nSizeY            Size in Y
@param   nFilterSizeX      Filter size in X
@param   nFilterSizeY      Filter size in Y
@param   Direction         Filter direction
@return                 Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_AverageFilter(
   short             *pnOut,
   short             *pnIn,
   bool              *pbValid,
   short              nSizeX,
   short              nSizeY,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction);

/**
Median filter, old version

@param   pnOut          Output data array
@param   pnIn           Input data array
@param   pbValid        Input valid array
@param   nSizeX            Size in X
@param   nSizeY            Size in Y
@param   nFilterSizeX      Filter size in X
@param   nFilterSizeY      Filter size in Y
@param   Direction         Filter direction
@return                 Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_MedianFilter(
   short             *pnOut,
   short             *pnIn,
   bool              *pbValid,
   short              nSizeX,
   short              nSizeY,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction);

/**
Median filter, new more robust version

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValid     Input valid array
@param   pbMarkingValid Input mask array, can be NULL
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFilterSizeX   Filter size in X
@param   nFilterSizeY   Filter size in Y
@param   Direction      Filter direction
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_MedianFilterRobust(
   short             *pnOut,
   short             *pnIn,
   bool              *pbValid,
   bool              *pbMarkingValid,
   short              nSizeX,
   short              nSizeY,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction);

/**
Median filter, line based

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   AOI         Area of interest
@param   nFilterSizeX   Filter size in X
@param   nFilterSizeY   Filter size in Y
@param   Direction      Filter direction
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_MedianFilterLine(
   short             *pnOut,
   short             *pnIn,
   short              nSizeX,
   short              nSizeY,
   RECT&              AOI,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction);

/**
Gauss filter, line based

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValid     Valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFilterSizeX   Filter size in X
@param   nFilterSizeY   Filter size in Y
@param   Direction      Filter direction
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_GaussianFilter(
   short             *pnOut,
   short             *pnIn,
   bool*              pbValid,
   short              nSizeX,
   short              nSizeY,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction);

/**
Remove invalid filter

@param   pnOut          Output data array
@param   pnIn           Input data array
@param   pbValid        Input valid array
@param   pbMask            Input mask array
@param   nSizeX            Size in X
@param   nSizeY            Size in Y
@param   nFilterSizeX      Filter size in X
@param   nFilterSizeY      Filter size in Y
@param   Direction         Filter direction
@param   lMaximalRadius    Maximum radius of invalid area
@param   bUseEdges         Include edges/border
@param   lEnlargeInvalid   Enlarge invalid area
@return                 Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_RemoveInvalid(
   short             *pnOut,
   short             *pnIn,
   bool              *pbValid,
   bool              *pbMask,
   short              nSizeX,
   short              nSizeY,
   short              nFilterSizeX,
   short              nFilterSizeY,
   eMC3DFilterDirection  Direction,
   long               lMaximalRadius,
   bool               bUseEdges,
   long               lEnlargeInvalid);

/**
Remove peaks filter

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValid     Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFilterSize Filter size
@param   fWeight     Weighting factor
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_RemovePeaks(
   short *pnOut,
   short *pnIn,
   bool *pbValid,
   short  nSizeX,
   short  nSizeY,
   short  nFilterSize,
   float  fWeight = 3.2);

/**
Lowpass filter

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValid     Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFilterSize Filter size
@param   nRepeat     Number of repetitions
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_LowpassFilter(
   short *pnOut,
   short *pnIn,
   bool  *pbValid,
   short  nSizeX,
   short  nSizeY,
   short  nFilterSize,
   short  nRepeat);

/**
Highpass filter

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValid     Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFilterSize Filter size
@param   nRepeat     Number of repetitions
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_HighpassFilter(
   short *pnOut,
   short *pnIn,
   bool  *pbValid,
   short  nSizeX,
   short  nSizeY,
   short  nFilterSize,
   short  nRepeat);

/**
Polynomial filter

@param   pnOut             Output data array
@param   pnIn              Input data array
@param   pbValid           Input valid array
@param   pbMask               Input mask array
@param   nSizeX               Size in X
@param   nSizeY               Size in Y
@param   nPolynomialOrder     Polynomial degree (0...8)
@param   ReturnData           Return data type
@param   pfPolynomialParameter   (Output) polynomial parameter
@return                    Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_PolynomialFilter(
   short                   *pnOut,
   short                   *pnIn,
   bool                    *pbValid,
   bool                    *pbMask,
   short                    nSizeX,
   short                    nSizeY,
   short                    nPolynomialOrder,
   ePolynomialFilterReturnData       ReturnData = PolynomialFilterReturnData_Difference,
   float                   *pfPolynomialParameter = NULL);

/**
Alignment - get transformation matrix

@param   pnData         Data array
@param   pbValid     Valid array
@param   pbMask         Mask array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   fScaleX     Scaling factor in X
@param   fScaleY     Scaling factor in Y
@param   fScaleZ     Scaling factor in Z
@param   pTrafo         (Output) Transformation matrix
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_GetAlignmentTransformationMatrix(
   short                *pnData,
   bool                 *pbValid,
   bool                 *pbMask,
   short                 nSizeX,
   short                 nSizeY,
   float                 fScaleX,
   float                 fScaleY,
   float                 fScaleZ,
   TCoordTransformation3DFloat   *pTrafo);

/**
Align with a given transformation matrix

@param   pnOut    Output data array
@param   pnIn     Input data array
@param   pbValid  In- and output valid array
@param   nSizeX      Size in X
@param   nSizeY      Size in Y
@param   fScaleX  Scaling factor in X
@param   fScaleY  Scaling factor in Y
@param   fScaleZ  Scaling factor in Z
@param   pTrafo      (Output) Transformation matrix
@return           Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_Transformation(
   short                *pnOut,
   short                *pnIn,
   bool                 *pbValid,
   short                 nSizeX,
   short                 nSizeY,
   float                 fScaleX,
   float                 fScaleY,
   float                 fScaleZ,
   TCoordTransformation3DFloat   *pTrafo);

/**
Align with valid array

@param   pnData      In- and output data array
@param   pbValid  In- and output valid array
@param   pbMask      Mask array
@param   nSizeX      Size in X
@param   nSizeY      Size in Y
@param   fScaleX  Scaling factor in X
@param   fScaleY  Scaling factor in Y
@param   fScaleZ  Scaling factor in Z
@return           Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_Alignment(
   short* pnData,
   bool* pbValid,
   bool* pbMask,
   short nSizeX,
   short nSizeY,
   float fScaleX,
   float fScaleY,
   float fScaleZ);

/**
Fourier filter in the plane

@param   pnOut             Output data array
@param   pnIn              Input data array
@param   pbValid           Valid array
@param   pROI              Region of interest
@param   nSizeX               Size in X
@param   nSizeY               Size in Y
@param   nCuttOffWaveLength      Threshold wavelength (pixel)
@param   InnerFilterType      Inner filter type
@param   nRepeat           Number of repetitions
@param   ReturnData           Return type
@return                    Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_FourierFilter2D(
   short                *pnOut,
   short                *pnIn,
   bool                 *pbValid,
   TROIShort               *pROI,
   short                 nSizeX,
   short                 nSizeY,
   int                      nCuttOffWaveLength,
   eFourierFilterType          InnerFilterType,
   short                 nRepeat,
   eFourierFilterReturnData    ReturnData);

/**
Polynomial estimation in the plane or its difference from the input data

@param   pfValue        Data array
@param   pfPolynomParam    Polynomial parameter
@param   nSizeX            Size in X
@param   nPolynomialOrder  Polynomial order
@param   bDifference    Difference as output
@return                 Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_Polynom2D(
   float *pfValue,
   float *pfPolynomParam,
   int       nSizeX,
   short  nPolynomialOrder,
   bool   bDifference);

/**
Fourier-Lorenzfilter in the plane

@param   pfValue        Data array
@param   nNumValues        Number of values
@param   nCutOffWaveLength Threshold wavelength (pixel)
@return                 Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_FourierLorenzFilter2D(
   float *pfValue,
   short  nNumValues,
   short  nCutOffWaveLength);

#ifdef __cplusplus
}
#endif

#endif // _MC3DFilterExport_h