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:
  typedef RGBGibbsPriorFilter                             Self;
  typedef MRFImageFilter< TInputImage, TClassifiedImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(RGBGibbsPriorFilter, MRFImageFilter);

  typedef typename Superclass::InputImagePixelType           InputImagePixelType;
  typedef typename Superclass::InputImageRegionConstIterator InputImageRegionConstIterator;
  typedef typename Superclass::InputImageRegionIterator      InputImageRegionIterator;
  typedef typename Superclass::LabelledImageRegionIterator   LabelledImageRegionIterator;
  typedef typename Superclass::LabelledImagePixelType        LabelledImagePixelType;
  typedef typename Superclass::IndexValueType                IndexValueType;

  typedef TInputImage                        InputImageType;
  typedef typename TInputImage::Pointer      InputImagePointer;
  typedef typename TInputImage::ConstPointer InputImageConstPointer;

  typedef typename TInputImage::PixelType InputPixelType;

  typedef TClassifiedImage                   ClassifiedImageType;
  typedef typename TClassifiedImage::Pointer TrainingImageType;

  typedef typename TClassifiedImage::Pointer LabelledImageType;

  typedef typename TClassifiedImage::IndexType LabelledImageIndexType;

  typedef unsigned int LabelType;

  typedef ImageClassifierBase< TInputImage, TClassifiedImage > ClassifierType;

  typedef typename TInputImage::PixelType InputImageVecType;
  typedef typename TInputImage::IndexType IndexType;

  void SetTrainingImage(TrainingImageType image);

  void SetLabelledImage(LabelledImageType LabelledImage);

  LabelledImageType GetLabelledImage()
  { return m_LabelledImage; }

  void SetClassifier(typename ClassifierType::Pointer ptrToClassifier);

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

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

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

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

  itkSetMacro(ClusterSize, unsigned int);

  itkSetMacro(ObjectLabel, LabelType);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      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);

  typedef vnl_matrix< double > MatrixType;

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

  virtual void MinimizeFunctional() ITK_OVERRIDE;

  virtual void GenerateData() ITK_OVERRIDE;

  virtual void ApplyGibbsLabeller();

  virtual void ApplyGPImageFilter();

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

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

  typedef typename TInputImage::SizeType InputImageSizeType;

  typename ClassifierType::Pointer m_ClassifierPtr;

  unsigned int   m_ImageHeight;
  unsigned int   m_ImageDepth;

  void  GibbsTotalEnergy(int i);

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

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