SampleRegressionImageList.ImageRegressionLabelInfo Class Reference

Regression Label Information. More...

Inherits SampleList.ILabelInfo< TLabel >.

Public Member Functions
override string	ToString ()
	Return a pretty-print version of the value... More...
void	Add (Image srcImage, Point2D extractionLocation, SampleExtractionMode mode=SampleExtractionMode.TopLeftCorner)
	Add a new sample to an existing class. More...
void	Relabel (float[] label)
	Modify the label of a sample set, but not to one that already exists in the SampleList. To Merge labels in the SampleList use the merge method(s) of the sample list. More...
Public Member Functions inherited from SampleList.ILabelInfo< TLabel >
void	Relabel (TLabel newLabel)
	Change the label of a class. More...

Properties
ImageCollection	Samples [get]
	Samples under this label. More...
int	Index [get]
	Get the index of this label. Note that this index may change when samples are removed from the image list - therefore you should check this index often. Generally it is more recommendable to work label based, not index based. More...
float[]	Label [get]
	Label under which this class is stored. You may change this label, but not to one that already exists in the SampleList. To Merge labels in the SampleList use the merge method(s) of the sample list. More...
Type	LabelType [get]
	Type of the labels.
SampleList	ParentList [get]
	Sample List object from which this information was taken.
Properties inherited from SampleList.ILabelInfo< TLabel >
int	Index [get]
	Numeric index of the label.
Type	LabelType [get]
	Type of the label (either typeof(string) or typeof(float[])).
Properties inherited from SampleList.ISampleListChild
SampleList	ParentList [get]
	Object through which the native handle may be accessed.

Detailed Description

Regression Label Information.

Member Function Documentation

Add()

void Add	(	Image	srcImage,
		Point2D	extractionLocation,
		SampleExtractionMode	mode = SampleExtractionMode.TopLeftCorner
	)

Add a new sample to an existing class.

Parameters

srcImage	Image from which to extract the first sample for the new class.
extractionLocation	Location at which to extract the sample for the class. Note that what the extraction location actually refers dependent on the value of the mode parameter.
mode	Interpretation hint for the extractionLocation parameter.

Exceptions

ObjectDisposedException

If the image list has already been disposed.

Relabel()

void Relabel

(

float[]

label

)

Modify the label of a sample set, but not to one that already exists in the SampleList. To Merge labels in the SampleList use the merge method(s) of the sample list.

Parameters

label

Exceptions

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

ToString()

override string ToString

(

)

Return a pretty-print version of the value...

Returns

String representation of the label.

Property Documentation

Index

int Index

get

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

Exceptions

ObjectDisposedException

If the parent list has already been disposed.

Implements SampleList.ILabelInfo< TLabel >.

Label

float [] Label

get

Label under which this class is stored. You may change this label, but not to one that already exists in the SampleList. To Merge labels in the SampleList use the merge method(s) of the sample list.

Exceptions

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

Samples

ImageCollection Samples

get

Samples under this label.

Exceptions

ObjectDisposedException

If the parent list has already been disposed.