itkImageKmeansModelEstimator.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 itkImageKmeansModelEstimator_h
#define itkImageKmeansModelEstimator_h

#include <ctime>
#include <cmath>
#include <cfloat>

#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"
#include "itkMath.h"
#include "vnl/algo/vnl_matrix_inverse.h"

#include "itkImageRegionIterator.h"
#include "itkMacro.h"

#include "itkImageModelEstimatorBase.h"

#define  ONEBAND           1
#define  GLA_CONVERGED     1
#define  GLA_NOT_CONVERGED 2
#define  LBG_COMPLETED     3

namespace itk
{
template< typename TInputImage,
          typename TMembershipFunction >
class ITK_TEMPLATE_EXPORT ImageKmeansModelEstimator:
  public ImageModelEstimatorBase< TInputImage, TMembershipFunction >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ImageKmeansModelEstimator);

  using Self = ImageKmeansModelEstimator;
  using Superclass =
      ImageModelEstimatorBase< TInputImage, TMembershipFunction >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(ImageKmeansModelEstimator, ImageModelEstimatorBase);

  using InputImageType = TInputImage;
  using InputImagePointer = typename TInputImage::Pointer;
  using InputImageConstPointer = typename TInputImage::ConstPointer;

  using InputImageVectorType = typename TInputImage::PixelType::VectorType;

  using InputImagePixelType = typename TInputImage::PixelType;

  using InputImageIterator = ImageRegionIterator< TInputImage >;

  using InputImageConstIterator = ImageRegionConstIterator< TInputImage >;

  using MembershipFunctionPointer = typename TMembershipFunction::Pointer;

  using CodebookMatrixOfDoubleType = vnl_matrix< double >;

  using CodebookMatrixOfIntegerType = vnl_matrix< int >;

  void SetCodebook(CodebookMatrixOfDoubleType InCodebook);

  itkGetConstMacro(Codebook, CodebookMatrixOfDoubleType);

  CodebookMatrixOfDoubleType GetOutCodebook() { return m_Codebook; }

  itkSetMacro(Threshold, double);

  itkGetConstMacro(Threshold, double);

  itkSetMacro(OffsetAdd, double);

  itkGetConstMacro(OffsetAdd, double);

  itkSetMacro(OffsetMultiply, double);

  itkGetConstMacro(OffsetMultiply, double);

  itkSetMacro(MaxSplitAttempts, int);

  itkGetConstMacro(MaxSplitAttempts, int);

  CodebookMatrixOfDoubleType GetKmeansResults() { return m_Centroid; }

protected:
  ImageKmeansModelEstimator();
  ~ImageKmeansModelEstimator() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void GenerateData() override;

  void Allocate();

  void PrintKmeansAlgorithmResults();

private:
  void EstimateModels() override;

  void EstimateKmeansModelParameters();

  using ImageSizeType = typename TInputImage::SizeType;

  using InputPixelVectorType = typename TInputImage::PixelType::VectorType;

  void Reallocate(int oldSize, int newSize);

  //Local functions
  int  WithCodebookUseGLA(); // GLA stands for the Generalized Lloyd Algorithm

  int  WithoutCodebookUseLBG(); //LBG stands for the Lindo Buzo Gray Algorithm

  void NearestNeighborSearchBasic(double *distortion);

  void SplitCodewords(int currentSize,
                      int numDesired,
                      int scale);

  void Perturb(double *oldCodeword,
               int scale,
               double *newCodeword);

  CodebookMatrixOfDoubleType m_Codebook;

  // Buffer for K-means calcualtions
  CodebookMatrixOfDoubleType m_Centroid;

  double m_Threshold;
  double m_OffsetAdd;
  double m_OffsetMultiply;
  int    m_MaxSplitAttempts;

  bool   m_ValidInCodebook;
  double m_DoubleMaximum;
  double m_OutputDistortion;
  int    m_OutputNumberOfEmptyCells;

  SizeValueType m_VectorDimension;
  SizeValueType m_NumberOfCodewords;
  SizeValueType m_CurrentNumberOfCodewords;

  CodebookMatrixOfIntegerType m_CodewordHistogram;
  CodebookMatrixOfDoubleType  m_CodewordDistortion;
}; // class ImageKmeansModelEstimator

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageKmeansModelEstimator.hxx"
#endif

#endif