TrainingSet.InstanceInfoCollection Class Reference

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

Inherits TrainingSet.TrainingSetObjectInfoCollection< TrainingSet, InstanceInfo >.

Inherited by TrainingSet.ImageInstanceInfoCollection, and TrainingSet.ModelInstanceInfoCollection.

Public Member Functions
bool	Remove (InstanceInfo instance)
	Remove an instance from the training set. More...
void	Remove (int index)
	Remove an instance from the training set. More...
Public Member Functions inherited from TrainingSet.TrainingSetObjectInfoCollection< TrainingSet, InstanceInfo >
int	IndexOf (TInfo obj)
	Determine the index of an image information object inside this collection. More...

Protected Member Functions
override int	GetCount ()
	Parent class calls this method to determine the number of objects in the collection. More...
override InstanceInfo	GetInfo (int index)
	Parent class calls this method to extract one info object by index. More...

Protected Attributes
readonly IntPtr	collectionParent_
	The instance collection needs the collection parent handle in addition to the MTS handle as the instance collection appears twice: once inside the model, and once inside the image.

Properties
InstanceInfo	this[int index] [get]
	Index-based item access. More...

Detailed Description

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

Member Function Documentation

GetCount()

override int GetCount ( )

protected

Parent class calls this method to determine the number of objects in the collection.

Returns

number of objects in the collection

Exceptions

ObjectDisposedException

If the TrainingSet has already been disposed

GetInfo()

override InstanceInfo GetInfo ( int  index )

protected

Parent class calls this method to extract one info object by index.

Parameters

index

index at which to extract

Returns

extracted object

Exceptions

ObjectDisposedException	If the TrainingSet has already been disposed
ArgumentOutOfRangeException	If the index is invalid

Remove() [1/2]

bool Remove

(

InstanceInfo

instance

)

Remove an instance from the training set.

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

Parameters

instance

instance to be removed from the training set

Returns

true if the instance has been removed successfully, false otherwise

Exceptions

ObjectDisposedException	If the TrainingSet has already been disposed
ArgumentNullException	If instance is null

Remove() [2/2]

void Remove

(

int

index

)

Remove an instance from the training set.

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

Parameters

index

index of the training set instance to be removed

Exceptions

ObjectDisposedException	If the TrainingSet has already been disposed
ArgumentOutOfRangeException	If index exceeds the range [0...Count]

Property Documentation

this[int index]

InstanceInfo this[int index]

get

Index-based item access.

Parameters

index

index to be accessed

Returns

indexed class object

Exceptions

ObjectDisposedException	If the TrainingSet has already been disposed
ArgumentOutOfRangeException	If the index is invalid