cmtkScalarImageSimilarity.h

Go to the documentation of this file.

/*
//
//  Copyright 2004-2010 SRI International
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkScalarImageSimilarity_h_included_
#define __cmtkScalarImageSimilarity_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkScalarImage.h>
#include <Registration/cmtkTypedArraySimilarity.h>

#include <vector>

namespace
cmtk
{


class ScalarImageSimilarityMemory :
  public TypedArraySimilarityMemory
{
};

class ScalarImageSimilarity :
  public TypedArraySimilarity
{
public:
  typedef enum {
    MI = 0, 
    NMI = 1,
    RMI = 2,
    RNMI = 3,
    CR = 4,
    CC = 5,
    MSD = 6,
    PSNR = 7,
    DAE = 8,
    GradientCorrelation = 9,
    PatternIntensity = 10
  } ID;
  
  static ReturnType GetMutualInformation( const ScalarImage* image0, const ScalarImage* image1, ScalarImageSimilarityMemory *const memory = NULL );

  static ReturnType GetNormalizedMutualInformation( const ScalarImage* image0, const ScalarImage* image1, ScalarImageSimilarityMemory *const memory = NULL );

  static ReturnType GetMutualInformation( std::vector<const ScalarImage*>& array0, std::vector<const ScalarImage*>& array1, const bool normalized = false )
  {
    std::vector<const TypedArray*> data0(array0.size());
    std::vector<const TypedArray*> data1(array1.size());
    for ( size_t i = 0; i < array0.size(); ++i )
      {
      data0[i] = array0[i]->GetPixelData();
      }
    for ( size_t i = 0; i < array1.size(); ++i )
      {
      data1[i] = array1[i]->GetPixelData();
      } 
    return TypedArraySimilarity::GetMutualInformation( data0, data1, normalized );
  }
  
  static ReturnType GetNormalizedMutualInformation( std::vector<const ScalarImage*>& array0, std::vector<const ScalarImage*>& array1 )
  {
    return GetMutualInformation( array0, array1, true /*normalized*/ );
  }
  
  static ReturnType GetRegionalMutualInformation( const ScalarImage* image0, const ScalarImage* image1, const int radius = 2 );

  static ReturnType GetMinusMeanSquaredDifference( const ScalarImage* image0, const ScalarImage* image1 );

  static ReturnType GetCrossCorrelation( const ScalarImage* image0, const ScalarImage* image1 );

  static ReturnType GetGradientCorrelation( const ScalarImage* image0, const ScalarImage* image1 );

  static ReturnType GetGradientDifference( const ScalarImage* image0, const ScalarImage* image1, const ReturnType Ax = 1, const ReturnType Ay = 1 );

  static ReturnType GetPatternIntensity( const ScalarImage* image0, const ScalarImage* image1, const ReturnType sigma = 10, const int radius = 3 );

  static ReturnType GetDifferenceImageEntropy( const ScalarImage* image0, const ScalarImage* image1 );

  static ReturnType GetDifferenceImageEntropy( const ScalarImage* image0, const ScalarImage* image1, Types::DataItem &scaleFactor );


  static ReturnType GetCorrelationRatio( const ScalarImage* image0, const ScalarImage* image1 );

  static bool CheckImageDimensions( const ScalarImage* image0, const ScalarImage* image1 );
};


} // namespace cmtk

#endif // #ifndef __cmtkScalarImageSimilarity_h_included_