SampleImageList.ClassInformation Struct Reference

Base class for providing SIL class informations More...

Public Member Functions
void	AddSample (Stemmer.Cvb.Image image, Point2D position)
	Add a new sample to this class. More...

Properties
SampleInformationCollection	Samples [get]
	Samples in this class. More...
int	Index [get]
	Get the index of this class. Note that this index may change when classes are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work Name based, not index based. More...
string	Name [get, set]
	Name by which this class is known. You may change this Name, but not to one that already exists in the SampleImageList. To Merge classes in the SampleImageList use the SampleImageList.MergeClassesmethod of the SampleImageList class. More...
bool	IsExcludedClass [get]
	Check if this is the excluded class or make it the excluded class More...

Detailed Description

Base class for providing SIL class informations

Member Function Documentation

AddSample()

void AddSample	(	Stemmer.Cvb.Image	image,
		Point2D	position
	)

Add a new sample to this class.

Invokes the method ImageList.AddSample()

Parameters

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

Property Documentation

Index

int Index

get

Get the index of this class. Note that this index may change when classes are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work Name based, not index based.

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

IsExcludedClass

bool IsExcludedClass

get

Check if this is the excluded class or make it the excluded class

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

Name

string Name

getset

Name by which this class is known. You may change this Name, but not to one that already exists in the SampleImageList. To Merge classes in the SampleImageList use the SampleImageList.MergeClassesmethod of the SampleImageList class.

Exceptions

ObjectDisposedException	If the parent list has already been disposed.
ArgumentNullException	when trying to set a null as class name
ArgumentException	when trying to set an empty class name
InvalidOperationException	when trying to set a class name that already exists in the parent SampleImageList

Samples

SampleInformationCollection Samples

get

Samples in this class.

Exceptions

ObjectDisposedException

If the parent list has already been disposed.