MC3DDefs.h

Go to the documentation of this file.

/** 
* @file MC3DDefs.h
* @brief Common defines for the MikroCAD SDK library
*
* @author LMI Technologies
*/

#ifndef _MC3DDefs_h
#define _MC3DDefs_h

/**
The current version of the library, see also MC3D_Version()
*/
#define MC3D_VERSION 2

/**
The direction of filter
*/
enum eMC3DFilterDirection
{
   MC3DFilterDirection_X,            
   MC3DFilterDirection_Y,            
   MC3DFilterDirection_XY,            
};

/**
A structure for 3d coordinate transformation (rotation and translation)
*/
struct TCoordTransformation3DFloat
{
   float m_fA11;  /**< entry (1,1) of the rotation matrix */
   float m_fA12;  /**< entry (1,2) of the rotation matrix */
   float m_fA13;  /**< entry (1,3) of the rotation matrix */
   float m_fA21;  /**< entry (2,1) of the rotation matrix */
   float m_fA22;  /**< entry (2,2) of the rotation matrix */
   float m_fA23;  /**< entry (2,3) of the rotation matrix */
   float m_fA31;  /**< entry (3,1) of the rotation matrix */
   float m_fA32;  /**< entry (3,2) of the rotation matrix */
   float m_fA33;  /**< entry (4,3) of the rotation matrix */
   float m_fX0;   /**< Translation in X */
   float m_fY0;   /**< Translation in Y */
   float m_fZ0;   /**< Translation in Z */
};

/**
A structure for 2d coordinate transformation (rotation and translation)
*/
struct TCoordTransformation2DFloat
{
   float m_fA11;  /**< entry (1,1) of the rotation matrix */
   float m_fA12;  /**< entry (1,2) of the rotation matrix */
   float m_fA21;  /**< entry (2,1) of the rotation matrix */
   float m_fA22;  /**< entry (2,2) of the rotation matrix */
   float m_fA31;  /**< entry (3,1) of the rotation matrix */
   float m_fA32;  /**< entry (3,2) of the rotation matrix */
   float m_fX0;   /**< Translation in X */
   float m_fY0;   /**< Translation in Y */
};

/**
Mode for range analysis, how to binarize before doing the range analysis
*/
typedef enum
{
   RangeAnalysisEvalMode_Lower = 0,       /**< Binarize using lower limit */
   RangeAnalysisEvalMode_Upper = 1,       /**< Binarize using upper limit */
   RangeAnalysisEvalMode_Range = 2,       /**< Binarize using lower and upper limit */
} eRangeAnalysisEvalMode;

/**
Return value of the polynomial filter
*/
typedef enum
{
   PolynomialFilterReturnData_Difference = 0,   /**< Difference image */
   PolynomialFilterReturnData_Polynomial = 1,   /**< Polynomial image */
} ePolynomialFilterReturnData;

/**
Region of interest definition
*/
struct TROIShort
{
   short m_nX1;   /**< First X value */
   short m_nY1;   /**< Second X value */
   short m_nX2;   /**< First Y value */
   short m_nY2;   /**< Second Y value */
};

/**
Inner filter type in Fourier filter
*/
typedef enum
{
   FourierFilterType_WaveFilter = 1,      /**< Wave filter */
   FourierFilterType_GaussianHighpass = 2,   /**< Gaussian high pass filter */
} eFourierFilterType;

/**
Return value for Fourier filter
*/
typedef enum
{
   FourierFilterReturnData_Filter,     /**< Filter */
   FourierFilterReturnData_Roughness,  /**< Roughness data */
} eFourierFilterReturnData;

#endif // _MC3DDefs_h