eVision.EasyDeepLearning.EClassificationDataset manages a dataset of images. More...

Inheritance diagram for eVision.EasyDeepLearning.EClassificationDataset:

Collaboration diagram for eVision.EasyDeepLearning.EClassificationDataset:

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EasyDeepLearning.EClassificationDataset object.
None	__init__ (self, eVision.EasyDeepLearning.EClassificationDataset other)
	Copy constructor of a eVision.EasyDeepLearning.EClassificationDataset object.
None	__init__ (self, eVision.EasyDeepLearning.EDataset other)
	Copy constructor of a eVision.EasyDeepLearning.EClassificationDataset object from a eVision.EasyDeepLearning.EDataset object.
None	Clear (self)
	Clears the dataset.
eVision.EBaseROI\|None	GetImageCopyWithDataAugmentation (self, int index, eVision.EasyDeepLearning.EDLDataAugmentationType generationType)
	Generates a new image from the i-th image of the dataset.
eVision.EBaseROI\|None	GetImageCopyWithDataAugmentation (self, int index)
	Generates a new image from the i-th image of the dataset.
None	GetImageCopyWithDataAugmentation (self, int index, eVision.EBaseROI img, eVision.EasyDeepLearning.EDLDataAugmentationType generationType)
	Generates a new image from the i-th image of the dataset.
None	GetImageCopyWithDataAugmentation (self, int index, eVision.EBaseROI img)
	Generates a new image from the i-th image of the dataset.
None	SplitDataset (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion, bool random)
	Splits the dataset in two parts to be used for training and validation respectively.
None	SplitDataset (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion)
	Splits the dataset in two parts to be used for training and validation respectively.
None	SplitDataset (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2)
	Splits the dataset in two parts to be used for training and validation respectively.
None	SplitDatasetForSegmentation (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion, bool random)
	Splits the dataset in two parts for a supervised segmenter.
None	SplitDatasetForSegmentation (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion)
	Splits the dataset in two parts for a supervised segmenter.
None	SplitDatasetForSegmentation (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2)
	Splits the dataset in two parts for a supervised segmenter.
None	SplitDatasetForLocator (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion, bool random)
	Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.
None	SplitDatasetForLocator (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2, float proportion)
	Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.
None	SplitDatasetForLocator (self, eVision.EasyDeepLearning.EClassificationDataset d1, eVision.EasyDeepLearning.EClassificationDataset d2)
	Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.
eVision.EasyDeepLearning.EClassificationDataset	ExtractSplit (self, eVision.EasyDeepLearning.EDatasetSplit split, eVision.EasyDeepLearning.EDatasetType type)
	Creates a new eVision.EasyDeepLearning.EClassificationDataset containing only the images of the given split type.
Public Member Functions inherited from eVision.EasyDeepLearning.EDataset
None	__init__ (self)
	Constructs a eVision.EasyDeepLearning.EDataset object.
None	__init__ (self, eVision.EasyDeepLearning.EDataset other)
	Copy constructor of a eVision.EasyDeepLearning.EDataset object.
None	Load (self, str path)
	Loads a classification dataset from disk.
None	Load (self, eVision.ESerializer\|None serializer)
	Loads a classification dataset from disk.
None	Save (self, str path)
	Saves a classification dataset to disk, containing the file paths to the images in the dataset and their associated label.
None	Save (self, eVision.ESerializer\|None serializer)
	Saves a classification dataset to disk, containing the file paths to the images in the dataset and their associated label.
None	SaveWithRelativePath (self, str path)
	Saves the dataset with image paths relative to the directory in which the dataset file is saved.
None	Export (self, str directory, eVision.EImageFileType fileType, int quality)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, eVision.EImageFileType fileType)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, bool keepFilename, eVision.EImageFileType fileType, int quality)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, bool keepFilename, eVision.EImageFileType fileType)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, bool keepFilename)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels, eVision.EImageFileType fileType, int quality)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels, eVision.EImageFileType fileType)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels, bool keepFilename, eVision.EImageFileType fileType, int quality)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels, bool keepFilename, eVision.EImageFileType fileType)
	Exports the dataset and its images to the given directory.
None	Export (self, str directory, int width, int height, int channels, bool keepFilename)
	Exports the dataset and its images to the given directory.
eVision.EasyDeepLearning.EImageAnnotationFormat	GetAvailableImageAnnotationFormat (self, str imageFile)
	Image annotation file formats that are available next to the image file.
eVision.EasyDeepLearning.EImageAnnotationFormat	GetAvailableImageAnnotationFormat (self, int imgId)
	Image annotation file formats that are available next to the image file.
None	ImportYOLOTXTAnnotations (self, int imgId, str labelFile)
	Imports YOLO TXT annotations (for EasyLocate Bounding Box).
None	ImportYOLOTXTAnnotations (self, str labelFile)
	Imports YOLO TXT annotations (for EasyLocate Bounding Box).
None	ImportPascalVOCXMLAnnotations (self, int imgId)
	Imports Pascal VOC XML annotations (for EasyLocate Bounding Box).
None	ImportPascalVOCXMLAnnotations (self)
	Imports Pascal VOC XML annotations (for EasyLocate Bounding Box).
int	AddImage (self, str imagePath)
	Adds an image to the dataset.
int	AddImage (self, str imagePath, str label)
	Adds an image to the dataset.
int	AddImage (self, str imagePath, int originX, int originY, int width, int height, eVision.ERegion mask)
	Adds an image to the dataset.
int	AddImage (self, str imagePath, int originX, int originY, int width, int height, eVision.ERegion mask, str label)
	Adds an image to the dataset.
int	AddImage (self, eVision.EBaseROI img)
	Adds an image to the dataset.
int	AddImage (self, eVision.EBaseROI img, str label)
	Adds an image to the dataset.
int	AddImage (self, eVision.EBaseROI img, int originX, int originY, int width, int height, eVision.ERegion mask)
	Adds an image to the dataset.
int	AddImage (self, eVision.EBaseROI img, int originX, int originY, int width, int height, eVision.ERegion mask, str label)
	Adds an image to the dataset.
int	AddImages (self, str filter)
	Adds all the images present in the directory specified by the parameter path and whose filename matches the filter.
int	AddImages (self, str filter, str label)
	Adds all the images present in the directory specified by the parameter path and whose filename matches the filter.
int	AddImages (self, str filter, int originX, int originY, int width, int height, eVision.ERegion mask)
	Adds all the images present in the directory specified by the parameter path and whose filename matches the filter.
int	AddImages (self, str filter, int originX, int originY, int width, int height, eVision.ERegion mask, str label)
	Adds all the images present in the directory specified by the parameter path and whose filename matches the filter.
int	AddImagesFromCSV (self, str csvFile, int imageColumn, int labelColumn, int skipLines, str separator)
	Adds images using a CSV (Comma Separated Value) file where each row correspond to an image and the file path and label of each image is given in the columns imageColumn and labelColumn respectively.
