mitkGrabCutOpenCVImageFilter.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MITKGRABCUTOPENCVIMAGEFILTER_H
#define MITKGRABCUTOPENCVIMAGEFILTER_H

// mitk headers
#include "mitkAbstractOpenCVImageFilter.h"
#include "mitkVector.h"

// itk headers
#include "itkObjectFactory.h"
#include "itkMutexLock.h"

// opencv headers
#include <opencv2/core.hpp>

namespace itk {
template<unsigned int T> class Index;
template<class T> class SmartPointer;
class MultiThreader;
class ConditionVariable;
class FastMutexLock;
}

namespace mitk {
class PointSet;

class MITKOPENCVVIDEOSUPPORT_EXPORT GrabCutOpenCVImageFilter : public AbstractOpenCVImageFilter
{
public:
  typedef std::vector<itk::Index<2> > ModelPointsList;

  mitkClassMacro(GrabCutOpenCVImageFilter, AbstractOpenCVImageFilter);

  itkFactorylessNewMacro(Self);

  itkCloneMacro(Self);

  GrabCutOpenCVImageFilter();
  ~GrabCutOpenCVImageFilter() override;

  bool OnFilterImage( cv::Mat& image ) override;

  void SetModelPoints(ModelPointsList foregroundPoints);

  void SetModelPoints(ModelPointsList foregroundPoints, ModelPointsList backgroundPoints);

  void SetModelPoints(cv::Mat foregroundMask);

  void SetModelPoints(cv::Mat foregroundMask, cv::Mat backgroundMask);

  void SetModelPointsDilationSize(int modelPointsDilationSize);

  void SetUseOnlyRegionAroundModelPoints(unsigned int additionalBorder);

  void SetUseFullImage();

  cv::Rect GetRegionAroundModelPoints();

  int GetResultImageId();

  cv::Mat GetResultMask();

  std::vector<ModelPointsList> GetResultContours();

  ModelPointsList GetResultContourWithPixel(itk::Index<2> pixelIndex);

protected:
  cv::Mat GetMaskFromPointSets();

  cv::Rect GetBoundingRectFromMask(cv::Mat mask);

  cv::Mat RunSegmentation(cv::Mat input, cv::Mat mask);

  ModelPointsList ConvertMaskToModelPointsList(cv::Mat mask);

  int                          m_ModelPointsDilationSize;

  bool                         m_UseOnlyRegionAroundModelPoints;
  unsigned int                 m_AdditionalWidth;
  cv::Rect                     m_BoundingBox;

  ModelPointsList              m_ForegroundPoints;
  ModelPointsList              m_BackgroundPoints;

  cv::Mat                      m_InputImage;
  cv::Mat                      m_GrabCutMask;
  cv::Mat                      m_ResultMask;

  unsigned int                 m_CurrentProcessImageNum;

  int                          m_InputImageId;

  int                          m_ResultImageId;

private:
  static ITK_THREAD_RETURN_TYPE SegmentationWorker(void* pInfoStruct);

  int                                       m_ThreadId;

  bool                                      m_StopThread;

  itk::SmartPointer<itk::MultiThreader>     m_MultiThreader;
  itk::SmartPointer<itk::ConditionVariable> m_WorkerBarrier;

  itk::SmartPointer<itk::FastMutexLock>     m_ImageMutex;

  itk::SmartPointer<itk::FastMutexLock>     m_ResultMutex;

  itk::SmartPointer<itk::FastMutexLock>     m_PointSetsMutex;
};
} // namespace mitk

#endif // MITKGRABCUTOPENCVIMAGEFILTER_H