eVision::EasyDeepLearning Namespace Reference

Classes
class	EClassificationDataset
	EClassificationDataset manages a dataset of images. More...
class	EClassificationMetrics
	Collection of metrics used to evaluate the state of an EClassifier. More...
class	EClassificationResult
	An EClassificationResult object represents the result of a classification. More...
class	EClassifier
	EClassifier allows to train a classifier using an EDataset object and classify new images. More...
class	EDataAugmentation
	An EDataAugmentation object is responsible for storing the data augmentation parameters and generating new transformed images from existing ones. Deep learning algorithms are not invariant to the location, scale, or rotation of the elements of interest in the image. Thus, if the final application requires the deep learning algorithm to be invariant to those characteristics, the dataset must contain images covering the spectrum of those characteristics. More...
class	EDataset
	EDataset manages a dataset of images. More...
class	EDatasetSplit
	The EDatasetSplit maps the image indexes of a EDataset to a dataset split type (EDatasetType). More...
class	EDeepLearningBenchmark
	Deep Learning benchmark results. More...
class	EDeepLearningBenchmarkSettings
	Class representing the settings of a Deep Learning benchmark. More...
class	EDeepLearningDefectDetectionMetrics
	Collection of metrics used to evaluate a defect detection problem where the detection is based on the thresholding of a score produced by the underlying deep learning tool, e.g. a EUnsupervisedSegmenter tool or a ESupervisedSegmenter tool. More...
class	EDeepLearningDevice
	Class representing a device that can run a neural network. A device is fully described by its EDeepLearningDevice::GetName and EDeepLearningDevice::GetEngineName. More...
class	EDeepLearningExecutionSettings
	Execution settings for a Deep Learning tool. More...
class	EDeepLearningProject
	Deep learning project. More...
class	EDeepLearningTool
	EDeepLearningTool represents the common operations of deep learning tools. More...
class	EDeepOCRModelParameters
	Base class for the parameters of EasyDeepOCR models for user retraining. More...
class	EDeepOCRModelParametersTextLocation
	Parameters for the user retraining of the text location model of EasyDeepOCR. More...
class	EDeepOCRTool
	Trains the EasyDeepOCR Deep Learning models. More...
class	EDeepOCRToolMetrics
	Metrics for EDeepOCRTool. More...
class	EDeepOCRToolResult
	Result for EDeepOCRTool. More...
class	EInterestPointLocator
	EasyLocate tool - interest point version. More...
class	ELocator
	EasyLocate tool - axis aligned bounding box version. More...
class	ELocatorBase
	Base class for EasyLocate tool. More...
class	ELocatorMetrics
	Collection of metrics used to evaluate the results of a ELocator tool. More...
class	ELocatorMetricsGenerator
	Locator metric generator. More...
class	ELocatorObject
	Object for a ELocator tool. More...
class	ELocatorPredictedObject
	Object predicted by a ELocator tool. More...
class	ELocatorResult
	Result of a ELocator tool. More...
struct	EROCPoint
	The structure representing a point on the ROC (Receiver Operating Characteristic) curve. More...
class	ESupervisedSegmenter
	Supervised segmentation tool. More...
class	ESupervisedSegmenterBlob
	A blob detected by a supervised segmentation tool (see ESupervisedSegmenter and ESupervisedSegmenterResult). More...
class	ESupervisedSegmenterMetrics
	Collection of metrics used to evaluate the state of a ESupervisedSegmenter tool. More...
class	ESupervisedSegmenterResult
	An ESupervisedSegmenterResult object represents the result of a supervised segmenter. More...
class	EUnsupervisedSegmenter
	Unsupervised segmentation tool. More...
class	EUnsupervisedSegmenterMetrics
	Collection of metrics used to evaluate the state of an EUnsupervisedSegmenter. More...
class	EUnsupervisedSegmenterResult
	An EUnsupervisedSegmenterResult object represents the result of a EUnsupervisedSegmenter tool. More...
struct	EWeightedPrecisionRecallPoint
	Weighted precision and recall for a given threshold. More...

Enumerations
enum	EClassifierCapacity { EClassifierCapacity_Small = 0 , EClassifierCapacity_Normal = 1 , EClassifierCapacity_Large = 2 , EClassifierCapacity_Onnx = 3 }
	The capacity of the classifier network. More...
