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:
  typedef SingleValuedCostFunctionv4Template                    Self;
  typedef CostFunctionTemplate< TInternalComputationValueType > Superclass;
  typedef SmartPointer< Self >                                  Pointer;
  typedef SmartPointer< const Self >                            ConstPointer;

  itkTypeMacro(SingleValuedCostFunctionv4Template, CostFunctionTemplate);

  typedef TInternalComputationValueType                  MeasureType;

  typedef typename Superclass::ParametersType      ParametersType;

  typedef Array< TInternalComputationValueType > DerivativeType;

  virtual MeasureType GetValue() const = 0;

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

protected:
  SingleValuedCostFunctionv4Template() {}
  virtual ~SingleValuedCostFunctionv4Template() {}

private:
  SingleValuedCostFunctionv4Template(const Self &); //purposely not implemented
  void operator=(const Self &);           //purposely not implemented
};

typedef SingleValuedCostFunctionv4Template<double> SingleValuedCostFunctionv4;

} // end namespace itk

#endif