cmtkFunctionalAffine2D.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  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: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkFunctionalAffine2D_h_included_
#define __cmtkFunctionalAffine2D_h_included_

#include <cmtkconfig.h>

#include <System/cmtkSmartPtr.h>

#include <Base/cmtkFunctional.h>
#include <Base/cmtkMacros.h>
#include <Base/cmtkScalarImage.h>
#include <Base/cmtkMatrix3x3.h>
#include <Base/cmtkHistogram.h>
#include <Base/cmtkJointHistogram.h>

#include <Registration/cmtkScalarImageSimilarity.h>

#include <vector>

namespace
cmtk
{


class FunctionalAffine2D :
  public Functional 
{
  cmtkGetSetMacro(int,NumberDOFs);

  cmtkGetSetMacro(ScalarImageSimilarity::ID,SimilarityMeasure);

  cmtkGetSetMacro(bool,HistogramEqualization);

public:
  typedef FunctionalAffine2D Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef Functional Superclass;

  FunctionalAffine2D( ScalarImage::SmartPtr& refImage, ScalarImage::SmartPtr& fltImage, const ScalarImage::RegionType* fltROI = NULL );

  FunctionalAffine2D( std::vector<ScalarImage::SmartPtr>& refImage, std::vector<ScalarImage::SmartPtr>& fltImage, const ScalarImage::RegionType* fltROI = NULL );

  ~FunctionalAffine2D() {};
  
  virtual void SetRefImage( ScalarImage::SmartPtr& refImage ) 
  {
    this->RefImages.clear();
    this->RefImages.push_back( refImage );
  }

  virtual void SetRefImages
  ( std::vector<ScalarImage::SmartPtr>& refImages ) 
  {
    this->RefImages = refImages;
  }

  virtual void SetFltImage( ScalarImage::SmartPtr& fltImage ) 
  {
    this->FltImages.clear();
    this->FltImagesROI.clear();
    this->FltImages.push_back( fltImage );
    this->FltImagesROI.push_back( fltImage );
  }

  virtual void SetFltImages
  ( std::vector<ScalarImage::SmartPtr>& fltImages ) 
  {
    this->FltImages = fltImages;
    this->FltImagesROI = fltImages;
  }

  void SetNumberOfBins( const size_t minBins, const size_t maxBins = 0 );

  virtual Self::ReturnType Evaluate();

  virtual  Self::ReturnType EvaluateAt( CoordinateVector& v );

  virtual  Self::ReturnType EvaluateWithGradient( CoordinateVector&, CoordinateVector&, const Types::Coordinate = 1 )
  { return 0; }


  virtual void SetParamVector( CoordinateVector& v );

  virtual void GetParamVector( CoordinateVector& v );

  virtual size_t ParamVectorDim() const { return 8; }

  virtual size_t VariableParamVectorDim() const { return this->m_NumberDOFs; }

  virtual Types::Coordinate GetParamStep( const size_t idx, const Types::Coordinate mmStep = 1 ) const;

private:
  std::vector<ScalarImage::SmartPtr> RefImages;

  std::vector<ScalarImage::SmartPtr> FltImages;

  std::vector<ScalarImage::SmartPtr> FltImagesROI;

  mutable ScalarImageSimilarityMemory ImageSimilarityMemory;
  
  Self::ReturnType GetSimilarity( const ScalarImage* img0,  const ScalarImage* img1 ) const;

  Self::ReturnType GetSimilarity( std::vector<const ScalarImage*>& imgs0,  std::vector<const ScalarImage*>& imgs1 ) const;

  CoordinateVector Parameters;

  CoordinateMatrix3x3 Transformation;
};


} // namespace cmtk

#endif // #ifndef __cmtkFunctionalAffine2D_h_included_