eVision.EasyDeepLearning.EDatasetSplit Class Reference

The eVision.EasyDeepLearning.EDatasetSplit maps the image indexes of a eVision.EasyDeepLearning.EDataset to a dataset split type (eVision.EasyDeepLearning.EDatasetType). More...

Public Member Functions
None	__init__ (self)
	Creates a eVision.EasyDeepLearning.EDatasetSplit.
None	__init__ (self, list[eVision._eVision.EasyDeepLearning.EDatasetType] mapping)
	Creates a eVision.EasyDeepLearning.EDatasetSplit.
None	__init__ (self, eVision.EasyDeepLearning.EDatasetSplit other)
	Creates a eVision.EasyDeepLearning.EDatasetSplit.
None	CopyTo (self, eVision.EasyDeepLearning.EDatasetSplit other)
	Copy the dataset split to the other instance.
None	Load (self, str path)
	Load the eVision.EasyDeepLearning.EDatasetSplit configuration.
None	Load (self, eVision.ESerializer|None serializer)
	Load the eVision.EasyDeepLearning.EDatasetSplit configuration.
None	Save (self, str path)
	Save the eVision.EasyDeepLearning.EDatasetSplit configuration.
None	Save (self, eVision.ESerializer|None serializer)
	Save the eVision.EasyDeepLearning.EDatasetSplit configuration.
list[int]	GetSplit (self, eVision.EasyDeepLearning.EDatasetType type)
	Image indexes corresponding to the given type.
int	GetNumImages (self)
	Number of image indexes associated in the object.
int	GetNumImages (self, eVision.EasyDeepLearning.EDatasetType type)
	Number of image indexes associated with the given dataset type.
eVision.EasyDeepLearning.EDatasetType	GetImageType (self, int imageIndex)
	Dataset type for the given image index.
None	SetImageType (self, int imageIndex, eVision.EasyDeepLearning.EDatasetType type)
	Dataset type for the given image index.
bool	GetImageTypeLocked (self, int imageIndex)
	Whether the image type is locked for the given image.
None	SetImageTypeLocked (self, int imageIndex, bool isLocked)
	Whether the image type is locked for the given image.
None	SetTypeLocked (self, int type, bool isLocked)
	Locks or unlocks all the images whose dataset type matches the given type.
bool	HasLockedImages (self)
	Whether the split contains images for which the dataset type is locked.
int	NumLockedImages (self)
	Number of images for which the dataset type is locked.
list[eVision._eVision.EasyDeepLearning.EDatasetType]	DatasetMapping (self)
	Mapping between image indexes and the corresponding dataset split type.

Detailed Description

The eVision.EasyDeepLearning.EDatasetSplit maps the image indexes of a eVision.EasyDeepLearning.EDataset to a dataset split type (eVision.EasyDeepLearning.EDatasetType).

The image indexes mapped in the object are consecutive and between 0 and eVision.EasyDeepLearning.EDatasetSplit.GetNumImages - 1.

Remarks:

License(s): EasyClassify or EasySegment or EasyLocate

Constructor & Destructor Documentation

__init__() [1/3]

None eVision.EasyDeepLearning.EDatasetSplit.__init__

(

self

)

Creates a eVision.EasyDeepLearning.EDatasetSplit.

__init__() [2/3]

None eVision.EasyDeepLearning.EDatasetSplit.__init__	(		self,
		list[eVision._eVision.EasyDeepLearning.EDatasetType]	mapping )

Creates a eVision.EasyDeepLearning.EDatasetSplit.

Parameters

mapping

Vector where the value at index i is the dataset type for image i.

__init__() [3/3]

None eVision.EasyDeepLearning.EDatasetSplit.__init__	(		self,
		eVision.EasyDeepLearning.EDatasetSplit	other )

Creates a eVision.EasyDeepLearning.EDatasetSplit.

Parameters

other

Other instance of eVision.EasyDeepLearning.EDatasetSplit.

Member Function Documentation

CopyTo()

None eVision.EasyDeepLearning.EDatasetSplit.CopyTo	(		self,
		eVision.EasyDeepLearning.EDatasetSplit	other )

Copy the dataset split to the other instance.

