itkKLMRegionGrowImageFilter.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 itkKLMRegionGrowImageFilter_h
#define itkKLMRegionGrowImageFilter_h

#include "itkImage.h"
#include "itkRegionGrowImageFilter.h"
#include "itkKLMSegmentationBorder.h"
#include "itkImageRegionIterator.h"
#include "itkConceptChecking.h"
#include <algorithm>
#include <functional>

namespace itk
{
template< typename TInputImage, typename TOutputImage >
class ITK_TEMPLATE_EXPORT KLMRegionGrowImageFilter:public RegionGrowImageFilter< TInputImage, TOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(KLMRegionGrowImageFilter);

  using Self = KLMRegionGrowImageFilter;
  using Superclass = RegionGrowImageFilter< TInputImage, TOutputImage >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(KLMRegionGrowImageFilter, RegionGrowImageFilter);

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

  using InputImagePixelType = typename TInputImage::PixelType;

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

  static constexpr unsigned int InputImageVectorDimension = InputImagePixelType::Dimension;

  using InputImageIndexType = typename TInputImage::IndexType;

  using InputImageIterator = ImageRegionIterator< TInputImage >;
  using InputImageConstIterator = ImageRegionConstIterator< TInputImage >;

  using InputRegionType = typename TInputImage::RegionType;

  using GridSizeType = typename Superclass::GridSizeType;

  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename TOutputImage::Pointer;

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using OutputImagePixelType = typename TOutputImage::PixelType;

  using OutputImageVectorType = typename TOutputImage::PixelType::VectorType;

  static constexpr unsigned int OutputImageVectorDimension = OutputImagePixelType::Dimension;

  using OutputImageIndexType = typename TOutputImage::IndexType;

  using OutputImageIterator = ImageRegionIterator< TOutputImage >;

  using RegionLabelType = typename KLMSegmentationRegion::RegionLabelType;

  static constexpr RegionLabelType LabelImageDimension = InputImageDimension;

  using LabelImageType = Image< RegionLabelType, Self::LabelImageDimension >;

  using LabelImagePointer = typename LabelImageType::Pointer;

  using LabelImagePixelType = typename LabelImageType::PixelType;

  using LabelImageIndexType = typename LabelImageType::IndexType;

  using LabelImageIterator = ImageRegionIterator< LabelImageType >;

  using MeanRegionIntensityType = vnl_vector< double >;

  using BorderType = KLMSegmentationBorder;

  using KLMSegmentationBorderArrayPtr = KLMDynamicBorderArray< BorderType >;

  itkSetMacro(MaximumLambda, double);
  itkGetConstReferenceMacro(MaximumLambda, double);

  itkSetMacro(NumberOfRegions, unsigned int);
  itkGetConstReferenceMacro(NumberOfRegions, unsigned int);

  LabelImagePointer GetLabelledImage();

  void PrintAlgorithmRegionStats();

  void PrintAlgorithmBorderStats();

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< typename InputImagePixelType::ValueType > ) );
  itkConceptMacro( SameDimension,
                   ( Concept::SameDimension< Self::InputImageDimension,
                                             Self::OutputImageDimension > ) );
#if defined(THIS_CONCEPT_FAILS_ON_GCC)

  itkConceptMacro( SameVectorDimension,
                   ( Concept::SameDimension< Self::InputImageVectorDimension,
                                             Self::OutputImageVectorDimension > ) );
#endif
  // End concept checking
#endif

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

  void GenerateData() override;

  void GenerateInputRequestedRegion() override;

  void EnlargeOutputRequestedRegion(DataObject *) override;

  void ApplyRegionGrowImageFilter() override;

  void MergeRegions() override;

  virtual void GenerateOutputImage();

  void ApplyKLM();

  void InitializeKLM();

  LabelImagePointer GenerateLabelledImage(LabelImageType *labelImagePtr);

  virtual void InitializeRegionParameters(InputRegionType region);

  virtual void ResolveRegions();

private:
  using InputImageSizeType = typename TInputImage::SizeType;
  using KLMSegmentationRegionPtr = typename KLMSegmentationRegion::Pointer;
  using KLMSegmentationBorderPtr = typename KLMSegmentationBorder::Pointer;

  double       m_MaximumLambda{1000};
  unsigned int m_NumberOfRegions{0};

  double       m_InternalLambda{0};
  unsigned int m_InitialNumberOfRegions{0};
  double       m_TotalBorderLength{0.0};

  std::vector< KLMSegmentationRegionPtr >      m_RegionsPointer;
  std::vector< KLMSegmentationBorderPtr >      m_BordersPointer;
  std::vector< KLMSegmentationBorderArrayPtr > m_BordersDynamicPointer;
  KLMSegmentationBorderArrayPtr *              m_BorderCandidate{nullptr};

  MeanRegionIntensityType m_InitialRegionMean;
  double                  m_InitialRegionArea{0};
}; // class KLMRegionGrowImageFilter
} // namespace itk

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

#endif