LabelInfoCollection< TLabelInformation > Class Template Reference

Information collection for class labels. More...

#include <cvb/sample_database/sample_list.hpp>

Public Types
using	LabelType = typename TLabelInformation::LabelType
	Type of the labels.

Public Member Functions
int	Count () const
	Retrieves the number of elements in the collection.
std::unique_ptr< TLabelInformation >	ReadInfo (int index) const
	Retrieves the indexed item.
std::vector< std::shared_ptr< TLabelInformation > >	ReadInfos () const
	Retrieves all the items stored in the collection.
void	RemoveAt (int index)
	Remove a class by index.
void	Remove (const LabelType &label)
	Remove a class and all the data objects associated with it based on its name.
void	Clear ()
	Remove all labels (and their associated data) from the sample list.
void	MergeClasses (int fromIndex, int toIndex)
	Merge two classes into one class.
void	MergeClasses (const LabelType &fromLabel, const LabelType &toLabel)
	Merge two classes into one class.

Detailed Description

template<class TLabelInformation>
class Cvb::SampleDatabase::LabelInfoCollection< TLabelInformation >

Information collection for class labels.

Member Function Documentation

Clear()

template<class TLabelInformation>

void Clear ( )

inline

Remove all labels (and their associated data) from the sample list.

Exceptions

Any	exception derived from std::exception including CvbException.

Note that this invalidates all info objects that have been taken from this collection!

Count()

template<class TLabelInformation>

int Count ( ) const

inline

Retrieves the number of elements in the collection.

Returns

Number of elements in the collection.

Exceptions

Any	exception derived from std::exception including CvbException.

MergeClasses() [1/2]

template<class TLabelInformation>

void MergeClasses ( const LabelType & fromLabel, const LabelType & toLabel )

inline

Merge two classes into one class.

Parameters

[in]	fromLabel	Class to merge to the other classes.
[in]	toLabel	Class to merge the samples to.

Exceptions

Any	exception derived from std::exception including CvbException.

The class label will be taken from the 2nd class index. Note that this operation will invalidate all indices higher than fromLabel.

MergeClasses() [2/2]

template<class TLabelInformation>

void MergeClasses ( int fromIndex, int toIndex )

inline

Merge two classes into one class.

Parameters

[in]	fromIndex	Class to merge to the other classes.
[in]	toIndex	Class to merge the samples to.

Exceptions

Any	exception derived from std::exception including CvbException.

The class label will be taken from the 2nd class index. Note that this operation will invalidate all indices higher than fromIndex.

ReadInfo()

template<class TLabelInformation>

std::unique_ptr< TLabelInformation > ReadInfo ( int index ) const

inline

Retrieves the indexed item.

Parameters

[in]

index

Index of the collection to be accessed.

Returns

Label information.

Exceptions

Any	exception derived from std::exception including CvbException.

ReadInfos()

template<class TLabelInformation>

std::vector< std::shared_ptr< TLabelInformation > > ReadInfos ( ) const

inline

Retrieves all the items stored in the collection.

Returns

The collection items.

Exceptions

Any	exception derived from std::exception including CvbException.

Remove()

template<class TLabelInformation>

void Remove ( const LabelType & label )

inline

Remove a class and all the data objects associated with it based on its name.

Parameters

[in]

label

Name of the new class to be removed.

Exceptions

Any	exception derived from std::exception including CvbException.

RemoveAt()

template<class TLabelInformation>

void RemoveAt ( int index )

inline

Remove a class by index.

Parameters

[in]

index

Index of the class to be removed.

Exceptions

Any	exception derived from std::exception including CvbException.