itkScalarImageKmeansImageFilter.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 itkScalarImageKmeansImageFilter_h
#define itkScalarImageKmeansImageFilter_h
 
 
#include "itkKdTree.h"
#include "itkKdTreeBasedKmeansEstimator.h"
#include "itkWeightedCentroidKdTreeGenerator.h"
 
#include "itkSampleClassifierFilter.h"
#include "itkImageToListSampleAdaptor.h"
#include "itkMinimumDecisionRule.h"
 
#include "itkRegionOfInterestImageFilter.h"
 
#include <vector>
 
namespace itk
{
template <typename TInputImage, typename TOutputImage = Image<unsigned char, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT ScalarImageKmeansImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalarImageKmeansImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using Self = ScalarImageKmeansImageFilter;
  using Superclass = ImageToImageFilter<InputImageType, OutputImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ScalarImageKmeansImageFilter);

  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;

  using RealPixelType = typename NumericTraits<InputPixelType>::RealType;

  using AdaptorType = itk::Statistics::ImageToListSampleAdaptor<InputImageType>;

  using MeasurementVectorType = typename AdaptorType::MeasurementVectorType;
 
  using MembershipFunctionType = itk::Statistics::DistanceToCentroidMembershipFunction<MeasurementVectorType>;
  using ClassifierType = itk::Statistics::SampleClassifierFilter<AdaptorType>;
  using DecisionRuleType = itk::Statistics::MinimumDecisionRule;
 
  using ClassLabelVectorType = typename ClassifierType::ClassLabelVectorType;
 
  using MembershipFunctionVectorType = typename ClassifierType::MembershipFunctionVectorType;
  using MembershipFunctionOriginType = typename MembershipFunctionType::CentroidType;
 
  using MembershipFunctionPointer = typename MembershipFunctionType::Pointer;

  using TreeGeneratorType = itk::Statistics::WeightedCentroidKdTreeGenerator<AdaptorType>;
  using TreeType = typename TreeGeneratorType::KdTreeType;
  using EstimatorType = itk::Statistics::KdTreeBasedKmeansEstimator<TreeType>;
 
  using ParametersType = typename EstimatorType::ParametersType;
 
  using ImageRegionType = typename InputImageType::RegionType;
 
  using RegionOfInterestFilterType = RegionOfInterestImageFilter<InputImageType, InputImageType>;

  void
  AddClassWithInitialMean(RealPixelType mean);

  itkGetConstReferenceMacro(FinalMeans, ParametersType);

  itkSetMacro(UseNonContiguousLabels, bool);
  itkGetConstReferenceMacro(UseNonContiguousLabels, bool);
  itkBooleanMacro(UseNonContiguousLabels);

  void
  SetImageRegion(const ImageRegionType & region);

  itkGetConstReferenceMacro(ImageRegion, ImageRegionType);
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
 
protected:
  ScalarImageKmeansImageFilter();
  ~ScalarImageKmeansImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;
 
  /* See superclass for doxygen. This methods additionally checks that
   * the number of means is not 0. */
  void
  VerifyPreconditions() const override;
 
private:
  using MeansContainer = std::vector<RealPixelType>;
 
  MeansContainer m_InitialMeans{};
 
  ParametersType m_FinalMeans{};
 
  bool m_UseNonContiguousLabels{ false };
 
  ImageRegionType m_ImageRegion{};
 
  bool m_ImageRegionDefined{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarImageKmeansImageFilter.hxx"
#endif
 
#endif