itkSingleValuedPointSetToPointSetMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSingleValuedPointSetToPointSetMetric.h,v $
  Language:  C++
  Date:      $Date: 2009-01-26 21:45:56 $
  Version:   $Revision: 1.2 $
 
  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef __itkSingleValuedPointSetToPointSetMetric_h
#define __itkSingleValuedPointSetToPointSetMetric_h
 
#include "itkImageBase.h"
#include "itkAdvancedTransform.h"
#include "itkSingleValuedCostFunction.h"
#include "itkMacro.h"
#include "itkSpatialObject.h"
#include "itkPointSet.h"
 
namespace itk
{
 
template< class TFixedPointSet, class TMovingPointSet >
class SingleValuedPointSetToPointSetMetric :
  public SingleValuedCostFunction
{
public:
 
  typedef SingleValuedPointSetToPointSetMetric Self;
  typedef SingleValuedCostFunction             Superclass;
  typedef SmartPointer< Self >                 Pointer;
  typedef SmartPointer< const Self >           ConstPointer;
 
  typedef Superclass::ParametersValueType CoordinateRepresentationType;
 
  itkTypeMacro( SingleValuedPointSetToPointSetMetric, SingleValuedCostFunction );
 
  typedef TFixedPointSet                                                FixedPointSetType;
  typedef typename FixedPointSetType::PixelType                         FixedPointSetPixelType;
  typedef typename FixedPointSetType::ConstPointer                      FixedPointSetConstPointer;
  typedef TMovingPointSet                                               MovingPointSetType;
  typedef typename MovingPointSetType::PixelType                        MovingPointSetPixelType;
  typedef typename MovingPointSetType::ConstPointer                     MovingPointSetConstPointer;
  typedef typename FixedPointSetType::PointsContainer::ConstIterator    PointIterator;
  typedef typename FixedPointSetType::PointDataContainer::ConstIterator PointDataIterator;
 
  itkStaticConstMacro( FixedPointSetDimension, unsigned int,
    TFixedPointSet::PointDimension );
  itkStaticConstMacro( MovingPointSetDimension, unsigned int,
    TMovingPointSet::PointDimension );
 
  typedef AdvancedTransform< CoordinateRepresentationType,
    itkGetStaticConstMacro( FixedPointSetDimension ),
    itkGetStaticConstMacro( MovingPointSetDimension ) > TransformType;
  typedef typename TransformType::Pointer         TransformPointer;
  typedef typename TransformType::InputPointType  InputPointType;
  typedef typename TransformType::OutputPointType OutputPointType;
  typedef typename TransformType::ParametersType  TransformParametersType;
  typedef typename TransformType::JacobianType    TransformJacobianType;
 
  typedef SpatialObject<
    itkGetStaticConstMacro( FixedPointSetDimension ) > FixedImageMaskType;
  typedef typename FixedImageMaskType::Pointer      FixedImageMaskPointer;
  typedef typename FixedImageMaskType::ConstPointer FixedImageMaskConstPointer;
  typedef SpatialObject<
    itkGetStaticConstMacro( MovingPointSetDimension ) >  MovingImageMaskType;
  typedef typename MovingImageMaskType::Pointer      MovingImageMaskPointer;
  typedef typename MovingImageMaskType::ConstPointer MovingImageMaskConstPointer;
 
  typedef Superclass::MeasureType            MeasureType;
  typedef Superclass::DerivativeType         DerivativeType;
  typedef typename DerivativeType::ValueType DerivativeValueType;
  typedef Superclass::ParametersType         ParametersType;
 
  typedef typename TransformType::NonZeroJacobianIndicesType NonZeroJacobianIndicesType;
 
  itkSetConstObjectMacro( FixedPointSet, FixedPointSetType );
 
  itkGetConstObjectMacro( FixedPointSet, FixedPointSetType );
 
  itkSetConstObjectMacro( MovingPointSet, MovingPointSetType );
 
  itkGetConstObjectMacro( MovingPointSet, MovingPointSetType );
 
  itkSetObjectMacro( Transform, TransformType );
 
  itkGetConstObjectMacro( Transform, TransformType );
 
  void SetTransformParameters( const ParametersType & parameters ) const;
 
  unsigned int GetNumberOfParameters( void ) const override
  { return this->m_Transform->GetNumberOfParameters(); }
 
  virtual void Initialize( void );
 
  // \todo: currently not used
  itkSetConstObjectMacro( FixedImageMask, FixedImageMaskType );
 
  itkGetConstObjectMacro( FixedImageMask, FixedImageMaskType );
 
  itkSetConstObjectMacro( MovingImageMask, MovingImageMaskType );
 
  itkGetConstObjectMacro( MovingImageMask, MovingImageMaskType );
 
  virtual void BeforeThreadedGetValueAndDerivative( const TransformParametersType & parameters ) const;
 
  itkSetMacro( UseMetricSingleThreaded, bool );
  itkGetConstReferenceMacro( UseMetricSingleThreaded, bool );
  itkBooleanMacro( UseMetricSingleThreaded );
 
protected:
 
  SingleValuedPointSetToPointSetMetric();
  ~SingleValuedPointSetToPointSetMetric() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  FixedPointSetConstPointer   m_FixedPointSet;
  MovingPointSetConstPointer  m_MovingPointSet;
  FixedImageMaskConstPointer  m_FixedImageMask;
  MovingImageMaskConstPointer m_MovingImageMask;
  mutable TransformPointer    m_Transform;
 
  mutable unsigned int m_NumberOfPointsCounted;
 
  bool m_UseMetricSingleThreaded;
 
private:
 
  SingleValuedPointSetToPointSetMetric( const Self & ); // purposely not implemented
  void operator=( const Self & );                       // purposely not implemented
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSingleValuedPointSetToPointSetMetric.hxx"
#endif
 
#endif