cmtkImagePairSimilarityMeasure.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: 2578 $
//
//  $LastChangedDate: 2010-12-01 14:27:46 -0800 (Wed, 01 Dec 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkImagePairSimilarityMeasure_h_included_
#define __cmtkImagePairSimilarityMeasure_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkUniformVolume.h>
#include <Base/cmtkTypes.h>
#include <Base/cmtkFunctional.h>
#include <Base/cmtkUniformVolumeInterpolatorBase.h>

#include <System/cmtkSmartPtr.h>

namespace
cmtk
{


class ImagePairSimilarityMeasure
{
public:
  typedef ImagePairSimilarityMeasure Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef Functional::ReturnType ReturnType;

  ImagePairSimilarityMeasure
  ( const UniformVolume::SmartConstPtr& refVolume, 
    const UniformVolume::SmartConstPtr& fltVolume, 
    const Interpolators::InterpolationEnum interpolation = Interpolators::DEFAULT 
    );

  ImagePairSimilarityMeasure() {};

  virtual ~ImagePairSimilarityMeasure() {};

  virtual void SetReferenceVolume( const UniformVolume::SmartConstPtr& refVolume );

  virtual void SetFloatingVolume( const UniformVolume::SmartConstPtr& fltVolume );

  virtual void Reset() {}

  Types::DataItem GetSampleX ( const size_t index ) const
  { 
    Types::DataItem data;
    this->m_ReferenceData->Get( data, index );
    return data;
  }

  bool GetSampleX ( Types::DataItem& sample, const size_t index ) const
  { 
    return this->m_ReferenceData->Get( sample, index );
  }
  
  size_t GetNumberOfSamplesX() const
  {
    return this->m_ReferenceData->GetDataSize();
  }

  const Types::DataItemRange GetDataRangeX() const
  {
    return this->m_ReferenceData->GetRange();
  }
  
  Types::DataItem GetSampleY( const int* index, const Types::Coordinate* frac ) const
  {
    return this->m_FloatingImageInterpolator->GetDataDirect( index, frac );
  }

  size_t GetNumberOfSamplesY() const
  {
    return this->m_FloatingData->GetDataSize();
  }
  
  const Types::DataItemRange GetDataRangeY() const
  {
    return this->m_FloatingData->GetRange();
  }
  
  virtual Types::DataItem GetFloatingValueScaled( const Types::DataItem value ) const
  {
    return value;
  }

  virtual Self::ReturnType Get() const = 0;

private:
  UniformVolume::SmartConstPtr m_ReferenceVolume;
  
  TypedArray::SmartConstPtr m_ReferenceData;
  
  UniformVolume::SmartConstPtr m_FloatingVolume;
  
  TypedArray::SmartConstPtr m_FloatingData;

  Interpolators::InterpolationEnum m_InterpolationMethod;

  cmtk::UniformVolumeInterpolatorBase::SmartConstPtr m_FloatingImageInterpolator;
};


} // namespace cmtk

#endif // #ifndef __cmtkImagePairSimilarityMeasure_h_included_