CVB.Net 14.0
TrainingSet.ImageInfoCollection Class Reference

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

Inherits TrainingSet.TrainingSetObjectInfoCollection< TrainingSet, ImageInfo >.

Public Member Functions

void Add (Image img)
 Add a new training set image to the parent training set. More...
 
void Add (ImagePlane plane)
 Add a new training set image to the parent training set. More...
 
bool Remove (ImageInfo image)
 Remove a training set image along with its instances from the training set. More...
 
void RemoveAt (int index)
 Remove a training set image along with its instances from the training set. More...
 
- Public Member Functions inherited from TrainingSet.TrainingSetObjectInfoCollection< TrainingSet, ImageInfo >
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 ImageInfo GetInfo (int index)
 Parent class calls this method to extract one info object by index. More...
 

Properties

ImageInfo 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

◆ Add() [1/2]

void Add ( Image  img)

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

This variant of the function will always simply add plane 0 of the image to the training set, regardless of the plane count.

Parameters
imgimage to be added
Exceptions
ObjectDisposedExceptionIf the TrainingSet or the image has already been disposed
ArgumentNullExceptionIf img is null
OutOfMemoryExceptionIf the insertion operation failed

◆ Add() [2/2]

void Add ( ImagePlane  plane)

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

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.

Parameters
planeplane of an image to be added
Exceptions
ObjectDisposedExceptionIf the TrainingSet or the image has already been disposed
ArgumentNullExceptionIf the parent of plane is null
OutOfMemoryExceptionIf the insertion operation failed

◆ 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
ObjectDisposedExceptionIf the TrainingSet has already been disposed

◆ GetInfo()

override ImageInfo GetInfo ( int  index)
protected

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

Parameters
indexindex at which to extract
Returns
extracted object
Exceptions
ObjectDisposedExceptionIf the TrainingSet has already been disposed
ArgumentOutOfRangeExceptionIf the index is invalid

◆ Remove()

bool Remove ( ImageInfo  image)

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

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!

Parameters
imagetraining set image to be removed
Returns
true if the image has been removed successfully, false otherwise
Exceptions
ObjectDisposedExceptionIf the TrainingSet has already been disposed
ArgumentNullExceptionIf image is null

◆ RemoveAt()

void RemoveAt ( int  index)

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

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!

Parameters
indexindex of the training set image to be removed
Exceptions
ObjectDisposedExceptionIf the TrainingSet has already been disposed
ArgumentOutOfRangeExceptionIf index exceeds the range [0...Count]

Property Documentation

◆ this[int index]

ImageInfo this[int index]
get

Index-based item access.

Parameters
indexindex to be accessed
Returns
indexed class object
Exceptions
ObjectDisposedExceptionIf the TrainingSet has already been disposed
ArgumentOutOfRangeExceptionIf the index is invalid