SampleList Class Reference

Base class for sample lists. More...

Inherits object.

Inherited by SampleImageList.

Public Member Functions
None	save (self, str file_name)
	Save the sample list to a file. More...

Properties
	average_sample_count = property
	float: Average number samples in per class of the sample list. More...
	comment = property
	str: The comment text. More...
	file_name = property
	str: Name of the file from which this image list was loaded (empty string if this image list was neither loaded nor saved since its construction). More...
	max_sample_count = property
	int: Number samples in the largest class of the sample list. More...
	min_sample_count = property
	int: Number samples in the smallest class of the sample list. More...
	num_classes = property
	int: Number of distinguishable classes in the sample list. More...
	num_samples = property
	int: Total number of samples in the sample list. More...

Detailed Description

Base class for sample lists.

Member Function Documentation

save()

None save	(		self,
		str	file_name
	)

Save the sample list to a file.

Parameters

file_name : str Path to save to.

Property Documentation

average_sample_count

average_sample_count = property

static

float: Average number samples in per class of the sample list.

comment

comment = property

static

str: The comment text.

file_name

file_name = property

static

str: Name of the file from which this image list was loaded (empty string if this image list was neither loaded nor saved since its construction).

max_sample_count

max_sample_count = property

static

int: Number samples in the largest class of the sample list.

min_sample_count

min_sample_count = property

static

int: Number samples in the smallest class of the sample list.

num_classes

num_classes = property

static

int: Number of distinguishable classes in the sample list.

num_samples

num_samples = property

static

int: Total number of samples in the sample list.