zxhMetricMIFFD.h

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

  Program:   ZXH Registration Software
  Author:    Xiahai Zhuang
  Module:    $RCSfle: zxhMetricMIFFD.h    $
  Language:  C++
  Date:      $Date: From  2008-10 $
  Version:   $Revision: 2.0 $
  revision:
=========================================================================*/
#ifndef zxhMetricMIFFD_h
#define zxhMetricMIFFD_h

#include "zxh.h"
#include "zxhMetricFFDBase.h"
#include "zxhTransformFFD.h"
#include "zxhMetricMIConstraint.h"
#include <math.h>

class zxhMetricMIFFD :  public zxhMetricMIConstraint, 
                        public zxhMetricFFDBase // interface for FFD
{
public:
    zxhMetricMIFFD(void);
    ~zxhMetricMIFFD(void);

    virtual std::string GetMetricType() {return zxhMetricMIConstraint::GetMetricType()+"_"+zxhMetricFFDBase::GetMetricType(); } ;

    virtual zxhMetricBase* Clone( zxhMetricBase * & pRet ); 

    virtual int ComputeConstanceForFFDGradient() ;
    virtual int GetValue( zxhlfloat & fvalue ) ;

    virtual int GetValueByFFDGrid(zxhlfloat&fValue, int aiCtrPnt[ImageDimensionMax]);
    
    virtual int GetDiffByFFDGrid(float * afPD, // output partial differentiation 
                                    zxhTransformFFDBase * pFFDGrid,
                                    int * aiCtrPnt,
                                    zxhTransformFFDBase * pDifferential );
    virtual int GetDiffByFFDGridOnFFDPhysicalVector(float * afPD, // output partial differentiation
                                            zxhTransformFFDBase * pFFDGrid,
                                            int * aiCtrPnt,
                                            zxhTransformFFDBase * pDifferential,
                                            float * vector) ;

protected:
    virtual int GetFiniteDiffByFFDGrid(float * afPD, // output partial differentiation 
                                      zxhTransformFFDBase * pFFDGrid,
                                      int * aiCtrPnt,
                                      zxhTransformFFDBase * pDifferential );
    virtual int GetFiniteDiffByFFDGridOnVector(float * afPD, // output partial differentiation
                                             zxhTransformFFDBase * pFFDGrid,
                                             int * aiCtrPnt,
                                             zxhTransformFFDBase * pDifferential,
                                             float * vector);
    
    // Compute histogram region outside of local support of ctrpnt: EvaluateMMIpositionWeightedHistogram
    //   compute the difference: zxhMetricFFDBase::GetDiffByFFDGrid( afPD,pFFDGrid,aiCtrPnt,pDifferential );
    virtual int GetDiffByFFDGridForMMI( float * afPD, // output partial differentiation
                                            zxhTransformFFDBase * pFFDGrid,
                                            int * aiCtrPnt,
                                            zxhTransformFFDBase * pDifferential );
    virtual int ComputeHistogramFromPDF4DFFD(zxhlfloat*&afPDF,zxhlfloat&fTotalFreq, 
                                            float xfTestFrom,float xfTestTo,float yfTestFrom,float yfTestTo,
                                            float zfTestFrom,float zfTestTo,float tfTestFrom,float tfTestTo ) ;

    virtual int ComputeHistogramForControlPoint( zxhlfloat*&afPDF,zxhlfloat&fTotalFreq,  int aiCtrPnt[ImageDimensionMax] ) ;
    virtual void    SetFFDMetricBase()  {m_pMetricBase=this;};
private:
    // for: Zhuang, et al.: Spatially Encoded Mutual Information for Nonrigid Registration. IEEE Transactions on Medical Imaging.
    // this was just for publication validation using cost function SUM(MIs) or MAG(MIs)

    int GetDiffByFFDGridForSMIG1(   float * afPD, // output partial differentiation
                                    zxhTransformFFDBase * pFFDGrid,
                                    int * aiCtrPnt,
                                    zxhTransformFFDBase * pDifferential );
    int SMIRecomputeMMIimage();
    zxhlfloat SMIGetSsValueByFFDGrid(int aiCtrPnt[ImageDimensionMax]);

};

#endif