int	AddImagesFromCSV (self, str csvFile, int imageColumn, int labelColumn, int skipLines)
	Adds images using a CSV (Comma Separated Value) file where each row correspond to an image and the file path and label of each image is given in the columns imageColumn and labelColumn respectively.
int	AddImagesFromCSV (self, str csvFile, int imageColumn, int labelColumn)
	Adds images using a CSV (Comma Separated Value) file where each row correspond to an image and the file path and label of each image is given in the columns imageColumn and labelColumn respectively.
int	AddImagesFromCSV (self, str csvFile, int imageColumn)
	Adds images using a CSV (Comma Separated Value) file where each row correspond to an image and the file path and label of each image is given in the columns imageColumn and labelColumn respectively.
int	AddImagesFromCSV (self, str csvFile)
	Adds images using a CSV (Comma Separated Value) file where each row correspond to an image and the file path and label of each image is given in the columns imageColumn and labelColumn respectively.
None	RemoveImage (self, int imgId)
	Removes the image at the given index.
int	GetNumImagesForFile (self, str filePath)
	Get the number of images in the dataset that are associated with the given image file.
eVision.EBaseROI\|None	GetImageCopy (self, int index)
	Gets a copy of the i-th image of the dataset.
None	GetImageCopy (self, int index, eVision.EBaseROI img)
	Gets a copy of the i-th image of the dataset.
str	GetImagePath (self, int index)
	Gets the path of the i-th image of the dataset.
bool	IsImageFile (self, int index)
	Whether the image is stored as a file path towards an image.
bool	IsEmbeddedImage (self, int index)
	Whether the image is embedded into the dataset and is not a reference towards an image file.
str	GetImageLabel (self, int index)
	Gets the label of the i-th image of the dataset.
None	SetImageLabel (self, int index, str label)
	Sets the label of images in the dataset.
None	SetImageLabel (self, str filter, str label)
	Sets the label of images in the dataset.
None	UnsetImageLabel (self, int index)
	Unset the label of the given image of the dataset.
bool	HasLabel (self, int index)
	Whether an image has a classification label.
list[int]	GetImagesIndexesWithLabel (self, str label)
	Gets a list of index corresponding to the images associated with the given label.
list[int]	GetImagesIndexesWithLabel (self, int labelIndex)
	Gets a list of index corresponding to the images associated with the given label.
None	AddLabel (self, str label)
	Adds a label to the dataset.
str	GetLabel (self, int i)
	Gets the i-th label of the dataset (starting from 0 to eVision.EasyDeepLearning.EDataset.NumLabels - 1).
None	SetLabel (self, int index, str label)
	Sets the i-th label of the dataset (starting from 0 to eVision.EasyDeepLearning.EDataset.NumLabels - 1).
float	GetLabelWeight (self, int index)
	Gets the weight associated to the i-th label of the dataset (starting from 0 to eVision.EasyDeepLearning.EDataset.NumLabels - 1).
None	SetLabelWeight (self, int index, float weight)
	Sets the weight associated to the i-th label of the dataset (starting from 0 to eVision.EasyDeepLearning.EDataset.NumLabels - 1).
None	SetLabelColor (self, int index, eVision.ERGBColor color)
	Sets the label color for a classification label.
eVision.ERGBColor	GetLabelColor (self, int index)
	Gets the label color for a classification label.
None	SetLabelOpacity (self, int index, int opacity)
	Sets the label opacity for a classification label.
int	GetLabelOpacity (self, int index)
	Gets the label opacity for a classification label.
None	RemoveLabel (self, str label)
	Removes a label from the dataset.
None	RemoveLabel (self, int labelId)
	Removes a label from the dataset.
None	SetSegmentationMap (self, int imageIndex, eVision.EROIBW16 segmentationMap)
	Sets the segmentation map of an image.
eVision.EImageBW16	GetSegmentationMap (self, int imageIndex)
	Gets the segmentation map of an image.
None	UnsetSegmentation (self, int imageIndex)
	Unsets the segmentation of an image.
None	ResetSegmentation (self, int imageIndex)
	Resets the segmentation of an image by setting all pixels to background.
None	AddRegionToSegment (self, int imageIndex, int segmentationLabelIndex, eVision.ERegion region)
	Adds a region (see eVision.ERegion) to the given segment of an image.
None	AddRegionToSegment (self, int imageIndex, str label, eVision.ERegion region)
	Adds a region (see eVision.ERegion) to the given segment of an image.
eVision.ERegion	GetRegionForSegment (self, int imageIndex, int segmentationLabelIndex)
	Gets a region corresponding to the pixels of the given segment.
eVision.ERegion	GetRegionForSegment (self, int imageIndex, str segmentationLabel)
	Gets a region corresponding to the pixels of the given segment.
int	GetNumImagesForSegmentationLabel (self, int labelId)
	Number of images containing the given segmentation label.
int	GetNumImagesForSegmentationLabel (self, str label)
	Number of images containing the given segmentation label.
int	GetNumPixelsForSegmentationLabel (self, int labelId)
	Number of pixels assigned to the given segmentation label.
int	GetNumPixelsForSegmentationLabel (self, str label)
	Number of pixels assigned to the given segmentation label.
bool	HasSegmentation (self, int imageId)
	Whether the image has a segmentation.
bool	HasForegroundSegments (self, int imageId)
	Whether the image segmentation contains segments that are not background.
int	GetNumSegmentedBlobs (self, int imageId)
	Number of segmented blobs in the image for all non-background labels or for a specific label.
int	GetNumSegmentedBlobs (self, int imageId, str label)
	Number of segmented blobs in the image for all non-background labels or for a specific label.
int	GetNumSegmentedBlobs (self, int imageId, int labelId)
	Number of segmented blobs in the image for all non-background labels or for a specific label.
str	GetSegmentationLabel (self, int index)
	Gets the segmentation label.
None	SetSegmentationLabel (self, int index, str label)
	Sets the segmentation labels.
int	AddSegmentationLabel (self, str label, float labelWeight)
	Adds a segmentation label.
int	AddSegmentationLabel (self, str label)
	Adds a segmentation label.
None	RemoveSegmentationLabel (self, str label)
	Remove a segmentation label.
None	RemoveSegmentationLabel (self, int index)
	Remove a segmentation label.
float	GetSegmentationLabelWeight (self, int index)
	Gets the segmentation label weights.
float	GetSegmentationLabelWeight (self, str label)
	Gets the segmentation label weights.
None	SetSegmentationLabelWeight (self, int index, float weight)
	Sets the segmentation label weight.
None	SetSegmentationLabelWeight (self, str label, float weight)
	Sets the segmentation label weight.
None	SetSegmentationLabelColor (self, int index, eVision.ERGBColor color)
	Sets the label color for a segmentation label.
eVision.ERGBColor	GetSegmentationLabelColor (self, int index)
	Gets the label color for a segmentation label.
None	SetSegmentationLabelOpacity (self, int index, int opacity)
	Sets the label opacity for a segmentation label.
