Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation Class Reference

This class implements the management of clusters. More...

#include <Clustering.h>

Public Member Functions
	Segmentation ()=default
	Creates a new segmentation object.
	Segmentation (const Clusters &clusters)
	Creates a new segmentation object.
	Segmentation (Segmentation &&segmentation) noexcept
	Move constructor.
const Clusters &	clusters () const
	Returns the clusters defined by this segmentation.
float	averageClusterSize () const
	Returns the average cluster size.
size_t	maximalClusterSize () const
	Returns the maximal cluster size of this segmentation.
Segmentation &	operator= (Segmentation &&right) noexcept
	Move operator.

Static Public Member Functions
static bool	compareMaximalClusterSize (const Segmentation &first, const Segmentation &second)
	Compares two segmentation regarding to the maximal cluster size.

Private Attributes
Clusters	clusters_
	Clusters of this segmentation object.
float	averageClusterSize_ = -1.0f
	Average cluster size of this segmentation.
size_t	maximalClusterSize_ = 0
	Maximal cluster size of this segmentation.

Detailed Description

template<unsigned int tChannels>
class Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation

This class implements the management of clusters.

Constructor & Destructor Documentation

Segmentation() [1/3]

template<unsigned int tChannels>

Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::Segmentation ( )

default

Creates a new segmentation object.

Segmentation() [2/3]

template<unsigned int tChannels>

Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::Segmentation ( const Clusters &  clusters )

explicit

Creates a new segmentation object.

Parameters

clusters

The clusters defining the segmentation

Segmentation() [3/3]

template<unsigned int tChannels>

Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::Segmentation ( Segmentation &&  segmentation )

inlinenoexcept

Move constructor.

Parameters

segmentation

The segmentation to be moved

Member Function Documentation

averageClusterSize()

template<unsigned int tChannels>

float Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::averageClusterSize ( ) const

inline

Returns the average cluster size.

Returns

Average cluster size

clusters()

template<unsigned int tChannels>

const Clustering< tChannels >::Clusters & Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::clusters ( ) const

inline

Returns the clusters defined by this segmentation.

Returns

Segmentation clusters

compareMaximalClusterSize()

template<unsigned int tChannels>

bool Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::compareMaximalClusterSize ( const Segmentation &  first, const Segmentation &  second  )

inlinestatic

Compares two segmentation regarding to the maximal cluster size.

Parameters

first	The first segmentation object
second	the second segmentation object

maximalClusterSize()

template<unsigned int tChannels>

size_t Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::maximalClusterSize ( ) const

inline

Returns the maximal cluster size of this segmentation.

Returns

Maximal cluster size

operator=()

template<unsigned int tChannels>

Clustering< tChannels >::Segmentation & Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::operator= ( Segmentation &&  right )

inlinenoexcept

Move operator.

Parameters

right

The right segmentation to assign

Returns

Reference to this segmentation

Field Documentation

averageClusterSize_

template<unsigned int tChannels>

float Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::averageClusterSize_ = -1.0f

private

Average cluster size of this segmentation.

clusters_

template<unsigned int tChannels>

Clusters Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::clusters_

private

Clusters of this segmentation object.

maximalClusterSize_

template<unsigned int tChannels>

size_t Ocean::CV::Segmentation::Clustering< tChannels >::Segmentation::maximalClusterSize_ = 0

private

Maximal cluster size of this segmentation.

---

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

• Clustering.h