ImageInfoCollection Class Reference

Class that maintains the collection of Training Images inside a Minos Training Set. More...

#include <cvb/minos/training_set.hpp>

Public Member Functions
int	Count () const
	Retrieves the number of elements in the collection. More...
std::unique_ptr< ImageInfo >	ReadInfo (int index) const
	Retrieves the indexed image information block. More...
std::vector< std::unique_ptr< ImageInfo > >	ReadInfos () const
	Retrieves all the items stored in the collection. More...
int	IndexOf (const ImageInfo &obj) const
	Determine the index of an image information object inside this collection. More...
void	Add (const ImagePlane &plane)
	Add a new training set image to the parent training set. More...
bool	Remove (const ImageInfo &image)
	Remove a training set image along with its instances from the training set. More...
bool	RemoveAt (int index)
	Remove a training set image along with its instances from the training set. More...

Detailed Description

Class that maintains the collection of Training Images inside a Minos Training Set.

Member Function Documentation

Add()

void Add ( const ImagePlane &  plane )

inline

Add a new training set image to the parent training set.

Parameters

[in]

plane

Plane of an image to be added.

Exceptions

Any	exception derived from std::exception including CvbException.

Minos only supports gray value images. When adding a color or multi planar Image you will need to choose which of the planes of the image to add.

Count()

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.

IndexOf()

int IndexOf ( const ImageInfo &  obj ) const

inline

Determine the index of an image information object inside this collection.

Parameters

[in]

obj

Object for which to determine the index.

Returns

Index through which the object can be accessed within this collection if it is part of this collection, -1 otherwise.

Exceptions

Any	exception derived from std::exception including CvbException.

Note that the returned index may be invalidated by Remove calls.

ReadInfo()

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

inline

Retrieves the indexed image information block.

Parameters

[in]

index

Index of the collection to be accessed.

Returns

Image information.

Exceptions

Any	exception derived from std::exception including CvbException.

ReadInfos()

std::vector< std::unique_ptr< ImageInfo > > 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()

bool Remove ( const ImageInfo &  image )

inline

Remove a training set image along with its instances from the training set.

Parameters

[in]

image

Training set image to be removed

Returns

True if the image has been removed successfully, false otherwise.

Exceptions

Any	exception derived from std::exception including CvbException.

Calling this method will potentially invalidate any references to training set images or instances you are currently holding - so make sure you renew those where necessary!

RemoveAt()

bool RemoveAt ( int  index )

inline

Remove a training set image along with its instances from the training set.

Parameters

[in]

index

Index of the training set image to be removed.

Returns

True if the image has been removed successfully, false otherwise.

Exceptions

Any	exception derived from std::exception including CvbException.

Calling this method will potentially invalidate any references to training set images or instances you are currently holding - so make sure you renew those where necessary!