int	GetSegmentationLabelOpacity (self, int index)
	Gets the label opacity for a segmentation label.
None	ResetImageObjectLabeling (self, int imageIndex)
	Resets the object labeling for the specified image.
None	UnsetImageObjectLabeling (self, int imageIndex)
	Unsets the object labeling for the specified image.
list[eVision._eVision.EasyDeepLearning.ELocatorObject]	GetImageObjects (self, int imageIndex)
	Gets all the objects of the specified image.
int	GetImageNumObjects (self, int imageIndex)
	Number of objects for the specified image.
eVision.EasyDeepLearning.ELocatorObject	GetImageObject (self, int imageIndex, int objectIndex)
	Gets the specified object for the given image.
None	SetImageObject (self, int imageIndex, int objectIndex, eVision.EasyDeepLearning.ELocatorObject obj)
	Sets the specified object for the given image.
None	SetImageObject (self, int imageIndex, int objectIndex, str label)
	Sets the specified object for the given image.
None	SetImageObject (self, int imageIndex, int objectIndex, eVision.ERectangleRegion region)
	Sets the specified object for the given image.
None	AddImageObject (self, int imageIndex, eVision.EasyDeepLearning.ELocatorObject obj)
	Adds an object to the image.
None	AddImageObject (self, int imageIndex, str label, eVision.ERectangleRegion box)
	Adds an object to the image.
None	RemoveImageObject (self, int imageIndex, int objectIndex)
	Removes an object from an image.
str	GetObjectLabel (self, int labelIndex)
	Object label.
None	SetObjectLabel (self, int labelIndex, str newLabel)
	Sets an object label.
None	SetObjectLabel (self, str oldLabel, str newLabel)
	Sets an object label.
None	AddObjectLabel (self, str label, float weight)
	Adds an object label.
None	AddObjectLabel (self, str label)
	Adds an object label.
None	RemoveObjectLabel (self, int labelIndex)
	Removes an object label.
None	RemoveObjectLabel (self, str label)
	Removes an object label.
None	SetObjectLabelWeight (self, int labelIndex, float weight)
	Sets the weight of an object label.
None	SetObjectLabelWeight (self, str label, float weight)
	Sets the weight of an object label.
float	GetObjectLabelWeight (self, int labelIndex)
	Gets the weight of an object label.
float	GetObjectLabelWeight (self, str label)
	Gets the weight of an object label.
None	SetObjectLabelColor (self, int index, eVision.ERGBColor color)
	Sets the label color for an object label.
eVision.ERGBColor	GetObjectLabelColor (self, int index)
	Gets the label color for an object label.
None	SetObjectLabelOpacity (self, int index, int opacity)
	Sets the label opacity for an object label.
int	GetObjectLabelOpacity (self, int index)
	Gets the label opacity for an object label.
bool	HasObjectLabeling (self, int imageIndex)
	Whether the image is labeled for object detection and use with eVision.EasyDeepLearning.ELocator.
int	GetNumImagesWithObjectLabel (self, int labelIdx)
	Number of images that contain an object with the given label.
int	GetNumImagesWithObjectLabel (self, str label)
	Number of images that contain an object with the given label.
int	GetNumObjectsWithLabel (self, int labelIdx)
	Number of objects with the given label.
int	GetNumObjectsWithLabel (self, str label)
	Number of objects with the given label.
bool	HasOCRAnnotations (self, int imgId)
	Whether the specified image has OCR annotations.
None	UnsetOCRAnnotations (self, int imgId)
	Unsets the OCR labeling for the specified image.
list[eVision._eVision.EasyDeepOCR.ETextLine]	GetOCRAnnotations (self, int imgId)
	Ground truth text lines for the specified image.
None	SetOCRAnnotations (self, int imgId, list[eVision._eVision.EasyDeepOCR.ETextLine] texts)
	Sets the ground truth text lines for the specified image.
eVision.EasyDeepLearning.EDatasetSplit	GetSplit (self, float trainingProportion, float validationPropotion, eVision.EasyDeepLearning.EDeepLearningToolType toolType, str goodLabel)
	Generates a split.
eVision.EasyDeepLearning.EDatasetSplit	GetSplit (self, float trainingProportion, float validationPropotion, eVision.EasyDeepLearning.EDeepLearningToolType toolType, str goodLabel, int seed)
	Generates a split.
None	SetRegionOfInterest (self, int imageIndex, int xOrg, int yOrg, int width, int height)
	Sets the region of interest for the specified image.
int	GetRegionOfInterestOriginX (self, int imageIndex)
	Region of interest origin abscissa for the specified image.
int	GetRegionOfInterestOriginY (self, int imageIndex)
	Region of interest origin ordinate for the specified image.
int	GetRegionOfInterestWidth (self, int imageIndex)
	Region of interest width for the specified image.
int	GetRegionOfInterestHeight (self, int imageIndex)
	Region of interest height for the specified image.
eVision.ERegion	GetMask (self, int imageIndex)
	Gets the mask region/don't care area for the given image.
None	SetMask (self, int imageIndex, eVision.ERegion mask)
	Sets the mask region/don't care area for the given image.

Protected Member Functions
float	_MaxGamma__getter (self)
	\cond
	_MaxGamma__setter (self, float value)
	Maximum gamma for gamma correction.
float	_MaxHueOffset__getter (self)
	\cond
	_MaxHueOffset__setter (self, float value)
	Maximum absolute hue offset.
float	_MinSaturationGain__getter (self)
	\cond
	_MinSaturationGain__setter (self, float value)
	Minimum saturation gain.
float	_MaxSaturationGain__getter (self)
	\cond
	_MaxSaturationGain__setter (self, float value)
	Maximum saturation gain.
float	_GaussianNoiseMaximumStandardDeviation__getter (self)
	\cond
	_GaussianNoiseMaximumStandardDeviation__setter (self, float value)
	The Gaussian noise maximum standard deviation.
float	_GaussianNoiseMinimumStandardDeviation__getter (self)
	\cond
	_GaussianNoiseMinimumStandardDeviation__setter (self, float value)
	The Gaussian noise minimum standard deviation.
float	_SpeckleNoiseMaximumStandardDeviation__getter (self)
	\cond
	_SpeckleNoiseMaximumStandardDeviation__setter (self, float value)
	The speckle noise maximum standard deviation.
float	_SpeckleNoiseMinimumStandardDeviation__getter (self)
	\cond
	_SpeckleNoiseMinimumStandardDeviation__setter (self, float value)
	The speckle noise minimum standard deviation.
float	_SaltAndPepperNoiseMaximumDensity__getter (self)
	\cond
	_SaltAndPepperNoiseMaximumDensity__setter (self, float value)
	The maximum density of the salt and pepper noise.
float	_SaltAndPepperNoiseMinimumDensity__getter (self)
	\cond
	_SaltAndPepperNoiseMinimumDensity__setter (self, float value)
	The minimum density of the salt and pepper noise.
