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

Inheritance diagram for eVision.EasyDeepLearning.EDatasetSplit:

Collaboration diagram for eVision.EasyDeepLearning.EDatasetSplit:

Public Member Functions
	EDatasetSplit ()
	Creates a EDatasetSplit.
	EDatasetSplit (eVision.EasyDeepLearning.EDatasetType[] mapping)
	Creates a EDatasetSplit.
	EDatasetSplit (eVision.EasyDeepLearning.EDatasetSplit other)
	Creates a EDatasetSplit.
void	CopyTo (eVision.EasyDeepLearning.EDatasetSplit other)
	Copy the dataset split to the other instance.
void	Load (string path)
	Load the EDatasetSplit configuration. The given ESerializer must have been created for reading.
void	Load (eVision.ESerializer serializer)
	Load the EDatasetSplit configuration. The given ESerializer must have been created for reading.
void	Save (string path)
	Save the EDatasetSplit configuration. The given ESerializer must have been created for writing.
void	Save (eVision.ESerializer serializer)
	Save the EDatasetSplit configuration. The given ESerializer must have been created for writing.
int[]	GetSplit (eVision.EasyDeepLearning.EDatasetType type)
	Image indexes corresponding to the given type.
int	GetNumImages ()
	Number of image indexes associated in the object.
int	GetNumImages (eVision.EasyDeepLearning.EDatasetType type)
	Number of image indexes associated with the given dataset type.
eVision.EasyDeepLearning.EDatasetType	GetImageType (int imageIndex)
	Dataset type for the given image index.
void	SetImageType (int imageIndex, eVision.EasyDeepLearning.EDatasetType type)
	Dataset type for the given image index.
bool	GetImageTypeLocked (int imageIndex)
	Whether the image type is locked for the given image.
void	SetImageTypeLocked (int imageIndex, bool isLocked)
	Whether the image type is locked for the given image.
void	SetTypeLocked (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).
bool	HasLockedImages ()
	Whether the split contains images for which the dataset type is locked.

Properties
int	NumLockedImages `[get]`
	Number of images for which the dataset type is locked.
eVision.EasyDeepLearning.EDatasetType[]	DatasetMapping `[get]`
	Mapping between image indexes and the corresponding dataset split type.

Detailed Description

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

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

License(s): EasyClassify or EasySegment or EasyLocate

Constructor & Destructor Documentation

◆ EDatasetSplit() [1/3]

eVision.EasyDeepLearning.EDatasetSplit.EDatasetSplit ( )

Creates a EDatasetSplit.

◆ EDatasetSplit() [2/3]

eVision.EasyDeepLearning.EDatasetSplit.EDatasetSplit ( eVision.EasyDeepLearning.EDatasetType[] mapping )

Creates a EDatasetSplit.

Parameters

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

◆ EDatasetSplit() [3/3]

eVision.EasyDeepLearning.EDatasetSplit.EDatasetSplit ( eVision.EasyDeepLearning.EDatasetSplit other )

Creates a EDatasetSplit.

Parameters

other Other instance of EDatasetSplit.

Member Function Documentation

◆ CopyTo()

void eVision.EasyDeepLearning.EDatasetSplit.CopyTo ( eVision.EasyDeepLearning.EDatasetSplit other )

Copy the dataset split to the other instance.

Parameters

other Other instance of EDatasetSplit.

◆ GetImageType()

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

Dataset type for the given image index.

Parameters

imageIndex Image index.

◆ GetImageTypeLocked()

bool eVision.EasyDeepLearning.EDatasetSplit.GetImageTypeLocked ( 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 ( )

Number of image indexes associated in the object.

◆ GetNumImages() [2/2]

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

Number of image indexes associated with the given dataset type.

Parameters

type	Dataset split type

◆ GetSplit()

int[] eVision.EasyDeepLearning.EDatasetSplit.GetSplit ( 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 ( )

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

◆ Load() [1/2]

void eVision.EasyDeepLearning.EDatasetSplit.Load ( eVision.ESerializer serializer )

Load the EDatasetSplit configuration. The given ESerializer must have been created for reading.

Parameters

serializer The serializer.

◆ Load() [2/2]

void eVision.EasyDeepLearning.EDatasetSplit.Load ( string path )

Load the EDatasetSplit configuration. The given ESerializer must have been created for reading.

Parameters

path	The file path.

◆ Save() [1/2]

void eVision.EasyDeepLearning.EDatasetSplit.Save ( eVision.ESerializer serializer )

Save the EDatasetSplit configuration. The given ESerializer must have been created for writing.

Parameters

serializer The serializer.

◆ Save() [2/2]

void eVision.EasyDeepLearning.EDatasetSplit.Save ( string path )

Save the EDatasetSplit configuration. The given ESerializer must have been created for writing.

Parameters

path	The file path.

◆ SetImageType()

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

Dataset type for the given image index.

Parameters

imageIndex	Image index.
type	Dataset split type.

◆ SetImageTypeLocked()

void eVision.EasyDeepLearning.EDatasetSplit.SetImageTypeLocked	(	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()

void eVision.EasyDeepLearning.EDatasetSplit.SetTypeLocked	(	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

Property Documentation

◆ DatasetMapping

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

get

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.

◆ NumLockedImages

int eVision.EasyDeepLearning.EDatasetSplit.NumLockedImages

get

Number of images for which the dataset type is locked.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EDatasetSplit() [1/3]

◆ EDatasetSplit() [2/3]

◆ EDatasetSplit() [3/3]

Member Function Documentation

◆ CopyTo()

◆ GetImageType()

◆ GetImageTypeLocked()

◆ GetNumImages() [1/2]

◆ GetNumImages() [2/2]

◆ GetSplit()

◆ HasLockedImages()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetImageType()

◆ SetImageTypeLocked()

◆ SetTypeLocked()

Property Documentation

◆ DatasetMapping

◆ NumLockedImages