itkRGBGibbsPriorFilter.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 itkRGBGibbsPriorFilter_h
#define itkRGBGibbsPriorFilter_h

#include "vnl/vnl_vector.h"
#include "vnl/vnl_matrix.h"

#include "itkMRFImageFilter.h"

namespace itk
{
template< typename TInputImage, typename TClassifiedImage >
class ITK_TEMPLATE_EXPORT RGBGibbsPriorFilter:public MRFImageFilter< TInputImage,
                                                            TClassifiedImage >
{
public:
  using Self = RGBGibbsPriorFilter;
  using Superclass = MRFImageFilter< TInputImage, TClassifiedImage >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(RGBGibbsPriorFilter, MRFImageFilter);

  using InputImagePixelType = typename Superclass::InputImagePixelType;
  using InputImageRegionConstIterator = typename Superclass::InputImageRegionConstIterator;
  using InputImageRegionIterator = typename Superclass::InputImageRegionIterator;
  using LabelledImageRegionIterator = typename Superclass::LabelledImageRegionIterator;
  using LabelledImagePixelType = typename Superclass::LabelledImagePixelType;
  using IndexValueType = typename Superclass::IndexValueType;

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

  using InputPixelType = typename TInputImage::PixelType;

  using ClassifiedImageType = TClassifiedImage;
  using TrainingImageType = typename TClassifiedImage::Pointer;

  using LabelledImageType = typename TClassifiedImage::Pointer;

  using LabelledImageIndexType = typename TClassifiedImage::IndexType;

  using LabelType = unsigned int;

  using ClassifierType = ImageClassifierBase< TInputImage, TClassifiedImage >;

  using InputImageVecType = typename TInputImage::PixelType;
  using IndexType = typename TInputImage::IndexType;

  void SetTrainingImage(TrainingImageType image);

  void SetLabelledImage(LabelledImageType LabelledImage);

  LabelledImageType GetLabelledImage()
  { return m_LabelledImage; }

  void SetClassifier(typename ClassifierType::Pointer ptrToClassifier);

  void SetNumberOfClasses( const unsigned int numberOfClasses ) override
    {
    itkDebugMacro("setting NumberOfClasses to " << numberOfClasses );
    if ( this->m_NumberOfClasses != numberOfClasses )
      {
      this->m_NumberOfClasses = numberOfClasses;
      this->Modified();
      }
    }

  unsigned int GetNumberOfClasses() const override
    {
    return this->m_NumberOfClasses;
    }

  void SetMaximumNumberOfIterations( const unsigned int numberOfIterations ) override
    {
    itkDebugMacro("setting MaximumNumberOfIterations to " << numberOfIterations);
    if ( this->m_MaximumNumberOfIterations != numberOfIterations )
      {
      this->m_MaximumNumberOfIterations = numberOfIterations;
      this->Modified();
      }
    }

  unsigned int GetMaximumNumberOfIterations() const override
    {
    return this->m_MaximumNumberOfIterations;
    }

  itkSetMacro(ClusterSize, unsigned int);

  itkSetMacro(ObjectLabel, LabelType);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  itkSetMacro(StartPoint, IndexType);

  itkSetMacro(BoundaryGradient, unsigned int);

  itkSetMacro(ObjectThreshold, double);

  itkSetMacro(CliqueWeight_1, double);
  itkGetConstMacro(CliqueWeight_1, double);
  itkSetMacro(CliqueWeight_2, double);
  itkGetConstMacro(CliqueWeight_2, double);
  itkSetMacro(CliqueWeight_3, double);
  itkGetConstMacro(CliqueWeight_3, double);
  itkSetMacro(CliqueWeight_4, double);
  itkGetConstMacro(CliqueWeight_4, double);
  itkSetMacro(CliqueWeight_5, double);
  itkGetConstMacro(CliqueWeight_5, double);
  itkSetMacro(CliqueWeight_6, double);
  itkGetConstMacro(CliqueWeight_6, double);

  using MatrixType = vnl_matrix< double >;

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

  void MinimizeFunctional() override;

  void GenerateData() override;

  virtual void ApplyGibbsLabeller();

  virtual void ApplyGPImageFilter();

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( SameDimension,
                   ( Concept::SameDimension< Self::InputImageType::ImageDimension,
                                             Self::ClassifiedImageType::ImageDimension > ) );
  itkConceptMacro( DimensionShouldBe3,
                   ( Concept::SameDimension< Self::InputImageType::ImageDimension, 3 > ) );
  // End concept checking
#endif

private:
  RGBGibbsPriorFilter(const Self &) = delete;
  void operator=(const Self &) = delete;

  using InputImageSizeType = typename TInputImage::SizeType;

  typename ClassifierType::Pointer m_ClassifierPtr;

  unsigned int   m_ImageHeight{0};
  unsigned int   m_ImageDepth{0};

  void  GibbsTotalEnergy(int i);

  double GibbsEnergy(unsigned int i, unsigned int k, unsigned int k1);

  double m_ObjectThreshold{5.0};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkRGBGibbsPriorFilter.hxx"
#endif
#endif