itkCumulativeGaussianCostFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkCumulativeGaussianCostFunction_h
#define itkCumulativeGaussianCostFunction_h
 
#include "itkMultipleValuedCostFunction.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
 
class ITKOptimizers_EXPORT CumulativeGaussianCostFunction : public MultipleValuedCostFunction
{
public:
  using Self = CumulativeGaussianCostFunction;
  using Superclass = MultipleValuedCostFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(CumulativeGaussianCostFunction);

  itkNewMacro(Self);

  using ParametersType = Superclass::ParametersType;
  using MeasureType = Superclass::MeasureType;
  using DerivativeType = Superclass::DerivativeType;

  enum
  {
    SpaceDimension = 4
  };

  void
  GetDerivative(const ParametersType & itkNotUsed(parameters), DerivativeType & itkNotUsed(derivative)) const override
  {}

  MeasureType
  GetValue(const ParametersType & parameters) const override;

  MeasureType *
  GetValuePointer(ParametersType & parameters);

  double
  CalculateFitError(MeasureType * setTestArray);

  double
  EvaluateCumulativeGaussian(double argument) const;

  unsigned int
  GetNumberOfParameters() const override;

  unsigned int
  GetNumberOfValues() const override;

  void
  Initialize(unsigned int rangeDimension);

  void
  SetOriginalDataArray(MeasureType * setOriginalDataArray);
 
protected:
  CumulativeGaussianCostFunction();
  ~CumulativeGaussianCostFunction() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  MeasureType m_OriginalDataArray{};

  unsigned int m_RangeDimension{ 0 };

  mutable MeasureType    m_Measure{};
  mutable MeasureType    m_MeasurePointer{};
  mutable ParametersType m_Parameters{};
};
} // end namespace itk
 
#endif