Protected Member Functions inherited from eVision.EasyDeepLearning.EDataset
	_BasePath__setter (self, str value)
	\cond
int	_Width__getter (self)
	\cond
int	_Height__getter (self)
	\cond
int	_Channels__getter (self)
	\cond
int	_NumImages__getter (self)
	\cond
int	_NumImageFiles__getter (self)
	\cond
int	_NumLabeledImages__getter (self)
	\cond
int	_NumUnlabeledImages__getter (self)
	\cond
list[int]	_LabeledImagesIndexes__getter (self)
	\cond
list[int]	_TextLabeledImagesIndexes__getter (self)
	\cond
list[int]	_ImagesIndexesWithNoLabel__getter (self)
	\cond
int	_NumLabels__getter (self)
	\cond
int	_NumSegmentationLabels__getter (self)
	\cond
int	_NumImagesWithSegmentation__getter (self)
	\cond
int	_NumImagesWithoutSegmentation__getter (self)
	\cond
int	_NumImagesWithoutForegroundSegments__getter (self)
	\cond
int	_NumImagesWithForegroundSegments__getter (self)
	\cond
int	_NumObjectLabels__getter (self)
	\cond
int	_NumImagesWithObjectLabeling__getter (self)
	\cond
int	_NumImagesWithoutObjectLabeling__getter (self)
	\cond
int	_NumImagesWithoutObjects__getter (self)
	\cond
int	_NumImagesWithObjects__getter (self)
	\cond
float	_SameLabelMaxOverlap__getter (self)
	\cond
float	_AbsoluteMaxOverlap__getter (self)
	\cond
int	_MaxNumObjectPerImage__getter (self)
	\cond
int	_ObjectSize__getter (self)
	\cond
	_ObjectSize__setter (self, int value)
	Object size for EasyLocate Interest point.
int	_NumImagesWithOCR__getter (self)
	\cond
int	_NumImagesWithoutOCR__getter (self)
	\cond
int	_NumTexts__getter (self)
	\cond
eVision.EasyDeepLearning.EDataset	_TextDataset__getter (self)
	\cond
eVision.EasyDeepLearning.EDataset	_TextOrientationDataset__getter (self)
	\cond

Properties
	EnableDataAugmentation = property(_EnableDataAugmentation__getter, _EnableDataAugmentation__setter)
	Enable data augmentation.
	MaxHorizontalShift = property(_MaxHorizontalShift__getter, _MaxHorizontalShift__setter)
	Maximum horizontal shift for data augmentation.
	MaxVerticalShift = property(_MaxVerticalShift__getter, _MaxVerticalShift__setter)
	Maximum vertical shift for data augmentation.
	MaxRotationAngle = property(_MaxRotationAngle__getter, _MaxRotationAngle__setter)
	Maximum rotation angle for data augmentation.
	EnableVerticalFlip = property(_EnableVerticalFlip__getter, _EnableVerticalFlip__setter)
	Enable vertical flipping in data augmentation.
	EnableHorizontalFlip = property(_EnableHorizontalFlip__getter, _EnableHorizontalFlip__setter)
	Enable horizontal flipping in data augmentation.
	MinScale = property(_MinScale__getter, _MinScale__setter)
	Minimum scaling allowed for data augmentation.
	MaxScale = property(_MaxScale__getter, _MaxScale__setter)
	Maximum scaling allowed for data augmentation.
	MaxHorizontalShear = property(_MaxHorizontalShear__getter, _MaxHorizontalShear__setter)
	Maximum absolute horizontal shear.
	MaxVerticalShear = property(_MaxVerticalShear__getter, _MaxVerticalShear__setter)
	Maximum absolute vertical shear.
	MaxBrightnessOffset = property(_MaxBrightnessOffset__getter, _MaxBrightnessOffset__setter)
	Maximum absolute brightness offset.
	MaxContrastGain = property(_MaxContrastGain__getter, _MaxContrastGain__setter)
	Maximum contrast gain.
	MinContrastGain = property(_MinContrastGain__getter, _MinContrastGain__setter)
	Minimum contrast gain.
	MinGamma = property(_MinGamma__getter, _MinGamma__setter)
	Minimum gamma for gamma correction.
	MaxGamma = property(_MaxGamma__getter, _MaxGamma__setter)
	\endcond
	MaxHueOffset = property(_MaxHueOffset__getter, _MaxHueOffset__setter)
	\endcond
	MinSaturationGain = property(_MinSaturationGain__getter, _MinSaturationGain__setter)
	\endcond
	MaxSaturationGain = property(_MaxSaturationGain__getter, _MaxSaturationGain__setter)
	\endcond
	GaussianNoiseMaximumStandardDeviation = property(_GaussianNoiseMaximumStandardDeviation__getter, _GaussianNoiseMaximumStandardDeviation__setter)
	\endcond
	GaussianNoiseMinimumStandardDeviation = property(_GaussianNoiseMinimumStandardDeviation__getter, _GaussianNoiseMinimumStandardDeviation__setter)
	\endcond
	SpeckleNoiseMaximumStandardDeviation = property(_SpeckleNoiseMaximumStandardDeviation__getter, _SpeckleNoiseMaximumStandardDeviation__setter)
	\endcond
	SpeckleNoiseMinimumStandardDeviation = property(_SpeckleNoiseMinimumStandardDeviation__getter, _SpeckleNoiseMinimumStandardDeviation__setter)
	\endcond
	SaltAndPepperNoiseMaximumDensity = property(_SaltAndPepperNoiseMaximumDensity__getter, _SaltAndPepperNoiseMaximumDensity__setter)
	\endcond
	SaltAndPepperNoiseMinimumDensity = property(_SaltAndPepperNoiseMinimumDensity__getter, _SaltAndPepperNoiseMinimumDensity__setter)
	\endcond
