Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
mitk::AbstractOpenCVImageFilter Class Referenceabstract

Interface for image filters on OpenCV images. More...

#include <mitkAbstractOpenCVImageFilter.h>

Inheritance diagram for mitk::AbstractOpenCVImageFilter:
Inheritance graph
[legend]
Collaboration diagram for mitk::AbstractOpenCVImageFilter:
Collaboration graph
[legend]

Public Member Functions

 mitkClassMacroItkParent (AbstractOpenCVImageFilter, itk::Object)
 
virtual bool FilterImage (cv::Mat &image, int id=INVALID_IMAGE_ID)
 
virtual bool OnFilterImage (cv::Mat &image)=0
 Pure virtual method for filtering an image. More...
 

Static Public Attributes

static int INVALID_IMAGE_ID
 

Protected Member Functions

 AbstractOpenCVImageFilter ()
 
int GetCurrentImageId ()
 

Protected Attributes

int m_CurrentImageId
 

Detailed Description

Interface for image filters on OpenCV images.

Every concrete filter has to implement the pure virual mitk::AbstractOpenCVImageFilter::filterImage() method.

Definition at line 36 of file mitkAbstractOpenCVImageFilter.h.

Constructor & Destructor Documentation

◆ AbstractOpenCVImageFilter()

mitk::AbstractOpenCVImageFilter::AbstractOpenCVImageFilter ( )
protected

Definition at line 17 of file mitkAbstractOpenCVImageFilter.cpp.

Member Function Documentation

◆ FilterImage()

bool mitk::AbstractOpenCVImageFilter::FilterImage ( cv::Mat &  image,
int  id = INVALID_IMAGE_ID 
)
virtual

Definition at line 21 of file mitkAbstractOpenCVImageFilter.cpp.

References INVALID_IMAGE_ID, m_CurrentImageId, and OnFilterImage().

◆ GetCurrentImageId()

int mitk::AbstractOpenCVImageFilter::GetCurrentImageId ( )
protected

Definition at line 29 of file mitkAbstractOpenCVImageFilter.cpp.

References m_CurrentImageId.

Referenced by mitk::BasicCombinationOpenCVImageFilter::OnFilterImage(), and mitk::GrabCutOpenCVImageFilter::OnFilterImage().

◆ mitkClassMacroItkParent()

mitk::AbstractOpenCVImageFilter::mitkClassMacroItkParent ( AbstractOpenCVImageFilter  ,
itk::Object   
)

◆ OnFilterImage()

virtual bool mitk::AbstractOpenCVImageFilter::OnFilterImage ( cv::Mat &  image)
pure virtual

Pure virtual method for filtering an image.

Parameters
imageOpenCV image which is supposed to be manipulated.
Returns
true if filtering was successfull, false otherwise

Implemented in mitk::GrabCutOpenCVImageFilter, mitk::CropOpenCVImageFilter, mitk::ConvertGrayscaleOpenCVImageFilter, and mitk::BasicCombinationOpenCVImageFilter.

Referenced by FilterImage().

Member Data Documentation

◆ INVALID_IMAGE_ID

int mitk::AbstractOpenCVImageFilter::INVALID_IMAGE_ID
static

Definition at line 40 of file mitkAbstractOpenCVImageFilter.h.

Referenced by FilterImage().

◆ m_CurrentImageId

int mitk::AbstractOpenCVImageFilter::m_CurrentImageId
protected

Definition at line 59 of file mitkAbstractOpenCVImageFilter.h.

Referenced by FilterImage(), and GetCurrentImageId().

The documentation for this class was generated from the following files: