cmtkImagePairRegistrationFunctional.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 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: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkImagePairRegistrationFunctional_h_included_
#define __cmtkImagePairRegistrationFunctional_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkMathUtil.h>
#include <Base/cmtkTypes.h>
#include <Base/cmtkFunctional.h>
#include <Base/cmtkVector.h>
#include <Base/cmtkVolume.h>
#include <Base/cmtkUniformVolume.h>
#include <Base/cmtkMatchedLandmarkList.h>

#include <System/cmtkException.h>
#include <System/cmtkLockingPtr.h>

#include <Registration/cmtkImagePairSimilarityMeasure.h>

#include <cassert>

namespace
cmtk
{


class ImagePairRegistrationFunctional :
  public Functional 
{
public:
  typedef ImagePairRegistrationFunctional Self;

  typedef Functional Superclass;

protected:
  UniformVolume::SmartConstPtr m_ReferenceGrid;

  UniformVolume::SmartConstPtr m_FloatingGrid;

  DataClass m_ReferenceDataClass;

  DataClass m_FloatingDataClass;

  DataGrid::RegionType m_ReferenceCropRegion;

  cmtkGetSetMacro(MatchedLandmarkList::SmartPtr,MatchedLandmarkList);

  cmtkGetSetMacro(Self::ReturnType,LandmarkErrorWeight);

public:
  ImagePairRegistrationFunctional( UniformVolume::SmartConstPtr& reference, UniformVolume::SmartConstPtr& floating )
    : m_MatchedLandmarkList( NULL ),
      m_ForceOutsideFlag( false )
  {
    this->InitFloating( floating );
    this->InitReference( reference );
    this->m_LandmarkErrorWeight = 0;
  }

  virtual ~ImagePairRegistrationFunctional() {}

  virtual void SetForceOutside
  ( const bool flag = true, const Types::DataItem value = 0 )
  {
    this->m_ForceOutsideFlag = flag;
    this->m_ForceOutsideValueRescaled = this->m_Metric->GetFloatingValueScaled( value );
  }

protected:
  ImagePairSimilarityMeasure::SmartPtr m_Metric;

  DataGrid::IndexType m_FloatingDims;

  UniformVolume::CoordinateVectorType m_FloatingSize;

  UniformVolume::CoordinateVectorType m_FloatingInverseDelta;

  UniformVolume::CoordinateRegionType m_FloatingCropRegionCoordinates;
 
  UniformVolume::CoordinateRegionType m_FloatingCropRegionFractIndex;

  DataGrid::IndexType m_ReferenceDims;

  UniformVolume::CoordinateVectorType m_ReferenceSize;

  UniformVolume::CoordinateVectorType m_ReferenceInverseDelta;

  bool m_ForceOutsideFlag;

  Types::DataItem m_ForceOutsideValueRescaled;

  const DataGrid::RegionType GetReferenceGridRange ( const Vector3D& fromVOI, const Vector3D& toVOI );

private:
  ImagePairRegistrationFunctional ( const ImagePairRegistrationFunctional& ) {}

  void InitFloating( UniformVolume::SmartConstPtr& floating );

  void InitReference( UniformVolume::SmartConstPtr& reference );
};


} // namespace cmtk

#endif // __cmtkImagePairRegistrationFunctional_h_included_