Medical Imaging Interaction Toolkit  2018.4.99-87d68d9f
Medical Imaging Interaction Toolkit
mitk::BasicCombinationOpenCVImageFilter Class Reference

#include <mitkBasicCombinationOpenCVImageFilter.h>

Inheritance diagram for mitk::BasicCombinationOpenCVImageFilter:
Collaboration diagram for mitk::BasicCombinationOpenCVImageFilter:

Public Member Functions

 mitkClassMacro (BasicCombinationOpenCVImageFilter, AbstractOpenCVImageFilter)
 
Pointer Clone () const
 
bool OnFilterImage (cv::Mat &image) override
 Apply list of filters to the given image. More...
 
void PushFilter (AbstractOpenCVImageFilter::Pointer filter)
 Push an additional filter to the list of filters for applying to an image. More...
 
AbstractOpenCVImageFilter::Pointer PopFilter ()
 Remove and return the last filter added to the list of filters. More...
 
bool RemoveFilter (AbstractOpenCVImageFilter::Pointer filter)
 Remove the given filter from the list of filters. More...
 
bool GetIsFilterOnTheList (AbstractOpenCVImageFilter::Pointer filter)
 Get the information if the given filter is on the filter list. More...
 
bool GetIsEmpty ()
 Get the information if no filter is on the filter list. More...
 
- Public Member Functions inherited from mitk::AbstractOpenCVImageFilter
 mitkClassMacroItkParent (AbstractOpenCVImageFilter, itk::Object)
 
virtual bool FilterImage (cv::Mat &image, int id=INVALID_IMAGE_ID)
 

Static Public Member Functions

static Pointer New ()
 

Protected Attributes

std::vector< AbstractOpenCVImageFilter::Pointer > m_FilterList
 All filters applied to the given image during call of mitk::mitkBasicCombinationOpenCVImageFilter::FilterImage(). More...
 
- Protected Attributes inherited from mitk::AbstractOpenCVImageFilter
int m_CurrentImageId
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::AbstractOpenCVImageFilter
static int INVALID_IMAGE_ID
 
- Protected Member Functions inherited from mitk::AbstractOpenCVImageFilter
 AbstractOpenCVImageFilter ()
 
int GetCurrentImageId ()
 

Detailed Description

Definition at line 22 of file mitkBasicCombinationOpenCVImageFilter.h.

Member Function Documentation

◆ Clone()

Pointer mitk::BasicCombinationOpenCVImageFilter::Clone ( ) const

◆ GetIsEmpty()

bool mitk::BasicCombinationOpenCVImageFilter::GetIsEmpty ( )

Get the information if no filter is on the filter list.

Returns
true if the filter list if empty, false otherwise

Definition at line 65 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References m_FilterList.

◆ GetIsFilterOnTheList()

bool mitk::BasicCombinationOpenCVImageFilter::GetIsFilterOnTheList ( AbstractOpenCVImageFilter::Pointer  filter)

Get the information if the given filter is on the filter list.

Returns
true if the filter is on the list, false otherwise

Definition at line 60 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References m_FilterList.

◆ mitkClassMacro()

mitk::BasicCombinationOpenCVImageFilter::mitkClassMacro ( BasicCombinationOpenCVImageFilter  ,
AbstractOpenCVImageFilter   
)

◆ New()

static Pointer mitk::BasicCombinationOpenCVImageFilter::New ( )
static

◆ OnFilterImage()

bool mitk::BasicCombinationOpenCVImageFilter::OnFilterImage ( cv::Mat &  image)
overridevirtual

Apply list of filters to the given image.

Returns
false if one of the filter returns false. Be careful, that the image could already be changed when the function returned false.

Implements mitk::AbstractOpenCVImageFilter.

Definition at line 19 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References mitk::AbstractOpenCVImageFilter::GetCurrentImageId(), and m_FilterList.

◆ PopFilter()

AbstractOpenCVImageFilter::Pointer mitk::BasicCombinationOpenCVImageFilter::PopFilter ( )

Remove and return the last filter added to the list of filters.

Returns
last filter added to the list of filters

Definition at line 39 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References m_FilterList.

◆ PushFilter()

void mitk::BasicCombinationOpenCVImageFilter::PushFilter ( AbstractOpenCVImageFilter::Pointer  filter)

Push an additional filter to the list of filters for applying to an image.

Definition at line 34 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References m_FilterList.

◆ RemoveFilter()

bool mitk::BasicCombinationOpenCVImageFilter::RemoveFilter ( AbstractOpenCVImageFilter::Pointer  filter)

Remove the given filter from the list of filters.

Returns
true if the filter was on the list, false if it wasn't

Definition at line 46 of file mitkBasicCombinationOpenCVImageFilter.cpp.

References m_FilterList.

Member Data Documentation

◆ m_FilterList

std::vector<AbstractOpenCVImageFilter::Pointer> mitk::BasicCombinationOpenCVImageFilter::m_FilterList
protected

All filters applied to the given image during call of mitk::mitkBasicCombinationOpenCVImageFilter::FilterImage().

Definition at line 68 of file mitkBasicCombinationOpenCVImageFilter.h.

Referenced by GetIsEmpty(), GetIsFilterOnTheList(), OnFilterImage(), PopFilter(), PushFilter(), and RemoveFilter().


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