InstanceInfoCollectionGeneric Class Reference

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

#include <cvb/minos/training_set.hpp>

Inherited by ImageInstanceInfoCollection, InstanceInfoCollection, and ModelInstanceInfoCollection.

Public Member Functions
int	Count () const
	Retrieves the number of elements in the collection. More...
InstanceInfo	ReadInfo (int index) const
	Retrieves the indexed instance information block. More...
std::vector< InstanceInfo >	ReadInfos () const
	Retrieves all the items stored in the collection. More...
int	IndexOf (const InstanceInfo &obj) const
	Determine the index of an image information object inside this collection. More...
bool	Remove (const InstanceInfo &instance)
	Remove an instance from the training set. More...
bool	RemoveAt (int index)
	Remove an instance from the training set. More...

Detailed Description

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

Member Function Documentation

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 InstanceInfo &  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()

InstanceInfo ReadInfo ( int  index ) const

inline

Retrieves the indexed instance information block.

Parameters

[in]

index

Index of the collection to be accessed.

Returns

Instance information.

Exceptions

Any	exception derived from std::exception including CvbException.

ReadInfos()

std::vector< InstanceInfo > 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 InstanceInfo &  instance )

inline

Remove an instance from the training set.

Parameters

[in]

instance

Instance to be removed from the training set.

Returns

True if the instance 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 an instance from the training set.

Parameters

[in]

index

Index of the training set instance to be removed.

Returns

True if the instance 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!