Properties inherited from eVision.EasyDeepLearning.EDataset
	BasePath = property(None, _BasePath__setter)
	\endcond
	Width = property(_Width__getter, None)
	\endcond
	Height = property(_Height__getter, None)
	\endcond
	Channels = property(_Channels__getter, None)
	\endcond
	NumImages = property(_NumImages__getter, None)
	\endcond
	NumImageFiles = property(_NumImageFiles__getter, None)
	\endcond
	NumLabeledImages = property(_NumLabeledImages__getter, None)
	\endcond
	NumUnlabeledImages = property(_NumUnlabeledImages__getter, None)
	\endcond
	LabeledImagesIndexes = property(_LabeledImagesIndexes__getter, None)
	\endcond
	TextLabeledImagesIndexes = property(_TextLabeledImagesIndexes__getter, None)
	\endcond
	ImagesIndexesWithNoLabel = property(_ImagesIndexesWithNoLabel__getter, None)
	\endcond
	NumLabels = property(_NumLabels__getter, None)
	\endcond
	NumSegmentationLabels = property(_NumSegmentationLabels__getter, None)
	\endcond
	NumImagesWithSegmentation = property(_NumImagesWithSegmentation__getter, None)
	\endcond
	NumImagesWithoutSegmentation = property(_NumImagesWithoutSegmentation__getter, None)
	\endcond
	NumImagesWithoutForegroundSegments = property(_NumImagesWithoutForegroundSegments__getter, None)
	\endcond
	NumImagesWithForegroundSegments = property(_NumImagesWithForegroundSegments__getter, None)
	\endcond
	NumObjectLabels = property(_NumObjectLabels__getter, None)
	\endcond
	NumImagesWithObjectLabeling = property(_NumImagesWithObjectLabeling__getter, None)
	\endcond
	NumImagesWithoutObjectLabeling = property(_NumImagesWithoutObjectLabeling__getter, None)
	\endcond
	NumImagesWithoutObjects = property(_NumImagesWithoutObjects__getter, None)
	\endcond
	NumImagesWithObjects = property(_NumImagesWithObjects__getter, None)
	\endcond
	SameLabelMaxOverlap = property(_SameLabelMaxOverlap__getter, None)
	\endcond
	AbsoluteMaxOverlap = property(_AbsoluteMaxOverlap__getter, None)
	\endcond
	MaxNumObjectPerImage = property(_MaxNumObjectPerImage__getter, None)
	\endcond
	ObjectSize = property(_ObjectSize__getter, _ObjectSize__setter)
	\endcond
	NumImagesWithOCR = property(_NumImagesWithOCR__getter, None)
	\endcond
	NumImagesWithoutOCR = property(_NumImagesWithoutOCR__getter, None)
	\endcond
	NumTexts = property(_NumTexts__getter, None)
	\endcond
	TextDataset = property(_TextDataset__getter, None)
	\endcond
	TextOrientationDataset = property(_TextOrientationDataset__getter, None)
	\endcond

Detailed Description

eVision.EasyDeepLearning.EClassificationDataset manages a dataset of images.

A dataset is a collection of images with different types of labeling: labeling for the classification of images, labeling for the segmentation of pixels, and/or labeling for the detection of objects (classification and localization).

The dataset maintains 3 sets of labels for each type of labeling:

the classification labels that characterize an entire image;
the segmentation labels that characterize the pixels of an image; and
the object labels that characterize axis-aligned rectangle region of an image.

The classification and segmentation labels are entirely user defined. The set of segmentation labels will always contain at least the "Background" label representing pixels of the images that have no relevant information for your task (for example, in a defect segmentation application, the "Background" pixels would be the pixels without any defects).

For each type of labeling, an image can either be unlabeled or labeled. When an image in unlabeled for a given type of labeling, the image won't be used for training a deep learning tool that requires this type of labeling.

The image in the dataset can be stored as path to an image file or as an eVision image structure. Supported structures are 8-bits monochrome (eVision.EImageBW8), 16-bits monochrome (eVision.EImageBW16), and 24-bits color (eVision.EROIC24, eVision.EImageC24).

The dataset associates with each image a region of interest and a mask/don't care area. By default, the region of interest of an image is its full extent and its mask is empty.

A eVision.EasyDeepLearning.EClassificationDataset object is also responsible for providing tools to do data augmentation. Data augmentation is the process of generating new images on-the-fly by applying affine transformations to those already in the dataset. Data augmentation allows a deep neural network to be invariant to the applied transformation without having to capture and label real world images containing those transformations.

A dataset can contain images with different sizes (with and height of their region of interest). However, the dataset has a default resolution (see eVision.EasyDeepLearning.EDataset.Width and eVision.EasyDeepLearning.EDataset.Height) that is used by deep learning tools that require the same input image size such as the eVision.EasyDeepLearning.EClassifier. When the images have different sizes, the default resolution will be the resolution of the region of interest of the first image added to the dataset.

Remarks:

License(s): BasicTypes

Deprecated: Deprecated in version 26.10. Scheduled to be removed in version 27.10.

Constructor & Destructor Documentation

◆ init() [1/3]

None eVision.EasyDeepLearning.EClassificationDataset.__init__ ( self )

Constructs a eVision.EasyDeepLearning.EClassificationDataset object.

◆ init() [2/3]

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

Copy constructor of a eVision.EasyDeepLearning.EClassificationDataset object.

Parameters

other Reference to the eVision.EasyDeepLearning.EClassificationDataset object that should be copied

◆ init() [3/3]

None eVision.EasyDeepLearning.EClassificationDataset.__init__	(		self,
		eVision.EasyDeepLearning.EDataset	other )

Copy constructor of a eVision.EasyDeepLearning.EClassificationDataset object from a eVision.EasyDeepLearning.EDataset object.

Parameters

other Reference to the eVision.EasyDeepLearning.EDataset object that should be copied

Member Function Documentation

◆ _GaussianNoiseMaximumStandardDeviation__getter()

float eVision.EasyDeepLearning.EClassificationDataset._GaussianNoiseMaximumStandardDeviation__getter ( self )

protected

\cond

The Gaussian noise maximum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be superior or equal to eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _GaussianNoiseMaximumStandardDeviation__setter()

eVision.EasyDeepLearning.EClassificationDataset._GaussianNoiseMaximumStandardDeviation__setter	(		self,
		float	value )

protected

The Gaussian noise maximum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be superior or equal to eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _GaussianNoiseMinimumStandardDeviation__getter()

float eVision.EasyDeepLearning.EClassificationDataset._GaussianNoiseMinimumStandardDeviation__getter ( self )

protected

\cond

The Gaussian noise minimum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _GaussianNoiseMinimumStandardDeviation__setter()

eVision.EasyDeepLearning.EClassificationDataset._GaussianNoiseMinimumStandardDeviation__setter	(		self,
		float	value )

protected

The Gaussian noise minimum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _MaxGamma__getter()

float eVision.EasyDeepLearning.EClassificationDataset._MaxGamma__getter ( self )

protected

\cond

Maximum gamma for gamma correction. Its value must be higher than eVision.EasyDeepLearning.EClassificationDataset.MinGamma.

Remarks:

Gamma correction transformation is performed by raising each normalized pixel value to the power of gamma with gamma taken between eVision.EasyDeepLearning.EClassificationDataset.MinGamma and eVision.EasyDeepLearning.EClassificationDataset.MaxGamma.

◆ _MaxGamma__setter()

eVision.EasyDeepLearning.EClassificationDataset._MaxGamma__setter	(		self,
		float	value )

protected

Maximum gamma for gamma correction.

Its value must be higher than eVision.EasyDeepLearning.EClassificationDataset.MinGamma.

Remarks:

Gamma correction transformation is performed by raising each normalized pixel value to the power of gamma with gamma taken between eVision.EasyDeepLearning.EClassificationDataset.MinGamma and eVision.EasyDeepLearning.EClassificationDataset.MaxGamma.

◆ _MaxHueOffset__getter()

float eVision.EasyDeepLearning.EClassificationDataset._MaxHueOffset__getter ( self )

protected

\cond

Maximum absolute hue offset. Its value must be between 0 and 180 degrees.

Remarks:

