This class implements a 2D bounding box with pixel precision. More...

#include <PixelBoundingBox.h>

Inheritance diagram for Ocean::CV::PixelBoundingBoxT< T >:

Public Member Functions
	PixelBoundingBoxT ()
	Creates a empty bounding box.

	PixelBoundingBoxT (const PixelBoundingBoxT< T > &boundingBox)
	Copy constructor.

	PixelBoundingBoxT (const PixelPositionT< T > &point)
	Creates a bounding box covering one point only.

	PixelBoundingBoxT (const std::vector< PixelPositionT< T > > &points)
	Creates a bounding box covering several points.

	PixelBoundingBoxT (const T left, const T top, const T right, const T bottom)
	Creates a bounding box with specified dimension.

	PixelBoundingBoxT (const PixelPositionT< T > &topLeft, const unsigned int width, const unsigned int height)
	Creates a bounding box by a given top left position and a width and height of the bounding box.

	PixelBoundingBoxT (const PixelPositionT< T > &point0, const PixelPositionT< T > &point1)
	Creates a bounding box covering two points.

T	left () const
	Returns the left (including) pixel position of this bounding box.

T	top () const
	Returns the top (including) pixel position of this bounding box.

T	right () const
	Returns the right (including) pixel position of this bounding box.

T	rightEnd () const
	Returns the right (excluding) pixel position of this bounding box.

T	bottom () const
	Returns the bottom (including) position of this bounding box.

T	bottomEnd () const
	Returns the bottom (excluding) pixel position of this bounding box.

PixelPositionT< T >	topLeft () const
	Returns the top left corner of this bounding box.

PixelPositionT< T >	topRight () const
	Returns the top right corner of this bounding box.

PixelPositionT< T >	bottomLeft () const
	Returns the bottom left corner of this bounding box.

PixelPositionT< T >	bottomRight () const
	Returns the bottom right corner of this bounding box.

unsigned int	width () const
	Returns the width (the number of horizontal including pixels) of this bounding box.

unsigned int	height () const
	Returns the height (the number of vertical including pixels) of this bounding box.

unsigned int	size () const
	Returns the area (the number of including pixels) this bounding box covers.

bool	isInside (const PixelPositionT< T > &point) const
	Returns whether a given point lies inside this bounding box.

bool	isInside (const PixelBoundingBoxT< T > &boundingBox) const
	Returns whether a given bounding box lies entirely inside this bounding box.

bool	hasIntersection (const PixelBoundingBoxT< T > &boundingBox) const
	Returns whether a given bounding box has an intersection with this bounding box.

bool	isTouching (const PixelBoundingBoxT< T > &boundingBox, const bool useNeighborhood8) const
	Returns whether a given bounding box is touching this bounding box.

PixelBoundingBoxT< T >	extended (const unsigned int pixels, const T minLeft, const T minTop, const T maxRight, const T maxBottom) const
	Returns a new bounding box by extending this bounding box with a given number of pixel in each direction.

bool	isValid () const
	Returns whether this bounding box covers a valid pixel area.

PixelBoundingBoxT< T > &	operator+= (const PixelPositionT< T > &point)
	Adds a new point to the bounding box.

PixelBoundingBoxT< T > &	operator= (const PixelBoundingBoxT< T > &other)=default
	Assignment operator override to match copy constructor.

bool	operator== (const PixelBoundingBoxT< T > &box) const
	Returns whether two bounding boxes are equal.

bool	operator!= (const PixelBoundingBoxT< T > &box) const
	Returns whether two bounding boxes are not equal.

PixelBoundingBoxT< T >	operator* (const T factor) const
	Multiplies this bounding box by a specified scalar (multiplies left, top, right, and bottom location by the scalar).

PixelBoundingBoxT< T > &	operator*= (const T factor)
	Multiplies this bounding box by a specified scalar (multiplies left, top, right, and bottom location by the scalar).

PixelBoundingBoxT< T >	operator/ (const T factor) const
	Divides this bounding box by a specified scalar (divides left, top, right, and bottom location by the scalar).

PixelBoundingBoxT< T > &	operator/= (const T factor)
	Divides this bounding box by a specified scalar (divides left, top, right, and bottom location by the scalar).

