SampleList.LabelInfoCollection< TLabelInformation, TData > Class Template Reference

Information collection for class labels. More...

Inherits InfoCollection< SampleList, TLabelInformation >, SampleList.ILabelInfoCollection< TLabelInfo, TData >, and SampleList.ISampleListChild.

Inherited by SampleRegressionImageList.ImageRegressionInfoCollection.

Public Member Functions
void	Clear ()
	Remove all labels (and their associated data) from the Sample List. More...
void	Remove (int Index)
	Remove a class by Index. More...
void	MergeClasses (int fromIndex, int toIndex)
	Merge two classes into one class. The class label will be taken from the 2nd class index. Note that this operation will invalidate all indices higher than fromIndex . More...
Public Member Functions inherited from InfoCollection< SampleList, TLabelInformation >
TInfo[]	ToArray ()
	Converts this collection into an array. More...

Protected Member Functions
override int	GetCount ()
	Parent class calls this method to determine the number of objects in the collection. More...
Protected Member Functions inherited from InfoCollection< SampleList, TLabelInformation >
	InfoCollection (TParent parent)
	Constructor. More...
abstract int	GetCount ()
	Function with which the collection queries the number of elements More...
abstract TInfo	GetInfo (int index)
	Function with which the collection retrieves the information object with the given index. More...

Properties
TLabelInformation	this[int index] [get]
	Index-based item access. More...
SampleList	ParentList [get]
	SampleList object to which this class file object is bound
Properties inherited from InfoCollection< SampleList, TLabelInformation >
int	Count [get]
	Number of elements in the collection. More...
Properties inherited from SampleList.ISampleListChild
SampleList	ParentList [get]
	Object through which the native handle may be accessed.

Additional Inherited Members
Protected Attributes inherited from InfoCollection< SampleList, TLabelInformation >
readonly TParent	Parent
	Parent image reference helps keeping track of the lifetime and provides the information basis for index access

Detailed Description

Information collection for class labels.

Template Parameters

TData	Type of data entries in the list.
TLabelInformation	Type of label entries in the list.

Type Constraints

TLabelInformation

:

ILabelInfo

Member Function Documentation

Clear()

void Clear

(

)

Remove all labels (and their associated data) from the Sample List.

Note that this invalidates all LabelInfo objects and SampleInfo objects that have been taken from this collection!

Exceptions

ObjectDisposedException

If the image list has already been disposed.

GetCount()

override int GetCount ( )

protectedvirtual

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 SampleImageList has already been disposed

Implements InfoCollection< SampleList, TLabelInformation >.

MergeClasses()

void MergeClasses	(	int	fromIndex,
		int	toIndex
	)

Merge two classes into one class. The class label will be taken from the 2nd class index. Note that this operation will invalidate all indices higher than fromIndex .

Parameters

fromIndex	Class to merge to the other classes.
toIndex	Class to merge the samples to.

Remove()

void Remove

(

int

Index

)

Remove a class by Index.

Parameters

Index

index of the class to be removed.

Exceptions

ObjectDisposedException

If the image list has already been disposed.

Property Documentation

this[int index]

TLabelInformation this[int index]

get

Index-based item access.

Parameters

index

index to be accessed

Returns

indexed class object

Exceptions

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