enum	EConfusionMatrixElement { EConfusionMatrixElement_CorrectlyClassifiedGoodSample = 0 , EConfusionMatrixElement_BadlyClassifiedGoodSample = 1 , EConfusionMatrixElement_CorrectlyClassifiedDefectiveSample = 2 , EConfusionMatrixElement_BadlyClassifiedDefectiveSample = 3 }
	The various elements representing the cases of the 2x2 confusion matrix used in EDeepLearningDefectDetectionMetrics. More...
enum	EDatasetType { EDatasetType_Training = 1 , EDatasetType_Validation = 2 , EDatasetType_Test = 4 , EDatasetType_All = 7 }
	Type of dataset split. More...
enum	EDeepLearningDeviceType { EDeepLearningDeviceType_CPU = 0 , EDeepLearningDeviceType_GPU = 1 , EDeepLearningDeviceType_Other = 2 , EDeepLearningDeviceType_NotADevice = 3 }
	Different types of Deep Learning device. More...
enum	EDeepLearningInferencePrecision { EDeepLearningInferencePrecision_INT8 = 0 , EDeepLearningInferencePrecision_FLOAT16 = 1 , EDeepLearningInferencePrecision_FLOAT32 = 2 }
	Precisions supported by a Deep Learning device. More...
enum	EDeepLearningLearningRateType {   EDeepLearningLearningRateType_Standard = 0 , EDeepLearningLearningRateType_Fixed = 1 , EDeepLearningLearningRateType_Custom = 2 , EDeepLearningLearningRateType_Decay = 3 ,   EDeepLearningLearningRateType_WarmRestart = 4 }
	The type of learning rate indicates how the learning rate changes during training. More...
enum	EDeepLearningToolType {   EDeepLearningToolType_None = 0 , EDeepLearningToolType_EasyClassify = 1 , EDeepLearningToolType_EasySegmentUnsupervised = 2 , EDeepLearningToolType_EasySegmentSupervised = 3 ,   EDeepLearningToolType_EasyLocate = 4 , EDeepLearningToolType_EasyLocateInterestPoint = 5 , EDeepLearningToolType_DeepOCR = 6 }
	Type of EasyDeepLearning tool. More...
enum	EDeepOCRModel { EDeepOCRModel_Location = 0 , EDeepOCRModel_Orientation = 1 , EDeepOCRModel_Recognition = 2 , EDeepOCRModel_None = 3 }
	EasyDeepOCR models that are trainable with EDeepOCRTool. More...
enum	EDLDataAugmentationType { EDLDataAugmentationType_Random = 0 , EDLDataAugmentationType_LowerLimit = 1 , EDLDataAugmentationType_UpperLimit = 2 }
	This enum represents how the data augmentation transformation are generated. More...
enum	EHeatmapColormap { EHeatmapColormap_YellowToRed = 0 , EHeatmapColormap_Jet = 1 , EHeatmapColormap_Grayscale = 2 }
	Color maps for visualizing the heatmap. More...
enum	EImageAnnotationFormat { EImageAnnotationFormat_None = 0 , EImageAnnotationFormat_YOLOTXT = 1 , EImageAnnotationFormat_PASCALVOCXML = 2 }
	Supported formats of annotation files for image file. More...
enum	ELocatorCapacity { ELocatorCapacity_Small = 0 , ELocatorCapacity_Normal = 1 , ELocatorCapacity_Large = 2 }
	The capacity of the locator deep learning network. More...
enum	ELocatorFeature { ELocatorFeature_None = 0 , ELocatorFeature_Position = 1 , ELocatorFeature_Size = 2 }
	Features supported by the ELocator or ELocatorObject. More...
enum	ESupervisedSegmenterCapacity { ESupervisedSegmenterCapacity_Small = 0 , ESupervisedSegmenterCapacity_Normal = 1 , ESupervisedSegmenterCapacity_Large = 2 }
	The capacity of the supervised segmentation network. More...
enum	EUnsupervisedSegmenterCapacity { EUnsupervisedSegmenterCapacity_Small = 0 , EUnsupervisedSegmenterCapacity_Normal = 1 , EUnsupervisedSegmenterCapacity_Large = 2 }
	The capacity of the unsupervised network. More...