The hue is represented as an angle between 0 and 360 degrees. The hue transformation is performed by rotating the hue of each pixel by a value between -eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset and +eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset. This transformation only works for color images.

◆ _MaxHueOffset__setter()

eVision.EasyDeepLearning.EClassificationDataset._MaxHueOffset__setter	(		self,
		float	value )

protected

Maximum absolute hue offset.

Its value must be between 0 and 180 degrees.

Remarks:

The hue is represented as an angle between 0 and 360 degrees. The hue transformation is performed by rotating the hue of each pixel by a value between -eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset and +eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset. This transformation only works for color images.

◆ _MaxSaturationGain__getter()

float eVision.EasyDeepLearning.EClassificationDataset._MaxSaturationGain__getter ( self )

protected

\cond

Maximum saturation gain. Its value must be over or equal to eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ _MaxSaturationGain__setter()

eVision.EasyDeepLearning.EClassificationDataset._MaxSaturationGain__setter	(		self,
		float	value )

protected

Maximum saturation gain.

Its value must be over or equal to eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ _MinSaturationGain__getter()

float eVision.EasyDeepLearning.EClassificationDataset._MinSaturationGain__getter ( self )

protected

\cond

Minimum saturation gain. Its value must be strictly positive.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ _MinSaturationGain__setter()

eVision.EasyDeepLearning.EClassificationDataset._MinSaturationGain__setter	(		self,
		float	value )

protected

Minimum saturation gain.

Its value must be strictly positive.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ _SaltAndPepperNoiseMaximumDensity__getter()

float eVision.EasyDeepLearning.EClassificationDataset._SaltAndPepperNoiseMaximumDensity__getter ( self )

protected

\cond

The maximum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and 1.

Remarks:

This noise is computed after all the other noises.

◆ _SaltAndPepperNoiseMaximumDensity__setter()

eVision.EasyDeepLearning.EClassificationDataset._SaltAndPepperNoiseMaximumDensity__setter	(		self,
		float	value )

protected

The maximum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and 1.

Remarks:

This noise is computed after all the other noises.

◆ _SaltAndPepperNoiseMinimumDensity__getter()

float eVision.EasyDeepLearning.EClassificationDataset._SaltAndPepperNoiseMinimumDensity__getter ( self )

protected

\cond

The minimum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity.

Remarks:

This noise is computed after all the other noises.

◆ _SaltAndPepperNoiseMinimumDensity__setter()

eVision.EasyDeepLearning.EClassificationDataset._SaltAndPepperNoiseMinimumDensity__setter	(		self,
		float	value )

protected

The minimum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity.

Remarks:

This noise is computed after all the other noises.

◆ _SpeckleNoiseMaximumStandardDeviation__getter()

float eVision.EasyDeepLearning.EClassificationDataset._SpeckleNoiseMaximumStandardDeviation__getter ( self )

protected

\cond

The speckle noise maximum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly higher than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _SpeckleNoiseMaximumStandardDeviation__setter()

eVision.EasyDeepLearning.EClassificationDataset._SpeckleNoiseMaximumStandardDeviation__setter	(		self,
		float	value )

protected

The speckle noise maximum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly higher than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _SpeckleNoiseMinimumStandardDeviation__getter()

float eVision.EasyDeepLearning.EClassificationDataset._SpeckleNoiseMinimumStandardDeviation__getter ( self )

protected

\cond

The speckle noise minimum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly positive and lower than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ _SpeckleNoiseMinimumStandardDeviation__setter()

eVision.EasyDeepLearning.EClassificationDataset._SpeckleNoiseMinimumStandardDeviation__setter	(		self,
		float	value )

protected

The speckle noise minimum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly positive and lower than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ Clear()

None eVision.EasyDeepLearning.EClassificationDataset.Clear ( self )

Clears the dataset.

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ ExtractSplit()

eVision.EasyDeepLearning.EClassificationDataset eVision.EasyDeepLearning.EClassificationDataset.ExtractSplit	(		self,
		eVision.EasyDeepLearning.EDatasetSplit	split,
		eVision.EasyDeepLearning.EDatasetType	type )

Creates a new eVision.EasyDeepLearning.EClassificationDataset containing only the images of the given split type.

Parameters

split	Split
type	Type of the split to extract

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ GetImageCopyWithDataAugmentation() [1/4]

eVision.EBaseROI \| None eVision.EasyDeepLearning.EClassificationDataset.GetImageCopyWithDataAugmentation	(		self,
		int	index )

Generates a new image from the i-th image of the dataset.

For the variant where a pointer is returned, the user is responsible for clearing the memory of the returned pointer.

Remarks:

If the data augmentation fails, the method will throw an exception.

Parameters

index The index of the image.

◆ GetImageCopyWithDataAugmentation() [2/4]

eVision.EBaseROI \| None eVision.EasyDeepLearning.EClassificationDataset.GetImageCopyWithDataAugmentation	(		self,
		int	index,
		eVision.EasyDeepLearning.EDLDataAugmentationType	generationType )

Generates a new image from the i-th image of the dataset.

For the variant where a pointer is returned, the user is responsible for clearing the memory of the returned pointer.

Remarks:

If the data augmentation fails, the method will throw an exception.

Parameters

index	The index of the image.
generationType	The type of transformation to generate (default: random).

◆ GetImageCopyWithDataAugmentation() [3/4]

None eVision.EasyDeepLearning.EClassificationDataset.GetImageCopyWithDataAugmentation	(		self,
		int	index,
		eVision.EBaseROI	img )

Generates a new image from the i-th image of the dataset.

For the variant where a pointer is returned, the user is responsible for clearing the memory of the returned pointer.

Remarks:

If the data augmentation fails, the method will throw an exception.

Parameters

index	The index of the image.
img	Image object to copy the image into.

◆ GetImageCopyWithDataAugmentation() [4/4]

None eVision.EasyDeepLearning.EClassificationDataset.GetImageCopyWithDataAugmentation	(		self,
		int	index,
		eVision.EBaseROI	img,
		eVision.EasyDeepLearning.EDLDataAugmentationType	generationType )

Generates a new image from the i-th image of the dataset.

For the variant where a pointer is returned, the user is responsible for clearing the memory of the returned pointer.

Remarks:

If the data augmentation fails, the method will throw an exception.

Parameters

index	The index of the image.
img	Image object to copy the image into.
generationType	The type of transformation to generate (default: random).

◆ SplitDataset() [1/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDataset	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2 )

Splits the dataset in two parts to be used for training and validation respectively.

Parameters

d1	First part of the dataset
d2	Second part of the dataset

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDataset() [2/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDataset	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion )

Splits the dataset in two parts to be used for training and validation respectively.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDataset() [3/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDataset	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion,
		bool	random )

Splits the dataset in two parts to be used for training and validation respectively.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2
random	Randomly sample the images.

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForLocator() [1/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForLocator	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2 )

Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.

Images without object labeling are excluded from the split.

Remarks:

