itkPointSetToPointSetMetricv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.
 *
 *=========================================================================*/
#ifndef __itkPointSetToPointSetMetricv4_h
#define __itkPointSetToPointSetMetricv4_h

#include "itkObjectToObjectMetric.h"

#include "itkFixedArray.h"
#include "itkPointsLocator.h"
#include "itkPointSet.h"
#include "itkTransform.h"

namespace itk
{
template<class TFixedPointSet,  class TMovingPointSet>
class ITK_EXPORT PointSetToPointSetMetricv4
: public ObjectToObjectMetric
{
public:

  typedef PointSetToPointSetMetricv4 Self;
  typedef ObjectToObjectMetric       Superclass;
  typedef SmartPointer<Self>         Pointer;
  typedef SmartPointer<const Self>   ConstPointer;

  itkTypeMacro( PointSetToPointSetMetricv4, ObjectToObjectMetric );

  typedef TFixedPointSet                               FixedPointSetType;
  typedef typename TFixedPointSet::PointType           FixedPointType;
  typedef typename TFixedPointSet::PixelType           FixedPixelType;
  typedef typename TFixedPointSet::PointsContainer     FixedPointsContainer;

  itkStaticConstMacro( FixedPointDimension, unsigned int,
    TFixedPointSet::PointDimension );

  typedef TMovingPointSet                              MovingPointSetType;
  typedef typename TMovingPointSet::PointType          MovingPointType;
  typedef typename TMovingPointSet::PixelType          MovingPixelType;
  typedef typename TMovingPointSet::PointsContainer    MovingPointsContainer;

  itkStaticConstMacro( MovingPointDimension, unsigned int,
    TFixedPointSet::PointDimension );

  itkStaticConstMacro( PointDimension, unsigned int,
    TFixedPointSet::PointDimension );

  typedef FixedPointType                               PointType;
  typedef typename PointType::CoordRepType             CoordRepType;
  typedef FixedPointsContainer                         PointsContainer;
  typedef typename PointsContainer::ConstIterator      PointsConstIterator;
  typedef typename PointsContainer::ElementIdentifier  PointIdentifier;

  typedef PointsLocator<PointIdentifier,
    itkGetStaticConstMacro( PointDimension ),
    CoordRepType, PointsContainer>                     PointsLocatorType;
  typedef typename PointsLocatorType::
    NeighborsIdentifierType                            NeighborsIdentifierType;

  typedef Transform<CoordRepType,
    itkGetStaticConstMacro( FixedPointDimension ),
    itkGetStaticConstMacro( PointDimension )>      FixedTransformType;
  typedef typename FixedTransformType::Pointer     FixedTransformPointer;
  typedef PointSet<FixedPixelType,
    itkGetStaticConstMacro( PointDimension )>      FixedTransformedPointSetType;

  typedef Transform<CoordRepType,
    itkGetStaticConstMacro( MovingPointDimension ),
    itkGetStaticConstMacro( PointDimension )>      MovingTransformType;
  typedef typename MovingTransformType::Pointer    MovingTransformPointer;
  typedef PointSet<MovingPixelType,
    itkGetStaticConstMacro( PointDimension )>      MovingTransformedPointSetType;

  typedef typename Superclass::MeasureType MeasureType;

  typedef typename Superclass::ParametersType ParametersType;

  typedef typename Superclass::DerivativeType DerivativeType;

  typedef typename DerivativeType::ValueType           DerivativeValueType;
  typedef FixedArray<DerivativeValueType,
    itkGetStaticConstMacro( PointDimension )>          LocalDerivativeType;

  itkSetConstObjectMacro( FixedPointSet, FixedPointSetType );

  itkGetConstObjectMacro( FixedPointSet, FixedPointSetType );

  itkGetConstObjectMacro( FixedTransformedPointSet, FixedTransformedPointSetType );

  itkSetObjectMacro( FixedTransform, FixedTransformType );

  itkGetConstObjectMacro( FixedTransform, FixedTransformType );

  itkSetObjectMacro( MovingPointSet, MovingPointSetType );

  itkGetConstObjectMacro( MovingPointSet, MovingPointSetType );

  itkGetConstObjectMacro( MovingTransformedPointSet, MovingTransformedPointSetType );

  itkSetObjectMacro( MovingTransform, MovingTransformType );

  itkGetConstObjectMacro( MovingTransform, MovingTransformType );

  unsigned int GetNumberOfComponents() const;

  virtual MeasureType GetValue() const;

  virtual void GetDerivative( DerivativeType & ) const;

  virtual void GetValueAndDerivative( MeasureType &, DerivativeType & ) const;

  virtual MeasureType GetLocalNeighborhoodValue( const PointType & ) const = 0;

  virtual LocalDerivativeType GetLocalNeighborhoodDerivative( const PointType & ) const;

  virtual void GetLocalNeighborhoodValueAndDerivative( const PointType &,
    MeasureType &, LocalDerivativeType & ) const = 0;

  virtual void Initialize( void ) throw ( ExceptionObject );

  virtual unsigned int GetNumberOfParameters() const;

  virtual unsigned int GetNumberOfLocalParameters() const;

  virtual void SetParameters( ParametersType & );

  virtual const ParametersType & GetParameters() const;

  virtual bool HasLocalSupport() const;

  virtual void UpdateTransformParameters( DerivativeType & derivative, ParametersValueType factor = 1.0 );

protected:
  PointSetToPointSetMetricv4();
  virtual ~PointSetToPointSetMetricv4();
  void PrintSelf( std::ostream & os, Indent indent ) const;

  typename FixedPointSetType::ConstPointer        m_FixedPointSet;
  typename FixedTransformedPointSetType::Pointer  m_FixedTransformedPointSet;

  FixedTransformPointer                           m_FixedTransform;
  typename PointsLocatorType::Pointer             m_FixedTransformedPointsLocator;

  typename MovingPointSetType::ConstPointer       m_MovingPointSet;
  typename MovingTransformedPointSetType::Pointer m_MovingTransformedPointSet;

  MovingTransformPointer                          m_MovingTransform;
  typename PointsLocatorType::Pointer             m_MovingTransformedPointsLocator;

  void TransformFixedPointSet();

  void TransformMovingPointSet();

  void InitializePointsLocators();

private:
  PointSetToPointSetMetricv4( const Self & ); //purposely not implemented
  void operator=( const Self & );           //purposely not implemented
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPointSetToPointSetMetricv4.hxx"
#endif

#endif