Enumeration Type Documentation

EClassifierCapacity

enum eVision::EasyDeepLearning::EClassifierCapacity

The capacity of the classifier network.

A larger capacity means that the underlying neural network is capable of learning more information but it will be slower. Also a lower capacity allow for a smaller minimal height and width of input.

Deprecated

Deprecated in version 26.10. Scheduled to be removed in version 27.6.

Enumerator
EClassifierCapacity_Small	Small capacity.
EClassifierCapacity_Normal	Normal capacity.
EClassifierCapacity_Large	Large capacity.
EClassifierCapacity_Onnx	Onnx classifier capacity.

EConfusionMatrixElement

enum eVision::EasyDeepLearning::EConfusionMatrixElement

The various elements representing the cases of the 2x2 confusion matrix used in EDeepLearningDefectDetectionMetrics.

Enumerator
EConfusionMatrixElement_CorrectlyClassifiedGoodSample	A CorrectlyClassifiedGoodSample is a good images classified as good. It is also called a true negative.
EConfusionMatrixElement_BadlyClassifiedGoodSample	A BadlyClassifiedGoodSample is a good images classified as defective. It is also called a false positive.
EConfusionMatrixElement_CorrectlyClassifiedDefectiveSample	A CorrectlyClassifiedDefectiveSample is a defective images classified as defective. It is also called a true positive.
EConfusionMatrixElement_BadlyClassifiedDefectiveSample	A BadlyClassifiedDefectiveSample is a good images classified as good. It is also called a false negative.

EDatasetType

enum eVision::EasyDeepLearning::EDatasetType

Type of dataset split.

Enumerator
EDatasetType_Training	Training dataset (images used to train the model).
EDatasetType_Validation	Validation dataset (images used to select the model ith the best performance during training).
EDatasetType_Test	Test dataset (images not used during training).
EDatasetType_All	Training, validation, or test dataset.

EDeepLearningDeviceType

enum eVision::EasyDeepLearning::EDeepLearningDeviceType

Different types of Deep Learning device.

Enumerator
EDeepLearningDeviceType_CPU	The Deep Learning device is a CPU.
EDeepLearningDeviceType_GPU	The Deep Learning device is a GPU.
EDeepLearningDeviceType_Other	The Deep Learning device is neither a CPU nor a GPU.
EDeepLearningDeviceType_NotADevice	The Deep Learning device is not a device.

EDeepLearningInferencePrecision

enum eVision::EasyDeepLearning::EDeepLearningInferencePrecision

Precisions supported by a Deep Learning device.

Enumerator
EDeepLearningInferencePrecision_INT8	8 bit integer precision.
EDeepLearningInferencePrecision_FLOAT16	16 bit floating point precision.
EDeepLearningInferencePrecision_FLOAT32	32 bit floating point precision.

EDeepLearningLearningRateType

enum eVision::EasyDeepLearning::EDeepLearningLearningRateType

The type of learning rate indicates how the learning rate changes during training.

Enumerator
EDeepLearningLearningRateType_Standard	The learning rate is reduced after each training iterations where the training error has not significantly changed. Parameters: None
EDeepLearningLearningRateType_Fixed	The learning rate value remains fixed with the value given as parameter during the training. Parameters= [lr]
EDeepLearningLearningRateType_Custom	The learning rate is set for each iterations at the corresponding value in the vector of parameters. Parameters: [lr0, lr1, ..., lrN]. The last learning rate in the parameters will be used when the number of training iterations is bigger than the vector of parameters.
EDeepLearningLearningRateType_Decay	The learning rate is reduced by a factor after each iterations until a minimum. Parameters: [Start learning rate, Minimum learning rate, Decay factor]
EDeepLearningLearningRateType_WarmRestart	The learning rate goes from maxLr to minLr during the n-th period of periodN iterations. The length of the first period is given by the parameter period0 and is multiplied by the factor f after each period. Thus, periodN = f^n * period0. Parameters: [minMr, maxLr, period0, f]

EDeepLearningToolType

enum eVision::EasyDeepLearning::EDeepLearningToolType

Type of EasyDeepLearning tool.