PixelBoundingBoxT< T >	operator\|\| (const PixelBoundingBoxT< T > &box) const
	Returns the union of two bounding boxes.

PixelBoundingBoxT< T >	operator&& (const PixelBoundingBoxT< T > &box) const
	Returns the intersection of two bounding boxes.

size_t	operator() (const PixelBoundingBoxT< T > &boundingBox) const
	Hash function.

	operator bool () const
	Returns whether this bounding box covers a valid pixel area.

Private Attributes
T	left_
	Left (including) pixel position of this bounding box.

T	top_
	Top (including) pixel position of this bounding box.

T	right_
	Right (including) pixel position of this bounding box.

T	bottom_
	Bottom (including) pixel position of this bounding box.

Detailed Description

template<typename T>
class Ocean::CV::PixelBoundingBoxT< T >

This class implements a 2D bounding box with pixel precision.

Constructor & Destructor Documentation

◆ PixelBoundingBoxT() [1/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT ( )

inline

Creates a empty bounding box.

◆ PixelBoundingBoxT() [2/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT ( const PixelBoundingBoxT< T > & boundingBox )

inline

Copy constructor.

Parameters

boundingBox The bounding box to copy

◆ PixelBoundingBoxT() [3/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT ( const PixelPositionT< T > & point )

inlineexplicit

Creates a bounding box covering one point only.

Parameters

point The point the box will cover

◆ PixelBoundingBoxT() [4/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT ( const std::vector< PixelPositionT< T > > & points )

inlineexplicit

Creates a bounding box covering several points.

Parameters

points The points the box will cover

◆ PixelBoundingBoxT() [5/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT	(	const T	left,
		const T	top,
		const T	right,
		const T	bottom
	)

inline

Creates a bounding box with specified dimension.

Parameters

left	Left (including) pixel position
top	Top (including) pixel position
right	Right (including) pixel position, with range [left, infinity) to create a valid bounding box
bottom	Bottom (including) pixel position, with range [top, infinity) to create a valid bounding box

◆ PixelBoundingBoxT() [6/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT	(	const PixelPositionT< T > &	topLeft,
		const unsigned int	width,
		const unsigned int	height
	)

inline

Creates a bounding box by a given top left position and a width and height of the bounding box.

Parameters

topLeft	Top left position of the box
width	The width of the bounding box in pixel with range [1, infinity)
height	The height of the bounding box in pixel, with range [1, infinity)

◆ PixelBoundingBoxT() [7/7]

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::PixelBoundingBoxT	(	const PixelPositionT< T > &	point0,
		const PixelPositionT< T > &	point1
	)

inline

Creates a bounding box covering two points.

Parameters

point0	The first point that will be converted by the bounding box
point1	The second point that will be converted by the bounding box

Member Function Documentation

◆ bottom()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::bottom ( ) const

inline

Returns the bottom (including) position of this bounding box.

Returns: Bottom position

◆ bottomEnd()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::bottomEnd ( ) const

inline

Returns the bottom (excluding) pixel position of this bounding box.

Returns: First pixel below the bounding box

◆ bottomLeft()

template<typename T >

PixelPositionT< T > Ocean::CV::PixelBoundingBoxT< T >::bottomLeft ( ) const

inline

Returns the bottom left corner of this bounding box.

Returns: bottom left corner

◆ bottomRight()

template<typename T >

PixelPositionT< T > Ocean::CV::PixelBoundingBoxT< T >::bottomRight ( ) const

inline

Returns the bottom right corner of this bounding box.

Returns: Bottom right corner

◆ extended()

template<typename T >

PixelBoundingBoxT< T > Ocean::CV::PixelBoundingBoxT< T >::extended	(	const unsigned int	pixels,
		const T	minLeft,
		const T	minTop,
		const T	maxRight,
		const T	maxBottom
	)		const

inline

Returns a new bounding box by extending this bounding box with a given number of pixel in each direction.

Parameters

pixels	Number of pixels to be added to each bounding box boundary
minLeft	Minimal (including) left boundary, with minLeft <= left()
minTop	Minimal (including) top boundary, with minTop <= top()
maxRight	Minimal (including) right boundary, with maxRight >= right()
maxBottom	Minimal (including) bottom boundary, with maxBottom >= bottom()

Returns: Extended bounding box

◆ hasIntersection()

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::hasIntersection ( const PixelBoundingBoxT< T > & boundingBox ) const

inline

Returns whether a given bounding box has an intersection with this bounding box.

Parameters

boundingBox The bounding box to be checked, must be valid

Returns: True, if so

◆ height()

template<typename T >

unsigned int Ocean::CV::PixelBoundingBoxT< T >::height ( ) const

inline

Returns the height (the number of vertical including pixels) of this bounding box.

Returns: Bounding box height

◆ isInside() [1/2]

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::isInside ( const PixelBoundingBoxT< T > & boundingBox ) const

inline

Returns whether a given bounding box lies entirely inside this bounding box.

Parameters

boundingBox The bounding box to be checked, must be valid

Returns: True, if so

◆ isInside() [2/2]

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::isInside ( const PixelPositionT< T > & point ) const

inline

Returns whether a given point lies inside this bounding box.

Parameters

point The point to be checked, must be valid

Returns: True, if so

◆ isTouching()

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::isTouching	(	const PixelBoundingBoxT< T > &	boundingBox,
		const bool	useNeighborhood8
	)		const

inline

Returns whether a given bounding box is touching this bounding box.

Two bounding boxes are touching if both boxes are intersecting or if both boxes have a touching edge.
When two bounding boxes are touching at the corners, the 'useNeighborhood4' property defines whether both boxes count as touching or not.

Parameters

boundingBox	The bounding box to be checked, must be valid
useNeighborhood8	True, to use a 8-neighborhood during the check; False, to use an 4-neighborhood during the check

Returns: True, if so

◆ isValid()

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::isValid ( ) const

inline

Returns whether this bounding box covers a valid pixel area.

Returns: True, if so

◆ left()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::left ( ) const

inline

Returns the left (including) pixel position of this bounding box.

Returns: Left position

◆ operator bool()

template<typename T >

Ocean::CV::PixelBoundingBoxT< T >::operator bool ( ) const

inlineexplicit

Returns whether this bounding box covers a valid pixel area.

Returns: True, if so

◆ operator!=()

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::operator!= ( const PixelBoundingBoxT< T > & box ) const

inline

Returns whether two bounding boxes are not equal.

Parameters

box	Second bounding box

Returns: True, if so

◆ operator&&()

template<typename T >

PixelBoundingBoxT< T > Ocean::CV::PixelBoundingBoxT< T >::operator&& ( const PixelBoundingBoxT< T > & box ) const

inline

Returns the intersection of two bounding boxes.

Beware: The intersection between a valid and an invalid bounding box is an invalid bounding box.

Parameters

box	Second bounding box

Returns: New intersection bounding box

◆ operator()()

template<typename T >

size_t Ocean::CV::PixelBoundingBoxT< T >::operator() ( const PixelBoundingBoxT< T > & boundingBox ) const

inline

Hash function.

Parameters

boundingBox The bounding box for which the hash value will be determined

Returns: The resulting hash value

◆ operator*()

template<typename T >

PixelBoundingBoxT< T > Ocean::CV::PixelBoundingBoxT< T >::operator* ( const T factor ) const

inline

Multiplies this bounding box by a specified scalar (multiplies left, top, right, and bottom location by the scalar).

Parameters

factor The multiplication factor, with range (-infinity, infinity)

Returns: The new (bigger/multiplied) bounding box

◆ operator*=()

template<typename T >

PixelBoundingBoxT< T > & Ocean::CV::PixelBoundingBoxT< T >::operator*= ( const T factor )

inline

Multiplies this bounding box by a specified scalar (multiplies left, top, right, and bottom location by the scalar).

Parameters

factor The multiplication factor, with range (-infinity, infinity)

Returns: Reference to this modified bounding box

◆ operator+=()

template<typename T >

PixelBoundingBoxT< T > & Ocean::CV::PixelBoundingBoxT< T >::operator+= ( const PixelPositionT< T > & point )

inline

Adds a new point to the bounding box.

If the point lies inside the bounding box the box is unchanged, otherwise the box will be extended

Parameters

point The point extending the box

Returns: Reference to this box

◆ operator/()

template<typename T >

PixelBoundingBoxT< T > Ocean::CV::PixelBoundingBoxT< T >::operator/ ( const T factor ) const

inline

Divides this bounding box by a specified scalar (divides left, top, right, and bottom location by the scalar).

Parameters

factor The division factor, with range (-infinity, infinity) \ {0}

Returns: The new (smaller/divided) bounding box

◆ operator/=()

template<typename T >

PixelBoundingBoxT< T > & Ocean::CV::PixelBoundingBoxT< T >::operator/= ( const T factor )

inline

Divides this bounding box by a specified scalar (divides left, top, right, and bottom location by the scalar).

Parameters

factor The division factor, with range (-infinity, infinity) \ {0}

Returns: Reference to this modified bounding box

◆ operator=()

template<typename T >

PixelBoundingBoxT< T > & Ocean::CV::PixelBoundingBoxT< T >::operator= ( const PixelBoundingBoxT< T > & other )

inlinedefault

Assignment operator override to match copy constructor.

◆ operator==()

template<typename T >

bool Ocean::CV::PixelBoundingBoxT< T >::operator== ( const PixelBoundingBoxT< T > & box ) const

inline

Returns whether two bounding boxes are equal.

Parameters

box	Second bounding box

Returns: True, if so

◆ operator||()

template<typename T >

PixelBoundingBoxT< T > Ocean::CV::PixelBoundingBoxT< T >::operator|| ( const PixelBoundingBoxT< T > & box ) const

inline

Returns the union of two bounding boxes.

Parameters

box	Second bounding box

Returns: New union bounding box

◆ right()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::right ( ) const

inline

Returns the right (including) pixel position of this bounding box.

Returns: Right position

◆ rightEnd()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::rightEnd ( ) const

inline

Returns the right (excluding) pixel position of this bounding box.

Returns: First pixel to the right of the bounding box

◆ size()

template<typename T >

unsigned int Ocean::CV::PixelBoundingBoxT< T >::size ( ) const

inline

Returns the area (the number of including pixels) this bounding box covers.

If this bounding box is invalid, than zero is returned.

Returns: Number of pixels or zero.

◆ top()

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::top ( ) const

inline

Returns the top (including) pixel position of this bounding box.

Returns: Top position

◆ topLeft()

template<typename T >

PixelPositionT< T > Ocean::CV::PixelBoundingBoxT< T >::topLeft ( ) const

inline

Returns the top left corner of this bounding box.

Returns: Top left corner

◆ topRight()

template<typename T >

PixelPositionT< T > Ocean::CV::PixelBoundingBoxT< T >::topRight ( ) const

inline

Returns the top right corner of this bounding box.

Returns: Top right corner

◆ width()

template<typename T >

unsigned int Ocean::CV::PixelBoundingBoxT< T >::width ( ) const

inline

Returns the width (the number of horizontal including pixels) of this bounding box.

Returns: Bounding box width

Field Documentation

◆ bottom_

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::bottom_

private

Bottom (including) pixel position of this bounding box.

◆ left_

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::left_

private

Left (including) pixel position of this bounding box.

◆ right_

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::right_

private

Right (including) pixel position of this bounding box.

◆ top_

template<typename T >

T Ocean::CV::PixelBoundingBoxT< T >::top_

private

Top (including) pixel position of this bounding box.

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

PixelBoundingBox.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PixelBoundingBoxT() [1/7]

◆ PixelBoundingBoxT() [2/7]

◆ PixelBoundingBoxT() [3/7]

◆ PixelBoundingBoxT() [4/7]

◆ PixelBoundingBoxT() [5/7]

◆ PixelBoundingBoxT() [6/7]

◆ PixelBoundingBoxT() [7/7]

Member Function Documentation

◆ bottom()

◆ bottomEnd()

◆ bottomLeft()

◆ bottomRight()

◆ extended()

◆ hasIntersection()

◆ height()

◆ isInside() [1/2]

◆ isInside() [2/2]

◆ isTouching()

◆ isValid()

◆ left()

◆ operator bool()

◆ operator!=()

◆ operator&&()

◆ operator()()

◆ operator*()

◆ operator*=()

◆ operator+=()

◆ operator/()

◆ operator/=()

◆ operator=()

◆ operator==()

◆ operator||()

◆ right()

◆ rightEnd()

◆ size()

◆ top()

◆ topLeft()

◆ topRight()

◆ width()

Field Documentation

◆ bottom_

◆ left_

◆ right_

◆ top_