The method ensures that all the object labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForLocator() [2/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForLocator	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion )

Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.

Images without object labeling are excluded from the split.

Remarks:

The method ensures that all the object labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForLocator() [3/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForLocator	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion,
		bool	random )

Splits the dataset in two parts for training and validation of a eVision.EasyDeepLearning.ELocator tool.

Images without object labeling are excluded from the split.

Remarks:

The method ensures that all the object labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2
random	Randomly sample the images.

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForSegmentation() [1/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForSegmentation	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2 )

Splits the dataset in two parts for a supervised segmenter.

The two parts are to be used for training and validation respectively.

Remarks:

The method ensures that all the segmentation labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForSegmentation() [2/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForSegmentation	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion )

Splits the dataset in two parts for a supervised segmenter.

The two parts are to be used for training and validation respectively.

Remarks:

The method ensures that all the segmentation labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2

Reimplemented from eVision.EasyDeepLearning.EDataset.

◆ SplitDatasetForSegmentation() [3/3]

None eVision.EasyDeepLearning.EClassificationDataset.SplitDatasetForSegmentation	(		self,
		eVision.EasyDeepLearning.EClassificationDataset	d1,
		eVision.EasyDeepLearning.EClassificationDataset	d2,
		float	proportion,
		bool	random )

Splits the dataset in two parts for a supervised segmenter.

The two parts are to be used for training and validation respectively.

Remarks:

The method ensures that all the segmentation labels are represented in d1. Thus, even when the parameter random is set to false, the images in d1 and d2 can be ordered differently than they were in the original dataset.

Parameters

d1	First part of the dataset
d2	Second part of the dataset
proportion	Proportion of image of each class to put into the first part. The remaining images are put in d2
random	Randomly sample the images.

Reimplemented from eVision.EasyDeepLearning.EDataset.

Property Documentation

◆ EnableDataAugmentation

eVision.EasyDeepLearning.EClassificationDataset.EnableDataAugmentation = property(_EnableDataAugmentation__getter, _EnableDataAugmentation__setter)

static

Enable data augmentation.

◆ EnableHorizontalFlip

eVision.EasyDeepLearning.EClassificationDataset.EnableHorizontalFlip = property(_EnableHorizontalFlip__getter, _EnableHorizontalFlip__setter)

static

Enable horizontal flipping in data augmentation.

◆ EnableVerticalFlip

eVision.EasyDeepLearning.EClassificationDataset.EnableVerticalFlip = property(_EnableVerticalFlip__getter, _EnableVerticalFlip__setter)

static

Enable vertical flipping in data augmentation.

◆ GaussianNoiseMaximumStandardDeviation

eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation = property(_GaussianNoiseMaximumStandardDeviation__getter, _GaussianNoiseMaximumStandardDeviation__setter)

static

\endcond

The Gaussian noise maximum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be superior or equal to eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ GaussianNoiseMinimumStandardDeviation

eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation = property(_GaussianNoiseMinimumStandardDeviation__getter, _GaussianNoiseMinimumStandardDeviation__setter)

static

\endcond

The Gaussian noise minimum standard deviation.

The Gaussian noise is an additive noise sampled from a Gaussian distribution of deviation between eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation (also called the normal distribution).

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.GaussianNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ MaxBrightnessOffset

eVision.EasyDeepLearning.EClassificationDataset.MaxBrightnessOffset = property(_MaxBrightnessOffset__getter, _MaxBrightnessOffset__setter)

static

Maximum absolute brightness offset.

Its value must be between 0 and 1.

Remarks:

Brightness transformation is performed by adding a value taken between -eVision.EasyDeepLearning.EClassificationDataset.MaxBrightnessOffset and +eVision.EasyDeepLearning.EClassificationDataset.MaxBrightnessOffset to each pixel of the normalized image.

◆ MaxContrastGain

eVision.EasyDeepLearning.EClassificationDataset.MaxContrastGain = property(_MaxContrastGain__getter, _MaxContrastGain__setter)

static

Maximum contrast gain.

Its value must be strictly positive and over eVision.EasyDeepLearning.EClassificationDataset.MinContrastGain.

Remarks:

Contrast transformation is performed by multiplying each mean-centered pixel value by a gain value taken between eVision.EasyDeepLearning.EClassificationDataset.MinContrastGain and eVision.EasyDeepLearning.EClassificationDataset.MaxContrastGain. A contrast transformation does not change the overall brightness of an image.

◆ MaxGamma

eVision.EasyDeepLearning.EClassificationDataset.MaxGamma = property(_MaxGamma__getter, _MaxGamma__setter)

static

\endcond

Maximum gamma for gamma correction. Its value must be higher than eVision.EasyDeepLearning.EClassificationDataset.MinGamma.

Remarks:

Gamma correction transformation is performed by raising each normalized pixel value to the power of gamma with gamma taken between eVision.EasyDeepLearning.EClassificationDataset.MinGamma and eVision.EasyDeepLearning.EClassificationDataset.MaxGamma.

◆ MaxHorizontalShear

eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShear = property(_MaxHorizontalShear__getter, _MaxHorizontalShear__setter)

static

Maximum absolute horizontal shear.

It is represented as an angle from the vertical direction. Its value must be between 0 and 90 degrees.

◆ MaxHorizontalShift

eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShift = property(_MaxHorizontalShift__getter, _MaxHorizontalShift__setter)

static

Maximum horizontal shift for data augmentation.

The horizontal shift will be between -eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShift and +eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShift.

◆ MaxHueOffset

eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset = property(_MaxHueOffset__getter, _MaxHueOffset__setter)

static

\endcond

Maximum absolute hue offset. Its value must be between 0 and 180 degrees.

Remarks:

The hue is represented as an angle between 0 and 360 degrees. The hue transformation is performed by rotating the hue of each pixel by a value between -eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset and +eVision.EasyDeepLearning.EClassificationDataset.MaxHueOffset. This transformation only works for color images.

◆ MaxRotationAngle

eVision.EasyDeepLearning.EClassificationDataset.MaxRotationAngle = property(_MaxRotationAngle__getter, _MaxRotationAngle__setter)

static

Maximum rotation angle for data augmentation.

The rotation angle will be between -eVision.EasyDeepLearning.EClassificationDataset.MaxRotationAngle and +eVision.EasyDeepLearning.EClassificationDataset.MaxRotationAngle.

◆ MaxSaturationGain

eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain = property(_MaxSaturationGain__getter, _MaxSaturationGain__setter)

static

\endcond

Maximum saturation gain. Its value must be over or equal to eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ MaxScale

eVision.EasyDeepLearning.EClassificationDataset.MaxScale = property(_MaxScale__getter, _MaxScale__setter)

static

Maximum scaling allowed for data augmentation.

◆ MaxVerticalShear

eVision.EasyDeepLearning.EClassificationDataset.MaxVerticalShear = property(_MaxVerticalShear__getter, _MaxVerticalShear__setter)

