itkSingleValuedVnlCostFunctionAdaptorv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkSingleValuedVnlCostFunctionAdaptorv4_h
#define itkSingleValuedVnlCostFunctionAdaptorv4_h
 
#include "itkOptimizerParameters.h"
#include "itkObjectToObjectMetricBase.h"
#include "vnl/vnl_cost_function.h"
 
namespace itk
{
class SingleValuedVnlCostFunctionAdaptorv4 : public vnl_cost_function
{
public:
  using InternalMeasureType = double;

  using InternalParametersType = vnl_vector<InternalMeasureType>;

  using InternalDerivativeType = vnl_vector<InternalMeasureType>;

  using ParametersType = ObjectToObjectMetricBase::ParametersType;

  using DerivativeType = ObjectToObjectMetricBase::DerivativeType;

  using MeasureType = ObjectToObjectMetricBase::MeasureType;

  using ScalesType = OptimizerParameters<InternalMeasureType>;

  SingleValuedVnlCostFunctionAdaptorv4(unsigned int spaceDimension);

  void
  SetCostFunction(ObjectToObjectMetricBase * costFunction)
  {
    m_ObjectMetric = costFunction;
  }

  const ObjectToObjectMetricBase *
  GetCostFunction() const
  {
    return m_ObjectMetric;
  }

  InternalMeasureType
  f(const InternalParametersType & inparameters) override;

  void
  gradf(const InternalParametersType & inparameters, InternalDerivativeType & gradient) override;

  void
  compute(const InternalParametersType & x, InternalMeasureType * fun, InternalDerivativeType * g) override;

  void
  ConvertExternalToInternalGradient(const DerivativeType & input, InternalDerivativeType & output) const;

  void
  SetScales(const ScalesType & scales);

  unsigned long
  AddObserver(const EventObject & event, Command *) const;

  itkGetConstReferenceMacro(CachedValue, MeasureType);
 
  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);

  const ParametersType &
  GetCachedCurrentParameters() const;
 
protected:
  void
  ReportIteration(const EventObject & event) const;
 
private:
  ObjectToObjectMetricBase::Pointer m_ObjectMetric{};
  bool                              m_ScalesInitialized{};
  ScalesType                        m_Scales{};
  Object::Pointer                   m_Reporter{};
 
  mutable MeasureType    m_CachedValue{};
  mutable DerivativeType m_CachedDerivative{};
 
}; // end of Class CostFunction
 
} // end namespace itk
 
#endif