itkObjectToObjectMetricBase.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 __itkObjectToObjectMetricBase_h
#define __itkObjectToObjectMetricBase_h

#include "itkTransformBase.h"
#include "itkSingleValuedCostFunctionv4.h"

namespace itk
{

class ITK_EXPORT ObjectToObjectMetricBase:
  public SingleValuedCostFunctionv4
{
public:
  typedef ObjectToObjectMetricBase     Self;
  typedef SingleValuedCostFunctionv4   Superclass;
  typedef SmartPointer< Self >         Pointer;
  typedef SmartPointer< const Self >   ConstPointer;

  itkTypeMacro(ObjectToObjectMetricBase, SingleValuedCostFunctionv4);

  typedef Superclass::ParametersValueType CoordinateRepresentationType;

  typedef double                          InternalComputationValueType;

  typedef  Superclass::MeasureType        MeasureType;

  typedef  Superclass::DerivativeType     DerivativeType;
  typedef  DerivativeType::ValueType      DerivativeValueType;

  typedef  Superclass::ParametersType       ParametersType;
  typedef  Superclass::ParametersValueType  ParametersValueType;

  typedef enum  { GRADIENT_SOURCE_FIXED=0,
                  GRADIENT_SOURCE_MOVING,
                  GRADIENT_SOURCE_BOTH } GradientSourceType;

  itkSetMacro( GradientSource, GradientSourceType );

  itkGetConstMacro( GradientSource, GradientSourceType );

  bool GetGradientSourceIncludesFixed() const;

  bool GetGradientSourceIncludesMoving() const;

  virtual void Initialize(void) throw ( ExceptionObject ) = 0;

  typedef unsigned int NumberOfParametersType;

  virtual MeasureType GetValue() const = 0;

  virtual void GetDerivative( DerivativeType & ) const = 0;

  virtual void GetValueAndDerivative( MeasureType & value, DerivativeType & derivative ) const = 0;

  virtual NumberOfParametersType GetNumberOfParameters() const = 0;
  virtual NumberOfParametersType GetNumberOfLocalParameters() const = 0;

  virtual void SetParameters( ParametersType & params ) = 0;

  virtual const ParametersType & GetParameters() const = 0;

  virtual bool HasLocalSupport() const = 0;

  virtual void UpdateTransformParameters( const DerivativeType & derivative,
                                          ParametersValueType factor = NumericTraits<ParametersValueType>::One) = 0;

  MeasureType GetCurrentValue() const;

protected:
  ObjectToObjectMetricBase();
  virtual ~ObjectToObjectMetricBase();

  void PrintSelf(std::ostream & os, Indent indent) const;

  GradientSourceType              m_GradientSource;

  mutable MeasureType             m_Value;

private:
  ObjectToObjectMetricBase(const Self &); //purposely not implemented
  void operator=(const Self &);     //purposely not implemented

};
} // end namespace itk

#endif