zxh.h

/*=========================================================================

  Program:   ZXH Registration Software
  Author:    Xiahai Zhuang
  Module:    $RCSfle: zxh.h    $
  Language:  C++
  Date:      $Date: From  2004-01 $
  Version:   $Revision: 1.0, 2.0 $

=========================================================================*/

extern int glbVerboseOutput ;


#ifndef zxh_h
#define zxh_h
#include "zxhDllExport.h"
#include <fstream>
#include <sstream>
#include <iostream>
#include <string>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>

namespace zxh
{

#ifndef zxhuchar
#define zxhuchar unsigned char
#endif
#ifndef zxhushort
#define zxhushort unsigned short int
#endif
#ifndef zxhlfloat
#define zxhlfloat long double
#endif
#ifndef ImageDimensionMax
#define ImageDimensionMax 4
#endif
#ifndef ZXH_PI
#define ZXH_PI 3.14159f
#endif
#ifndef ZXH_GrayLevelOfSurface
#define ZXH_GrayLevelOfSurface 1
#endif
#ifndef ZXH_Protect_Small_Float
#define ZXH_Protect_Small_Float 100000
#endif
#ifndef ZXH_FloatPrecision
#define ZXH_FloatPrecision 1.0e-20f
#endif
#ifndef ZXH_LFloatPrecision
#define ZXH_LFloatPrecision 1.0e-200
#endif
#ifndef ZXH_Background
#define ZXH_Background 0
#endif
#ifndef ZXH_EMPTY  
#define ZXH_EMPTY -32768
#endif
#ifndef ZXH_Foreground
#define ZXH_Foreground 1 //Now for both char and short
#endif
#ifndef ZXH_DefaultOptimiseStep 
#define ZXH_DefaultOptimiseStep 50
#endif
#ifndef ZXH_BSPLINE
#define ZXH_BSPLINE 1024
#define ZXH_BSPLINE_PLUS 1025
#endif

#ifndef ZXH_InfiniteLargeFloat
#define ZXH_InfiniteLargeFloat 1.0e20f
#endif

#ifndef ZXH_MaxRegistrations
#define ZXH_MaxRegistrations 20
#endif

#ifndef ZXH_PHASE_FLOAT_INT
#define ZXH_PHASE_FLOAT_INT 10000.0
#endif

#ifndef ZXH_Mask
#define ZXH_Mask 0
#endif
#ifndef ZXH_WeightIntRatio
#define ZXH_WeightIntRatio 100.0
#endif

#ifndef ZXH_MATRIX44
#define ZXH_MATRIX44
typedef struct { float m[4][4] ;}  zxhmat44 ;
typedef zxhmat44 mat44 ;
#endif
//#ifndef ZXH_FFD_PRECOMPUTE_SIZE
//#define ZXH_FFD_PRECOMPUTE_SIZE 100
//#endif

#define ZXH_LocalAffineMaxNumber 20
#define ZXH_LocalAffineExponent 2 //1.5 2, 4
#define ZXH_LocalAffineFacetWeighting 0.5f //1.0/6=0.16667, 1.0/3=0.333333, 1/2, 
// Weight=1+1*( ((1/0.5)^e-1) /0.5 ), if NOT pre-compute weight , then is Distance =0
#define ZXH_LocalAffineWithinRegionWeight 0

// verbose output:
    // 0 only output error, and resultant infoa
    // 1 include 0 and success info
    // 2 include 1 and debug info

enum TypeHistogramCompute {PDFType_ParzenWindow_BSpline=1, PDFType_Histogram=2, PDFType_PV=3, UniformVolumeHistogram};

enum TypeMutualInformation { MutualInformation=1, NormalizedMutualInformation=2, MixtureProbabilityModel=3} ;

enum TypeSEMIKernelFunction { SEMIGaussian=-1, SEMIBSplineZeroOrder=0, SEMIBSpline=3, SEMIMixtureModel=10};
#ifndef SpatialMutualInformationSum
#define SpatialMutualInformationSum float(-0.998)
#endif
#ifndef SpatialMutualInformationMagnitude
#define SpatialMutualInformationMagnitude float(-0.997)
#endif
//#ifndef SpatialMutualInformationSearchScope
//#define SpatialMutualInformationSearchScope 1 int(-smisigma * 2)
//#endif

#ifndef ZXH_NV_NOISELEVEL
#define ZXH_NV_NOISELEVEL float(0.02)
#endif

#ifndef BSplineHistogramPaddingBins
#define BSplineHistogramPaddingBins 4 //2*2
#define BSplineHistogramPaddingBinsFrom -1
#define BSplineHistogramPaddingBinsTo 2
#define BSplineHistogramPaddingBinsOffset 2 //BSplineHistogramPaddingBins/2
#endif

ZXH_DLL_EXPORT void trim_left(std::string & s) ;

ZXH_DLL_EXPORT void trim_right(std::string& s) ;

ZXH_DLL_EXPORT void trim_both(std::string& s) ;

ZXH_DLL_EXPORT void case_upper(std::string& s);

ZXH_DLL_EXPORT void case_lower(std::string& s);

ZXH_DLL_EXPORT bool is_option( std::string s );
ZXH_DLL_EXPORT bool is_digital( std::string s );

ZXH_DLL_EXPORT void ParseStringLine(std::string& sContent,std::string& sComment, std::string& strLine);

ZXH_DLL_EXPORT bool FindStringFromStream(char*buffer,int buffersize,std::ifstream&ifs,char* substring);

ZXH_DLL_EXPORT bool NextContentLine(std::string& sContent,char*buffer,int buffersize,std::ifstream&ifs);

ZXH_DLL_EXPORT bool ScanInteger(std::ifstream & ifs,char*buffer,int ibuffersize,int& idata);

ZXH_DLL_EXPORT bool ScanFloat(std::ifstream&ifs,char*buffer,int ibuffersize,float& fdata);

ZXH_DLL_EXPORT bool ScanString(std::ifstream&ifs,char*buffer,int ibuffersize,char*pdata);


ZXH_DLL_EXPORT void Swap2Bytes(void* p);
ZXH_DLL_EXPORT void Swap4Bytes(void* p);
ZXH_DLL_EXPORT void Swap8Bytes(void* p);
ZXH_DLL_EXPORT void Swap10Bytes(void* p);
ZXH_DLL_EXPORT void SwapBytes(void* p,unsigned char nbyte);

ZXH_DLL_EXPORT std::string GetExtension(const std::string filename);
ZXH_DLL_EXPORT std::string GetFileNameNoPath(const std::string filename);
ZXH_DLL_EXPORT std::string GetFileNamePath(const std::string filename);
ZXH_DLL_EXPORT std::string GetFileNameNoExtension(const std::string filename);

ZXH_DLL_EXPORT float absf( const float f ) ;
ZXH_DLL_EXPORT int round( const float f ) ;
ZXH_DLL_EXPORT float maxf( const float f1, const float f2 ) ;
ZXH_DLL_EXPORT float minf( const float f1, const float f2 );
ZXH_DLL_EXPORT void echo_arguments( int argc, char* argv[] ) ;
ZXH_DLL_EXPORT void echo_zxh();
ZXH_DLL_EXPORT void NormaliseVector( float v[], int dimension ) ;
ZXH_DLL_EXPORT float MagnitudeOfVector( const float v[], const int dimension );

ZXH_DLL_EXPORT bool fileexists(const std::string filename);

ZXH_DLL_EXPORT float Gaussian( const float f, const float u, const float sigma ) ;
ZXH_DLL_EXPORT float NGaussian( const float f ) ;
ZXH_DLL_EXPORT
template <class type>
bool InclusiveBetween( type value, type from, type to )
{
    if( value>=from && value <= to )
        return true ;
    return false ;
};
ZXH_DLL_EXPORT
template <class TYPE>
TYPE abs( TYPE f )
{
    if( f>=0 ) return f ;
    return -f ;
}
ZXH_DLL_EXPORT
template <class TYPE>
TYPE SqaredDistance( TYPE *co1, TYPE *co2, int Dimension )
{
    TYPE dis = 0;
    for(int i=0;i<Dimension;++i)
        dis += (co1[i]-co2[i])*(co1[i]-co2[i]);
    return dis;
}
/* matrix op */
ZXH_DLL_EXPORT void MatrixIdentity(float *pMatDes, const int iMatrixLength ) ;
ZXH_DLL_EXPORT void SetMatrix(float *pMatDes, const float* pMatSrc1, const int iMatrixLength ) ;
ZXH_DLL_EXPORT void MultiplyMatrix(float *pMatDes, const float* pMatSrc1, const float* pMatSrc2, const int iMatrixLength ) ;
ZXH_DLL_EXPORT void MultiplyMatrixVector(float *pVecDes, const float* pMatSrc, const float* pVecSrc, const int iMatrixLength ) ;
ZXH_DLL_EXPORT float DeterminentMatrix3D(const float *pMat, const int iMatrixRowLength ) ;
ZXH_DLL_EXPORT void InvertMatrix3D(float* pInvMat, const float* pForMat, const int iMatrixRowLength);
ZXH_DLL_EXPORT void InvertMatrix4D3D( zxhmat44 &inv, const zxhmat44 &forward ) ;
 
//template <class TYPE>
//TYPE BSpline ( TYPE u )
ZXH_DLL_EXPORT float BSpline(float u) ;
ZXH_DLL_EXPORT float BSplineDerivative(float u) ;
ZXH_DLL_EXPORT float BSplineSecondDerivative ( float u ) ;
ZXH_DLL_EXPORT float BSplinei(int iOrd,float u) ;
ZXH_DLL_EXPORT float DerivativeOfBSplinei(int iOrd, float u) ;
ZXH_DLL_EXPORT float SecondDerivativeOfBSplinei(int iOrd,float u) ;
//************ Macro ***************//
#define MIN(f1,f2) ((f1)>=(f2)?(f2):(f1))
#define MAX(f1,f2) ((f1)<=(f2)?(f2):(f1))
 
#define ISMITYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_MI_")!=NULL)

#define ISSEMITYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_SEMI_")!=NULL)

#define ISMULTIIMAGETYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_MULTIIMAGE_")!=NULL)

#define ISPHASETYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_PHASE_")!=NULL)

#define ISCONSTDISCRETEPATHTYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_CONSTDISCRETEPATH_")!=NULL)

#define ISMICNSTTYPE(pMetric) \
(strstr(pMetric->GetMetricType().c_str(),"_MI_")!=NULL&&strstr(pMetric->GetMetricType().c_str(),"_CNST_")!=NULL)

#define ISRMSTYPE(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_RMS_")!=NULL)

#define ISCCTYPE(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_CC_")!=NULL)

#define ISNVTYPE(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_NV_")!=NULL)

#define ISFFDMETRIC(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_FFD_")!=NULL)

#define ISFFD2METRIC(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_FFD2_")!=NULL)

#define ISLOCALAFFINEMETRIC(pMetric)\
(strstr(pMetric->GetMetricType().c_str(),"_LAFFS_")!=NULL)

#define SetFFDMetric2Metric(FFDMetricObject,MetricObject) \
{   if(ISMITYPE(MetricObject)) FFDMetricObject = ((zxhMetricMIFFD*) MetricObject); \
    if(ISPHASETYPE(MetricObject))FFDMetricObject = ((zxhMetricPhaseFFD*) MetricObject); \
    if(ISRMSTYPE(MetricObject))FFDMetricObject = ((zxhMetricRMS*) MetricObject); \
    if(ISNVTYPE(MetricObject)) FFDMetricObject = ((zxhMetricNV*) MetricObject); \
    if(ISCCTYPE(MetricObject)) FFDMetricObject = ((zxhMetricCCFFD2*) MetricObject); \
};

#define SetLocalAffinesMetric2Metric(LAMetricObject,MetricObject) \
{   if(ISPHASETYPE(MetricObject)) LAMetricObject = (zxhMetricPhaseLocalAffines*) MetricObject ; \
    if(ISMITYPE(MetricObject)) LAMetricObject = (zxhMetricMILocalAffines*) MetricObject ; \
};

//if(ISNVTYPE(MetricObject)) LAMetricObject = ((zxhMetricNV*) MetricObject); 

/*  if(ISCCTYPE(MetricObject)) LAMetricObject = (zxhMetricCC*) MetricObject ;  
    if(ISRMSTYPE(MetricObject))LAMetricObject = (zxhMetricRMS*) MetricObject ; 
    if(ISNVTYPE(MetricObject)) LAMetricObject = (zxhMetricNV*) MetricObject ;};*/


}//end of zxh
//#ifdef __cpluscplus
//  }
//#endif

#endif //zxh_h