MC3DDataExport.h

Go to the documentation of this file.

/** 
* @file MC3DDataExport.h
* @brief Function prototypes for data export functions
*
* @author LMI Technologies
*/

#ifndef _MC3DDataExport_h
#define _MC3DDataExport_h

#if defined(WIN32) || defined(WIN64)
#  include <windows.h>
#endif

#include "MC3DDefs.h"

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

#ifdef __cplusplus
extern "C"
{
#endif

/**
Scale short array to byte array.
Invalid values are becoming byInvalidValue (default 0), valid based on scale are between 1 and 255

@param   pnData         Input data array
@param   pbValid        Input valid array
@param   pbyData        Output data array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nFactor        Scaling factor used for scaling
@param   nOfs        Offset used for scaling
@param   byInvalidValue Value for invalid points
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_ShortArrayToByteArrayRel(
   short       *pnData,
   bool        *pbValid,
   unsigned char  *pbyData,
   short        nSizeX,
   short        nSizeY,
   int&         nFactor,
   int&         nOfs,
   unsigned char   byInvalidValue = 0);

/**
Scale short array to byte array based on given minimum and maximum
Invalid values are becoming byInvalidValue (default 0), valid based on scale are between 1 and 255

@param   pnData         Input data array
@param   pbValid        Input valid array
@param   pbyData        Output data array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nMinimum       Minimum used for scaling
@param   nMaximum       Maximum used for scaling
@param   byInvalidValue Value for invalid points
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_ShortArrayToByteArray(
   short       *pnData,
   bool        *pbValid,
   unsigned char  *pbyData,
   short        nSizeX,
   short        nSizeY,
   short        nMinimum,
   short        nMaximum,
   unsigned char   byInvalidValue = 0);

/**
Shrinks a short array by an given factor

@param   pnOut       Output data array
@param   pnIn        Input data array
@param   pbValidOut     Output valid array
@param   pbValidIn      Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nShrinkFactor  Shrink factor
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_ShrinkDataArrayShort(
   short *pnOut,
   short *pnIn,
   bool  *pbValidOut,
   bool  *pbValidIn,
   short  nSizeX,
   short  nSizeY,
   short  nShrinkFactor);


/**
Shrinks a byte array by an given factor

@param   pbyOut         Output data array
@param   pbyIn       Input data array
@param   pbValidOut     Output valid array
@param   pbValidIn      Input valid array
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nShrinkFactor  Shrink factor
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_ShrinkDataArrayByte(
   unsigned char     *pbyOut,
   unsigned char     *pbyIn,
   bool           *pbValidOut,
   bool           *pbValidIn,
   short           nSizeX,
   short           nSizeY,
   short           nShrinkFactor);

/**
Does a range analysis off an array of long

@param   plData         Input data array
@param   pnRanges    Output, number of ranges
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   lLowerLimit Lower limit
@param   lUpperLimit Upper limit
@param   EvalMode    Evaluation mode, see eRangeAnalysisEvalMode
@return              Number of ranges or negative in case of an error
*/
MC3D_EXPORT int __cdecl MC3D_RangeAnalysisLong(
   long              *plData,
   int                  *pnRanges,
   short              nSizeX,
   short              nSizeY,
   long               lLowerLimit,
   int                   lUpperLimit,
   eRangeAnalysisEvalMode   EvalMode);

/**
Does a range analysis of an array of short

@param   pnData         Input data array
@param   pnRanges    Output, number of ranges
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   nLowerLimit Lower limit
@param   nUpperLimit Upper limit
@param   EvalMode    Evaluation mode, see eRangeAnalysisEvalMode
@return              Number of ranges or negative in case of an error
*/
MC3D_EXPORT int __cdecl MC3D_RangeAnalysisShort(
   short             *pnData,
   int                  *pnRanges,
   short              nSizeX,
   short              nSizeY,
   short              nLowerLimit,
   short              nUpperLimit,
   eRangeAnalysisEvalMode   EvalMode);

/**
Does a range analysis of an array of float

@param   pfData            Input data array
@param   pnRanges       Output, number of ranges
@param   nSizeX            Size in X
@param   nSizeY            Size in Y
@param   fLowerLimit    Lower limit
@param   fUpperLimit    Upper limit
@param   EvalMode       Evaluation mode, see eRangeAnalysisEvalMode
@return                 Number of ranges or negative in case of an error
*/
MC3D_EXPORT int __cdecl MC3D_RangeAnalysisFloat(
   float             *pfData,
   int                  *pnRanges,
   short              nSizeX,
   short              nSizeY,
   float              fLowerLimit,
   float              fUpperLimit,
   eRangeAnalysisEvalMode   EvalMode);

/**
Does a range analysis of an array of double

@param   pdData         Input data array
@param   pnRanges    Output, number of ranges
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   dLowerLimit Lower limit
@param   dUpperLimit Upper limit
@param   EvalMode    Evaluation mode, see eRangeAnalysisEvalMode
@return              Number of ranges or negative in case of an error
*/
MC3D_EXPORT int __cdecl MC3D_RangeAnalysisDouble(
   double               *pdData,
   int                  *pnRanges,
   short              nSizeX,
   short              nSizeY,
   double                dLowerLimit,
   double                dUpperLimit,
   eRangeAnalysisEvalMode   EvalMode);

/**
Calculates the inverse of a double matrix

@param   pdMatrix    Input matrix
@param   pdInvMatrix Output inverted matrix
@param   nSize    Number of rows and columns
@return           Success (true) or failure
*/
MC3D_EXPORT bool  __cdecl MC3D_InverseMatrix(
   double   *pdMatrix,
   double   *pdInvMatrix,
   int       nSize);

/**
Calculates the inverse of a float matrix

@param   pfMatrix    Input matrix
@param   pfInvMatrix Output inverted matrix
@param   nSize       Number of rows and columns
@return              Success (true) or failure
*/
MC3D_EXPORT bool  __cdecl MC3D_InverseMatrixFloat(
   float *pfMatrix,
   float *pfInvMatrix,
   int       nSize);

/**
Calculates a sinus and cosine table, used for FFT

@param   pdCosTab    Output cosine table
@param   pdSinTab    Output sinus table
@param   lSize    Size of table
@param   bSinNegative   Is sin negative (inverted at x axis)
@return           Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_CreateSinusCosinusTable(
   double   *pdCosTab,
   double   *pdSinTab,
   long   lSize,
   bool   bSinNegative);

/**
Fast Fourier transformation

@param   pdCosValue     Output cosine values
@param   pdSinValue     Output sinus values
@param   pdCosTab    Input cosine table
@param   pdSinTab    Input sinus table
@param   lSize       Size of table
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_FastFourierTrafo(
   double   *pdCosValue,
   double   *pdSinValue,
   double   *pdCosTab,
   double   *pdSinTab,
   long   lSize);

/**
Fast Fourier transformation in a plane

@param   pfRealVal      Real values
@param   pfImagVal      Imaginary values
@param   nSizeX         Size in X
@param   nSizeY         Size in Y
@param   Direction      Filter direction
@param   bBackTrafo     True if back transformation, otherwise false
@return              Success (true) or failure
*/
MC3D_EXPORT bool __cdecl MC3D_FastFourierTrafo2D(
   float             *pfRealVal,
   float             *pfImagVal,
   short              nSizeX,
   short              nSizeY,
   eMC3DFilterDirection  Direction,
   bool               bBackTrafo);

#ifdef __cplusplus
}
#endif

#endif // _MC3DDataExport_h