itkCumulativeGaussianOptimizer.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 itkCumulativeGaussianOptimizer_h
#define itkCumulativeGaussianOptimizer_h
 
#include "itkMultipleValuedNonLinearOptimizer.h"
#include "itkCumulativeGaussianCostFunction.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
 
class ITKOptimizers_EXPORT CumulativeGaussianOptimizer : public MultipleValuedNonLinearOptimizer
{
public:
  using Self = CumulativeGaussianOptimizer;
  using Superclass = MultipleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using CostFunctionType = CumulativeGaussianCostFunction;

  using MeasureType = CostFunctionType::MeasureType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CumulativeGaussianOptimizer);

  itkSetMacro(DifferenceTolerance, double);
  itkGetMacro(DifferenceTolerance, double);
  itkSetMacro(Verbose, bool);
  itkGetMacro(Verbose, bool);
  itkBooleanMacro(Verbose);
  itkGetMacro(ComputedMean, double);
  itkGetMacro(ComputedStandardDeviation, double);
  itkGetMacro(UpperAsymptote, double);
  itkGetMacro(LowerAsymptote, double);
  itkGetMacro(FinalSampledArray, MeasureType *);
  itkGetMacro(FitError, double);
 
  void
  SetDataArray(MeasureType * cumGaussianArray);

  void
  StartOptimization() override;

  void
  PrintArray(MeasureType * array);

  std::string
  GetStopConditionDescription() const override;
 
protected:
  CumulativeGaussianOptimizer();
  ~CumulativeGaussianOptimizer() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  double m_DifferenceTolerance{};

  double m_ComputedMean{};

  double m_ComputedStandardDeviation{};

  double m_ComputedAmplitude{};

  double m_ComputedTransitionHeight{};

  double m_UpperAsymptote{};

  double m_LowerAsymptote{};

  double m_OffsetForMean{};

  bool m_Verbose{};

  double m_FitError{};

  MeasureType * m_FinalSampledArray{};

  MeasureType * m_CumulativeGaussianArray{};

  MeasureType *
  ExtendGaussian(MeasureType * originalArray, MeasureType * extendedArray, int startingPointForInsertion);

  MeasureType *
  RecalculateExtendedArrayFromGaussianParameters(MeasureType * originalArray,
                                                 MeasureType * extendedArray,
                                                 int           startingPointForInsertion) const;

  double
  FindAverageSumOfSquaredDifferences(MeasureType * array1, MeasureType * array2);

  void
  FindParametersOfGaussian(MeasureType * sampledGaussianArray);

  void
  MeasureGaussianParameters(MeasureType * array);

  void
  PrintComputedParameterHeader();

  void
  PrintComputedParameters() const;

  double
  VerticalBestShift(MeasureType * originalArray, MeasureType * newArray);

  std::ostringstream m_StopConditionDescription{};
};
} // end namespace itk
 
#endif