Parameters

other

Other instance of eVision.EasyDeepLearning.EDatasetSplit.

DatasetMapping()

list[eVision._eVision.EasyDeepLearning.EDatasetType] eVision.EasyDeepLearning.EDatasetSplit.DatasetMapping

(

self

)

Mapping between image indexes and the corresponding dataset split type.

The value at index i of the vector is the dataset split type for the image index i.

GetImageType()

eVision.EasyDeepLearning.EDatasetType eVision.EasyDeepLearning.EDatasetSplit.GetImageType	(		self,
		int	imageIndex )

Dataset type for the given image index.

Parameters

imageIndex

Image index.

GetImageTypeLocked()

bool eVision.EasyDeepLearning.EDatasetSplit.GetImageTypeLocked	(		self,
		int	imageIndex )

Whether the image type is locked for the given image.

This property is mainly used to lock training and validation images after the split was used in a training.

Parameters

imageIndex

Image index.

GetNumImages() [1/2]

int eVision.EasyDeepLearning.EDatasetSplit.GetNumImages

(

self

)

Number of image indexes associated in the object.

GetNumImages() [2/2]

int eVision.EasyDeepLearning.EDatasetSplit.GetNumImages	(		self,
		eVision.EasyDeepLearning.EDatasetType	type )

Number of image indexes associated with the given dataset type.

Parameters

type	Dataset split type

GetSplit()

list[int] eVision.EasyDeepLearning.EDatasetSplit.GetSplit	(		self,
		eVision.EasyDeepLearning.EDatasetType	type )

Image indexes corresponding to the given type.

Parameters

type	the type of split to retrieve

HasLockedImages()

bool eVision.EasyDeepLearning.EDatasetSplit.HasLockedImages

(

self

)

Whether the split contains images for which the dataset type is locked.

Load() [1/2]

None eVision.EasyDeepLearning.EDatasetSplit.Load	(		self,
		eVision.ESerializer | None	serializer )

Load the eVision.EasyDeepLearning.EDatasetSplit configuration.

The given eVision.ESerializer must have been created for reading.

Parameters

serializer

The serializer.

Load() [2/2]

None eVision.EasyDeepLearning.EDatasetSplit.Load	(		self,
		str	path )

Load the eVision.EasyDeepLearning.EDatasetSplit configuration.

The given eVision.ESerializer must have been created for reading.

Parameters

path	The file path.

NumLockedImages()

int eVision.EasyDeepLearning.EDatasetSplit.NumLockedImages

(

self

)

Number of images for which the dataset type is locked.

Save() [1/2]

None eVision.EasyDeepLearning.EDatasetSplit.Save	(		self,
		eVision.ESerializer | None	serializer )

Save the eVision.EasyDeepLearning.EDatasetSplit configuration.

The given eVision.ESerializer must have been created for writing.

Parameters

serializer

The serializer.

Save() [2/2]

None eVision.EasyDeepLearning.EDatasetSplit.Save	(		self,
		str	path )

Save the eVision.EasyDeepLearning.EDatasetSplit configuration.

The given eVision.ESerializer must have been created for writing.

Parameters

path	The file path.

SetImageType()

None eVision.EasyDeepLearning.EDatasetSplit.SetImageType	(		self,
		int	imageIndex,
		eVision.EasyDeepLearning.EDatasetType	type )

Dataset type for the given image index.

Parameters

imageIndex	Image index.
type	Dataset split type.

SetImageTypeLocked()

None eVision.EasyDeepLearning.EDatasetSplit.SetImageTypeLocked	(		self,
		int	imageIndex,
		bool	isLocked )

Whether the image type is locked for the given image.

This property is mainly used to lock training and validation images after the split was used in a training.

Parameters

imageIndex	Image index.
isLocked	Whether to lock the image

SetTypeLocked()

None eVision.EasyDeepLearning.EDatasetSplit.SetTypeLocked	(		self,
		int	type,
		bool	isLocked )

Locks or unlocks all the images whose dataset type matches the given type.

Note that the given type can be a combination of several dataset type (using the | operator).

Parameters

type	Dataset type to lock.
isLocked	Whether to lock the images