itkSingleValuedCostFunctionv4.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 itkSingleValuedCostFunctionv4_h
#define itkSingleValuedCostFunctionv4_h

#include "itkCostFunction.h"
#include "itkNumericTraits.h"

namespace itk
{
template< typename TInternalComputationValueType >
class SingleValuedCostFunctionv4Template:
  public CostFunctionTemplate< TInternalComputationValueType >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(SingleValuedCostFunctionv4Template);

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

  itkTypeMacro(SingleValuedCostFunctionv4Template, CostFunctionTemplate);

  using MeasureType = TInternalComputationValueType;

  using ParametersType = typename Superclass::ParametersType;

  using DerivativeType = Array< TInternalComputationValueType >;

  virtual MeasureType GetValue() const = 0;

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

protected:
  SingleValuedCostFunctionv4Template() = default;
  ~SingleValuedCostFunctionv4Template() override = default;
};

using SingleValuedCostFunctionv4 = SingleValuedCostFunctionv4Template<double>;

} // end namespace itk

#endif