SampleImageList.SampleInformationCollection Class Reference

Collection of samples inside a class of an SampleImageList. More...

Public Member Functions
void	Add (Image image, Point2D position)
	Add a new sample to the samples collection.
void	Remove (int index)
	Remove a sample image.
void	MoveToClass (int index, string name)
	Move a sample to a different (potentially new) class.
void	Clear ()
	Clear all the samples in this class.

Properties
int	Count [get]
	Get the number of samples for this collection.
Image	this[int index] [get]
	Access one of the sample images.

Detailed Description

Collection of samples inside a class of an SampleImageList.

Member Function Documentation

Add()

void Add	(	Image	image,
		Point2D	position )

Add a new sample to the samples collection.

Parameters

image	image from which to extract the sample
position	position at which to extract it

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

MoveToClass()

void MoveToClass	(	int	index,
		string	name )

Move a sample to a different (potentially new) class.

Parameters

index	index of the sample to be moved
name	name of the class into which to move the image; this class must already exist in the SampleImageList!

Exceptions

ObjectDisposedException	If the parent list has already been disposed.
ArgumentNullException	If name is null
ArgumentException	If name is an empty string
InvalidOperationException	If the name d class does not yet exist in the SampleImageList
ArgumentOutOfRangeException	If the index parameter is invalid.

Remove()

void Remove

(

int

index

)

Remove a sample image.

Parameters

index

index of the sample image to be removed

Exceptions

ArgumentOutOfRangeException	If the index is invalid
ObjectDisposedException	If the parent list has already been disposed.

Property Documentation

Count

int Count

get

Get the number of samples for this collection.

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

this[int index]

Image this[int index]

get

Access one of the sample images.

Parameters

index

index to be accessed

Returns

image

Exceptions

ObjectDisposedException	If the parent list has already been disposed.
ArgumentOutOfRangeException	If the index is invalid