Enumerator
EDeepLearningToolType_None	Not an EasyDeepLearning tool.
EDeepLearningToolType_EasyClassify	EasyClassify tool.
EDeepLearningToolType_EasySegmentUnsupervised	EasySegmentUnsupervised tool.
EDeepLearningToolType_EasySegmentSupervised	EasySegmentSupervised tool.
EDeepLearningToolType_EasyLocate	EasyLocate tool.
EDeepLearningToolType_EasyLocateInterestPoint	EasyLocateInterestPoint tool.
EDeepLearningToolType_DeepOCR	A tool for the deep Learning models from EasyDeepOCR.

EDeepOCRModel

enum eVision::EasyDeepLearning::EDeepOCRModel

EasyDeepOCR models that are trainable with EDeepOCRTool.

Enumerator
EDeepOCRModel_Location	Location model.
EDeepOCRModel_Orientation	Orientation model (model used to determine the reading direction).
EDeepOCRModel_Recognition	Recognition model (model used to decode the images to a string).
EDeepOCRModel_None	No model.

EDLDataAugmentationType

enum eVision::EasyDeepLearning::EDLDataAugmentationType

This enum represents how the data augmentation transformation are generated.

Enumerator
EDLDataAugmentationType_Random	Random transformation between the lower and upper limits.
EDLDataAugmentationType_LowerLimit	Transformation using the lower limits.
EDLDataAugmentationType_UpperLimit	Transformation using the upper limits.

EHeatmapColormap

enum eVision::EasyDeepLearning::EHeatmapColormap

Color maps for visualizing the heatmap.

Enumerator
EHeatmapColormap_YellowToRed	Colormap showing a gradient from yellow to red.
EHeatmapColormap_Jet	Colormap showing a gradient going from blue to green to yellow to dark red.
EHeatmapColormap_Grayscale	Colormap showing a gradient going from black to white.

EImageAnnotationFormat

enum eVision::EasyDeepLearning::EImageAnnotationFormat

Supported formats of annotation files for image file.

Enumerator
EImageAnnotationFormat_None	No annotation.
EImageAnnotationFormat_YOLOTXT	The YOLO annotation format for EasyLocate bounding box. Annotation file: imagefilename.txt. Description of the format: each row of the file defines an object: class_id center_x center_y width height The label list must be correctly set before adding images with YOLO annotations. You can also import a YOLO dataset defined with a YAML file using EDataset::ImportYOLOTXTAnnotations.
EImageAnnotationFormat_PASCALVOCXML	Pascal VOC XML format for EasyLocate bounding box. Annotation file: imagefilename.xml. Description of the format: XML file. See the official Pascal VOC website for a description of the format.

ELocatorCapacity

enum eVision::EasyDeepLearning::ELocatorCapacity

The capacity of the locator deep learning network.

A larger capacity means that the underlying neural network is capable of learning more information but it will be slower.

Enumerator
ELocatorCapacity_Small	Small capacity.
ELocatorCapacity_Normal	Normal capacity.
ELocatorCapacity_Large	Large capacity.

ELocatorFeature

enum eVision::EasyDeepLearning::ELocatorFeature

Features supported by the ELocator or ELocatorObject.

Enumerator
ELocatorFeature_None	No features.
ELocatorFeature_Position	The locator predicts the position of the object.
ELocatorFeature_Size	The locator predicts the size of the object (width and height).

ESupervisedSegmenterCapacity

enum eVision::EasyDeepLearning::ESupervisedSegmenterCapacity

The capacity of the supervised segmentation network.

A larger capacity means that the underlying neural network is capable of learning more information but it will be slower.

Enumerator
ESupervisedSegmenterCapacity_Small	Small capacity.
ESupervisedSegmenterCapacity_Normal	Normal capacity.
ESupervisedSegmenterCapacity_Large	Large capacity.

EUnsupervisedSegmenterCapacity

enum eVision::EasyDeepLearning::EUnsupervisedSegmenterCapacity

The capacity of the unsupervised network.

A larger capacity means that the underlying neural network is capable of learning more information but it will be slower.

Enumerator
EUnsupervisedSegmenterCapacity_Small	Small capacity.
EUnsupervisedSegmenterCapacity_Normal	Normal capacity.
EUnsupervisedSegmenterCapacity_Large	Large capacity.