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
{
template<typename TInternalComputationValueType=double>
class ITK_TEMPLATE_EXPORT ObjectToObjectMetricBaseTemplate:
  public SingleValuedCostFunctionv4Template<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ObjectToObjectMetricBaseTemplate);

  using Self = ObjectToObjectMetricBaseTemplate;
  using Superclass = SingleValuedCostFunctionv4Template<TInternalComputationValueType>;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(ObjectToObjectMetricBaseTemplate, SingleValuedCostFunctionv4Template);

  using CoordinateRepresentationType = TInternalComputationValueType;

  using MeasureType = typename Superclass::MeasureType;

  using DerivativeType = typename Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;

  using ParametersType = typename Superclass::ParametersType;
  using ParametersValueType = TInternalComputationValueType;

  using ObjectType = Object;
  using ObjectConstPointer = typename ObjectType::ConstPointer;

  itkSetConstObjectMacro( FixedObject, ObjectType );
  itkGetConstObjectMacro( FixedObject, ObjectType );

  itkSetConstObjectMacro( MovingObject, ObjectType );
  itkGetConstObjectMacro( MovingObject, ObjectType );

  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() = 0;

  using NumberOfParametersType = unsigned int;

  MeasureType GetValue() const override = 0;

  virtual void GetDerivative( DerivativeType & ) const = 0;

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

  NumberOfParametersType GetNumberOfParameters() const override = 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>::OneValue()) = 0;

  MeasureType GetCurrentValue() const;

  typedef enum {
    UNKNOWN_METRIC = 0,
    OBJECT_METRIC = 1,
    IMAGE_METRIC = 2,
    POINT_SET_METRIC = 3,
    MULTI_METRIC = 4
    } MetricCategoryType;

  virtual MetricCategoryType GetMetricCategory() const
    {
    return UNKNOWN_METRIC;
    }

protected:
  ObjectToObjectMetricBaseTemplate();
  ~ObjectToObjectMetricBaseTemplate() override = default;

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

  ObjectConstPointer      m_FixedObject;
  ObjectConstPointer      m_MovingObject;

  GradientSourceType              m_GradientSource;

  mutable MeasureType             m_Value;
};

using ObjectToObjectMetricBase = ObjectToObjectMetricBaseTemplate<double>;

} // end namespace itk

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

#endif