CVB.Net 14.0
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
imageimage from which to extract the sample
positionposition 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
ObjectDisposedExceptionIf 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
ObjectDisposedExceptionIf 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
ObjectDisposedExceptionIf the parent list has already been disposed.
ArgumentNullExceptionwhen trying to set a null as class name
ArgumentExceptionwhen trying to set an empty class name
InvalidOperationExceptionwhen trying to set a class name that already exists in the parent SampleImageList

◆ Samples

Samples in this class.

Exceptions
ObjectDisposedExceptionIf the parent list has already been disposed.