itkSingleValuedVnlCostFunctionAdaptor.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 itkSingleValuedVnlCostFunctionAdaptor_h
#define itkSingleValuedVnlCostFunctionAdaptor_h

#include "itkSingleValuedCostFunction.h"
#include "vnl/vnl_cost_function.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT SingleValuedVnlCostFunctionAdaptor:
  public vnl_cost_function
{
public:

  using InternalParametersType = vnl_vector< double >;

  using InternalMeasureType = double;

  using InternalDerivativeType = vnl_vector< double >;

  using ParametersType = SingleValuedCostFunction::ParametersType;

  using DerivativeType = SingleValuedCostFunction::DerivativeType;

  using MeasureType = SingleValuedCostFunction::MeasureType;

  using ScalesType = Array< double >;

  SingleValuedVnlCostFunctionAdaptor(unsigned int spaceDimension);

  void SetCostFunction(SingleValuedCostFunction *costFunction)
  { m_CostFunction = costFunction; }

  const SingleValuedCostFunction * GetCostFunction() const
  { return m_CostFunction; }

  InternalMeasureType f(const InternalParametersType & inparameters) override;

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

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

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

  void SetScales(const ScalesType & scales);

  void SetNegateCostFunction(bool value);

  bool GetNegateCostFunction() const;

  void NegateCostFunctionOn() { m_NegateCostFunction = true; }
  void NegateCostFunctionOff() { m_NegateCostFunction = false; }

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

  const MeasureType & GetCachedValue() const;

  const DerivativeType & GetCachedDerivative() const;

  const ParametersType & GetCachedCurrentParameters() const;

protected:

  void ReportIteration(const EventObject & event) const;

private:

  itkGetConstReferenceMacro(InverseScales, ScalesType);

  SingleValuedCostFunction::Pointer m_CostFunction;
  bool                              m_ScalesInitialized;
  ScalesType                        m_InverseScales;
  bool                              m_NegateCostFunction;
  Object::Pointer                   m_Reporter;

  mutable MeasureType    m_CachedValue;
  mutable DerivativeType m_CachedDerivative;
  mutable ParametersType m_CachedCurrentParameters;
};  // end of Class CostFunction
} // end namespace itk

#endif