static

Maximum absolute vertical shear.

It is represented as an angle from the horizontal direction. Its value must be between 0 and 90 degrees.

◆ MaxVerticalShift

eVision.EasyDeepLearning.EClassificationDataset.MaxVerticalShift = property(_MaxVerticalShift__getter, _MaxVerticalShift__setter)

static

Maximum vertical shift for data augmentation.

The vertical shift will be between -eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShift and +eVision.EasyDeepLearning.EClassificationDataset.MaxHorizontalShift.

◆ MinContrastGain

eVision.EasyDeepLearning.EClassificationDataset.MinContrastGain = property(_MinContrastGain__getter, _MinContrastGain__setter)

static

Minimum contrast gain.

Its value must be strictly positive and below eVision.EasyDeepLearning.EClassificationDataset.MaxContrastGain.

Remarks:

Contrast transformation is performed by multiplying each mean-centered pixel value by a gain value taken between eVision.EasyDeepLearning.EClassificationDataset.MinContrastGain and eVision.EasyDeepLearning.EClassificationDataset.MaxContrastGain. A contrast transformation does not change the overall brightness of an image.

◆ MinGamma

eVision.EasyDeepLearning.EClassificationDataset.MinGamma = property(_MinGamma__getter, _MinGamma__setter)

static

Minimum gamma for gamma correction.

Its value must be strictly positive and below eVision.EasyDeepLearning.EClassificationDataset.MaxGamma.

Remarks:

Gamma correction transformation is performed by raising each normalized pixel value to the power of gamma with gamma taken between eVision.EasyDeepLearning.EClassificationDataset.MinGamma and @Class.MaxGamma`.

◆ MinSaturationGain

eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain = property(_MinSaturationGain__getter, _MinSaturationGain__setter)

static

\endcond

Minimum saturation gain. Its value must be strictly positive.

Remarks:

The saturation transformation is performed by multiplying the saturation of each pixel by a value between eVision.EasyDeepLearning.EClassificationDataset.MinSaturationGain and eVision.EasyDeepLearning.EClassificationDataset.MaxSaturationGain.

◆ MinScale

eVision.EasyDeepLearning.EClassificationDataset.MinScale = property(_MinScale__getter, _MinScale__setter)

static

Minimum scaling allowed for data augmentation.

◆ SaltAndPepperNoiseMaximumDensity

eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity = property(_SaltAndPepperNoiseMaximumDensity__getter, _SaltAndPepperNoiseMaximumDensity__setter)

static

\endcond

The maximum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and 1.

Remarks:

This noise is computed after all the other noises.

◆ SaltAndPepperNoiseMinimumDensity

eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity = property(_SaltAndPepperNoiseMinimumDensity__getter, _SaltAndPepperNoiseMinimumDensity__setter)

static

\endcond

The minimum density of the salt and pepper noise.

The salt and pepper noise sets the value of a number of randomly selected (between eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMinimumDensity and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity) pixels to its minimum or maximum value.

Its value must be between 0 and eVision.EasyDeepLearning.EClassificationDataset.SaltAndPepperNoiseMaximumDensity.

Remarks:

This noise is computed after all the other noises.

◆ SpeckleNoiseMaximumStandardDeviation

eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation = property(_SpeckleNoiseMaximumStandardDeviation__getter, _SpeckleNoiseMaximumStandardDeviation__setter)

static

\endcond

The speckle noise maximum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly higher than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

◆ SpeckleNoiseMinimumStandardDeviation

eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation = property(_SpeckleNoiseMinimumStandardDeviation__getter, _SpeckleNoiseMinimumStandardDeviation__setter)

static

\endcond

The speckle noise minimum standard deviation.

The speckle noise is a multiplicative noise sampled from a Gamma distribution with a mean of 1 and with its standard deviation between eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMinimumStandardDeviation and eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Its value must be strictly positive and lower than eVision.EasyDeepLearning.EClassificationDataset.SpeckleNoiseMaximumStandardDeviation.

Remarks:

This noise is computed before the salt and paper noise.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/3]

◆ __init__() [2/3]

◆ __init__() [3/3]

Member Function Documentation

◆ _GaussianNoiseMaximumStandardDeviation__getter()

◆ _GaussianNoiseMaximumStandardDeviation__setter()

◆ _GaussianNoiseMinimumStandardDeviation__getter()

◆ _GaussianNoiseMinimumStandardDeviation__setter()

◆ _MaxGamma__getter()

◆ _MaxGamma__setter()

◆ _MaxHueOffset__getter()

◆ _MaxHueOffset__setter()

◆ _MaxSaturationGain__getter()

◆ _MaxSaturationGain__setter()

◆ _MinSaturationGain__getter()

◆ _MinSaturationGain__setter()

◆ _SaltAndPepperNoiseMaximumDensity__getter()

◆ _SaltAndPepperNoiseMaximumDensity__setter()

◆ _SaltAndPepperNoiseMinimumDensity__getter()

◆ _SaltAndPepperNoiseMinimumDensity__setter()

◆ _SpeckleNoiseMaximumStandardDeviation__getter()

◆ _SpeckleNoiseMaximumStandardDeviation__setter()

◆ _SpeckleNoiseMinimumStandardDeviation__getter()

◆ _SpeckleNoiseMinimumStandardDeviation__setter()

◆ Clear()

◆ ExtractSplit()

◆ GetImageCopyWithDataAugmentation() [1/4]

◆ GetImageCopyWithDataAugmentation() [2/4]

◆ GetImageCopyWithDataAugmentation() [3/4]

◆ GetImageCopyWithDataAugmentation() [4/4]

◆ SplitDataset() [1/3]

◆ SplitDataset() [2/3]

◆ SplitDataset() [3/3]

◆ SplitDatasetForLocator() [1/3]

◆ SplitDatasetForLocator() [2/3]

◆ SplitDatasetForLocator() [3/3]

◆ SplitDatasetForSegmentation() [1/3]

◆ SplitDatasetForSegmentation() [2/3]

◆ SplitDatasetForSegmentation() [3/3]

Property Documentation

◆ EnableDataAugmentation

◆ EnableHorizontalFlip

◆ EnableVerticalFlip

◆ GaussianNoiseMaximumStandardDeviation

◆ GaussianNoiseMinimumStandardDeviation

◆ MaxBrightnessOffset

◆ MaxContrastGain

◆ MaxGamma

◆ MaxHorizontalShear

◆ MaxHorizontalShift

◆ MaxHueOffset

◆ MaxRotationAngle

◆ MaxSaturationGain

◆ MaxScale

◆ MaxVerticalShear

◆ MaxVerticalShift

◆ MinContrastGain

◆ MinGamma

◆ MinSaturationGain

◆ MinScale

◆ SaltAndPepperNoiseMaximumDensity

◆ SaltAndPepperNoiseMinimumDensity

◆ SpeckleNoiseMaximumStandardDeviation

◆ SpeckleNoiseMinimumStandardDeviation

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]