BlobFilter Class Reference

Class to build a filter for the blob search. More...

#include <cvb/foundation/blob.hpp>

Public Member Functions
	BlobFilter ()=default
	Default filter without any filter set.
Cvb::Foundation::Blob::BlobBorderFilter	BorderFilter () const noexcept
	Gets whether to filter blobs that touch the borders of the image.
void	SetBorderFilter (Cvb::Foundation::Blob::BlobBorderFilter borderFilter) noexcept
	Sets whether to filter blobs that touch the borders of the image.
bool	ContainsRangeFilter (BlobRangeFilter rangeFilter) const noexcept
	Check if a range filter exists.
ValueRange< int > &	operator[] (BlobRangeFilter rangeFilter)
	Sets the range filters via an attribute.

Friends
std::vector< BlobResult >	BinarizeAndSearchBlobs (const ImagePlane &plane, ValueRange< int > binarizationThreshold, const BlobFilter &filter)
	Searches for all blobs in the given image plane.
std::vector< BlobResult >	BinarizeAndSearchBlobs (const ImagePlane &plane, ValueRange< int > binarizationThreshold, Rect< int > aoi, const BlobFilter &filter)
	Searches for all blobs in the given image plane.
std::vector< BlobResult >	SearchBlobs (const Image &binarizedImage, const BlobFilter &filter)
	Searches for all blobs in the given binarized image.
std::vector< BlobResult >	SearchBlobs (const Image &binarizedImage, Rect< int > aoi, const BlobFilter &filter)
	Searches for all blobs in the given binarized image.

Detailed Description

Class to build a filter for the blob search.

Constructor & Destructor Documentation

BlobFilter()

BlobFilter ( )

default

Default filter without any filter set.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

BorderFilter()

Cvb::Foundation::Blob::BlobBorderFilter BorderFilter ( ) const

inlinenoexcept

Gets whether to filter blobs that touch the borders of the image.

Returns

The border filter flags.

Exceptions

Does	not throw any exception.

ContainsRangeFilter()

bool ContainsRangeFilter ( BlobRangeFilter rangeFilter ) const

inlinenoexcept

Check if a range filter exists.

Parameters

[in]

rangeFilter

The range filter attribute.

Returns

True if a range filter for the given attribute exists, false otherwise.

Exceptions

Does	not throw any exception.

operator[]()

ValueRange< int > & operator[] ( BlobRangeFilter rangeFilter )

inline

Sets the range filters via an attribute.

Parameters

[in]

rangeFilter

The filter range attribute.

Returns

The filter range.

Exceptions

Any	exception derived from std::exception including CvbException.

If a a filter range is read from default/empty filter an invalid range is returned. So you should check if a range filter exists for a given attribute using ContainsRangeFilter().

SetBorderFilter()

void SetBorderFilter ( Cvb::Foundation::Blob::BlobBorderFilter borderFilter )

inlinenoexcept

Sets whether to filter blobs that touch the borders of the image.

Parameters

[in]

borderFilter

The border filter flags.

Exceptions

Does	not throw any exception.

Friends And Related Symbol Documentation

BinarizeAndSearchBlobs [1/2]

std::vector< BlobResult > BinarizeAndSearchBlobs ( const ImagePlane & plane, ValueRange< int > binarizationThreshold, const BlobFilter & filter )

friend

Searches for all blobs in the given image plane.

Parameters

[in]	plane	Image plane to process.
[in]	binarizationThreshold	Minimum and maximum gray values (inclusive) to be considered as an object.
[in]	filter	Filter which blobs are to be returned.

Returns

Unordered blob results.

Exceptions

Any	exception derived from std::exception including CvbException.

BinarizeAndSearchBlobs [2/2]

std::vector< BlobResult > BinarizeAndSearchBlobs ( const ImagePlane & plane, ValueRange< int > binarizationThreshold, Rect< int > aoi, const BlobFilter & filter )

friend

Searches for all blobs in the given image plane.

Parameters

[in]	plane	Image plane to process.
[in]	binarizationThreshold	Minimum and maximum gray values (inclusive) to be considered as an object.
[in]	aoi	Region in which blobs are to be searched.
[in]	filter	Filter which blobs are to be returned.

Returns

Unordered blob results.

Exceptions

Any	exception derived from std::exception including CvbException.

SearchBlobs [1/2]

std::vector< BlobResult > SearchBlobs ( const Image & binarizedImage, const BlobFilter & filter )

friend

Searches for all blobs in the given binarized image.

Parameters

[in]	binarizedImage	Image consisting only of 0 and 255.
[in]	filter	Filter which blobs are to be returned.

Returns

Unordered blob results.

Exceptions

Any	exception derived from std::exception including CvbException.

Image containing pixels with values 0 or 255. 255 marks an object.

SearchBlobs [2/2]

std::vector< BlobResult > SearchBlobs ( const Image & binarizedImage, Rect< int > aoi, const BlobFilter & filter )

friend

Searches for all blobs in the given binarized image.

Parameters

[in]	binarizedImage	Image consisting only of 0 and 255.
[in]	aoi	Region in which blobs are to be searched.
[in]	filter	Filter which blobs are to be returned.

Returns

Unordered blob results.

Exceptions

Any	exception derived from std::exception including CvbException.

Image containing pixels with values 0 or 255. 255 marks an object.