itkSingleValuedNonLinearOptimizer.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 itkSingleValuedNonLinearOptimizer_h
#define itkSingleValuedNonLinearOptimizer_h

#include "itkNonLinearOptimizer.h"
#include "itkSingleValuedCostFunction.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT SingleValuedNonLinearOptimizer:
  public NonLinearOptimizer
{
public:
  typedef SingleValuedNonLinearOptimizer Self;
  typedef NonLinearOptimizer             Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(SingleValuedNonLinearOptimizer,
               NonLinearOptimizer);

  typedef Superclass::ParametersType ParametersType;

  typedef  SingleValuedCostFunction  CostFunctionType;
  typedef  CostFunctionType::Pointer CostFunctionPointer;

  typedef CostFunctionType::MeasureType MeasureType;

  typedef CostFunctionType::DerivativeType DerivativeType;

  virtual void SetCostFunction(CostFunctionType *costFunction);

  itkGetModifiableObjectMacro(CostFunction, CostFunctionType);

  MeasureType GetValue(const ParametersType & parameters) const;

protected:
  SingleValuedNonLinearOptimizer();
  virtual ~SingleValuedNonLinearOptimizer() {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  CostFunctionPointer m_CostFunction;

private:
  SingleValuedNonLinearOptimizer(const Self &); //purposely not implemented
  void operator=(const Self &);                 //purposely not implemented
};
} // end namespace itk

#endif