itkMultipleValuedNonLinearVnlOptimizer.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 itkMultipleValuedNonLinearVnlOptimizer_h
#define itkMultipleValuedNonLinearVnlOptimizer_h

#include "itkMultipleValuedNonLinearOptimizer.h"
#include "itkMultipleValuedVnlCostFunctionAdaptor.h"
#include "itkCommand.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT MultipleValuedNonLinearVnlOptimizer:
  public MultipleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(MultipleValuedNonLinearVnlOptimizer);

  using Self = MultipleValuedNonLinearVnlOptimizer;
  using Superclass = MultipleValuedNonLinearOptimizer;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(MultipleValuedNonLinearVnlOptimizer,
               MultipleValueNonLinearOptimizer);

  using ParametersType = Superclass::ParametersType;

  void SetCostFunction(MultipleValuedCostFunction *costFunction) override = 0;

  void SetUseCostFunctionGradient(bool);

  void UseCostFunctionGradientOn()
  {
    this->SetUseCostFunctionGradient(true);
  }

  void UseCostFunctionGradientOff()
  {
    this->SetUseCostFunctionGradient(false);
  }

  bool GetUseCostFunctionGradient() const;

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

protected:
  MultipleValuedNonLinearVnlOptimizer();
  ~MultipleValuedNonLinearVnlOptimizer() override;

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

  using CostFunctionAdaptorType = MultipleValuedVnlCostFunctionAdaptor;

  void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor);

  const CostFunctionAdaptorType * GetCostFunctionAdaptor() const;

  CostFunctionAdaptorType * GetCostFunctionAdaptor();

  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor() const;

  using CommandType = ReceptorMemberCommand< Self >;

private:
  void IterationReport(const EventObject & event);

  CostFunctionAdaptorType *m_CostFunctionAdaptor;
  bool                     m_UseGradient;

  CommandType::Pointer m_Command;

  mutable ParametersType m_CachedCurrentPosition;
  mutable MeasureType    m_CachedValue;
  mutable DerivativeType m_CachedDerivative;
};
} // end namespace itk

#endif