EasyLocate tool - axis aligned bounding box version. More...

Inheritance diagram for eVision.EasyDeepLearning.ELocator:

[legend]

Collaboration diagram for eVision.EasyDeepLearning.ELocator:

[legend]

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EasyDeepLearning.ELocator object.
None	__init__ (self, eVision.EasyDeepLearning.ELocator other)
	Copy constructor of a eVision.EasyDeepLearning.ELocator object.
None	SerializeSettings (self, eVision.ESerializer\|None serializer)
	Serializes the settings of the locator.
list[eVision._eVision.ESize]	GenerateAnchors (self, eVision.EasyDeepLearning.EDataset dataset)
	Generates anchors based on the objects in the dataset or a formal specification.
list[eVision._eVision.ESize]	GenerateAnchors (self, float minDimension, float maxDimension, int numSubScales, list[float] aspectRatios)
	Generates anchors based on the objects in the dataset or a formal specification.
Public Member Functions inherited from eVision.EasyDeepLearning.ELocatorBase
eVision.EasyDeepLearning.ELocatorMetrics	GetTrainingMetrics (self, int iteration)
	Training metrics at the given iteration.
eVision.EasyDeepLearning.ELocatorMetrics	GetValidationMetrics (self, int iteration)
	Validation metrics at the given iteration.
None	Train (self, eVision.EasyDeepLearning.EDataset dataset)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset dataset, eVision.EasyDeepLearning.EDataAugmentation dataAugmentation)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset trainingDataset, eVision.EasyDeepLearning.EDataset validationDataset)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset trainingDataset, eVision.EasyDeepLearning.EDataset validationDataset, eVision.EasyDeepLearning.EDataAugmentation dataAugmentation)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset dataset, int iterations)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset dataset, eVision.EasyDeepLearning.EDataAugmentation dataAugmentation, int iterations)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset trainingDataset, eVision.EasyDeepLearning.EDataset validationDataset, int iterations)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
None	Train (self, eVision.EasyDeepLearning.EDataset trainingDataset, eVision.EasyDeepLearning.EDataset validationDataset, eVision.EasyDeepLearning.EDataAugmentation dataAugmentation, int iterations)
	Trains the eVision.EasyDeepLearning.ELocatorBase with the given dataset for the specified number of iterations.
eVision.EasyDeepLearning.ELocatorResult	Apply (self, eVision.EBaseROI img)
	Applies the tool on the given image and its mask region.
eVision.EasyDeepLearning.ELocatorResult	Apply (self, eVision.EBaseROI img, eVision.ERegion mask)
	Applies the tool on the given image and its mask region.
eVision.EasyDeepLearning.ELocatorResult	Apply (self, eVision.EBaseROI img, eVision.EFrame frame)
	Applies the tool on the given image and its mask region.
eVision.EasyDeepLearning.ELocatorResult	Apply (self, eVision.EBaseROI img, eVision.EFrame frame, eVision.ERegion mask)
	Applies the tool on the given image and its mask region.
list[eVision._eVision.EasyDeepLearning.ELocatorResult]	Apply (self, list[eVision._eVision.EBaseROI\|None] imgs)
	Applies the tool on the given image and its mask region.
list[eVision._eVision.EasyDeepLearning.ELocatorResult]	Apply (self, list[eVision._eVision.EBaseROI\|None] imgs, list[eVision._eVision.ERegion] masks)
	Applies the tool on the given image and its mask region.
eVision.EasyDeepLearning.ELocatorMetrics	Evaluate (self, eVision.EasyDeepLearning.EDataset dataset)
	Evaluates the dataset.
bool	HasFeature (self, eVision.EasyDeepLearning.ELocatorFeature feature)
	Whether the given feature is enabled.
Public Member Functions inherited from eVision.EasyDeepLearning.EDeepLearningTool
None	Load (self, str filePath)
	Loads a deep learning tool.
None	Load (self, eVision.ESerializer\|None serializer)
	Loads a deep learning tool.
eVision.EasyDeepLearning.EDeepLearningTool\|None	Clone (self)
	Clones this tool.
None	Save (self, str filePath, bool includeTrainingModel)
	Saves the settings, inference and training model of the deep learning tool.
None	Save (self, str filePath)
	Saves the settings, inference and training model of the deep learning tool.
None	Save (self, eVision.ESerializer\|None serializer, bool includeTrainingModel)
	Saves the settings, inference and training model of the deep learning tool.
None	Save (self, eVision.ESerializer\|None serializer)
	Saves the settings, inference and training model of the deep learning tool.
None	SerializeInferenceModel (self, eVision.ESerializer\|None serializer)
	Serializes the inference model of the tool.
None	SerializeTrainingModel (self, eVision.ESerializer\|None serializer)
	Serializes the training model of the tool.
None	SaveSettings (self, str filePath)
	Saves the settings of the tool to a file.
None	SaveInferenceModel (self, str filePath)
	Saves the tool's inference model to a file.
None	SaveTrainingModel (self, str filePath)
	Saves the tool's training model to a file.
None	LoadSettings (self, str filePath)
	Loads the settings of a tool.
None	LoadInferenceModel (self, str filePath)
	Loads the tool's inference model.
None	LoadTrainingModel (self, str filePath)
	Loads the tool's training model.
None	UnloadInferenceModel (self)
	Unloads the inference model.
None	UnloadTrainingModel (self)
	Unloads the training model.
None	UnloadModels (self)
	Unloads the inference and training model.
bool	HasInferenceModel (self)
	Whether the inference model is loaded or created when the tool is not yet trained.
bool	HasTrainingModel (self)
	Whether the training model is loaded or created when the tool is not yet trained.
bool	IsTrained (self)
	Tells whether the deep learning tool has been trained.
str	GetAvailableDeviceName (self, int i)
	Name of the i-th device of the current engine.
eVision.EasyDeepLearning.EDeepLearningDevice	GetAvailableDevice (self, int i)
	i-th eVision.EasyDeepLearning.EDeepLearningDevice of the current engine.
None	SetActiveDevice (self, eVision.EasyDeepLearning.EDeepLearningDevice device)
	Sets the device with which to run or train the model.
eVision.EasyDeepLearning.EDeepLearningDevice	GetActiveDevice (self, int i)
	Gets the active device.
eVision.EasyDeepLearning.EDeepLearningDevice	GetActiveDevice (self)
	Gets the active device.
bool	HasEngineSetupData (self)
	Whether the inference model has engine setup data.
None	ClearEngineSetupData (self)
	Clears the engine data saved in the inference model.
bool	IsTraining (self)
	Indicates whether the object is currently training.
int	WaitForTrainingCompletion (self, int timeout)
	Waits until the training is complete or the timeout is expired.
int	WaitForTrainingCompletion (self)
	Waits until the training is complete or the timeout is expired.
int	WaitForIterationCompletion (self)
	Waits until an iteration is complete.
int	StopTraining (self, bool wait)
	Stops training and returns the last completed iteration.
None	SetLearningRate (self, eVision.EasyDeepLearning.EDeepLearningLearningRateType type, list[float] parameters)
	Specifies how the value of the learning rate and how it evolves during training.
None	InitializeInference (self, int width, int height, eVision.EImageType imageType, int numImages)
	Initializes the neural network for inference (i.e.
None	InitializeInference (self, eVision.EBaseROI img)
	Initializes the neural network for inference (i.e.
None	InitializeInference (self, list[eVision._eVision.EBaseROI\|None] imgList)
	Initializes the neural network for inference (i.e.
str	GetLabel (self, int index)
	Gets the label from its index.
None	SetLabel (self, int index, str label)
	Changes a label predicted by the tool.
None	SetLabelWeight (self, int index, float weight)
	Sets the label weight.
float	GetLabelWeight (self, int index)
	Gets the label weight.
None	SetLabelColor (self, int index, eVision.ERGBColor c)
	Changes a label color.
eVision.ERGBColor	GetLabelColor (self, int index)
	Label color.
None	SetLabelOpacity (self, int index, int opacity)
	Changes a label opacity (between 0 for fully transparent and 255 for opaque color).
int	GetLabelOpacity (self, int index)
	Gets the label opacity (between 0 for fully transparent and 255 for opaque color).
int	GetOptimalNumImagesForBatchSize (self, eVision.EBaseROI sampleImage)
	Optimal number of images to process together for inference given the batch size and eVision.EasyDeepLearning.EDeepLearningTool.GetNumPatchesForImage.
int	GetOptimalNumImagesForBatchSize (self, int imageWidth, int imageHeight)
	Optimal number of images to process together for inference given the batch size and eVision.EasyDeepLearning.EDeepLearningTool.GetNumPatchesForImage.
int	GetNumPatchesForImage (self, eVision.EBaseROI sampleImage)
	Number of patches that will be extracted from an input image to perform inference.
int	GetNumPatchesForImage (self, int imageWidth, int imageHeight)
	Number of patches that will be extracted from an input image to perform inference.
None	Clean (self)
	Reset the engine and clean CPU and GPU memory allocated for running the model.

Protected Member Functions
eVision.EasyDeepLearning.EDeepLearningToolType	_ToolType__getter (self)
	\cond
float	_SameLabelMaxOverlap__getter (self)
	\cond
	_SameLabelMaxOverlap__setter (self, float value)
	Maximum overlap (intersection over union) between two predicted objects with the same label.
float	_AbsoluteMaxOverlap__getter (self)
	\cond
	_AbsoluteMaxOverlap__setter (self, float value)
	Maximum overlap (intersection over union) between two predicted objects regardless of their label.
Protected Member Functions inherited from eVision.EasyDeepLearning.ELocatorBase
eVision.EasyDeepLearning.ELocatorCapacity	_Capacity__getter (self)
	\cond
	_Capacity__setter (self, eVision.EasyDeepLearning.ELocatorCapacity value)
	Capacity of the eVision.EasyDeepLearning.ELocatorBase.
int	_Width__getter (self)
	\cond
	_Width__setter (self, int value)
	Width of input images.
int	_Height__getter (self)
	\cond
	_Height__setter (self, int value)
	Height of input images.
int	_Channels__getter (self)
	\cond
	_Channels__setter (self, int value)
	Number of channels of input images.
list[eVision._eVision.ESize]	_PredictionAnchors__getter (self)
	\cond
	_PredictionAnchors__setter (self, list[eVision._eVision.ESize] value)
	Prediction anchors.
float	_DetectionThreshold__getter (self)
	\cond
	_DetectionThreshold__setter (self, float value)
	Detection threshold.
int	_MaxNumberOfObjects__getter (self)
	\cond
	_MaxNumberOfObjects__setter (self, int value)
	Maximum number of objects in an image (default value: 100).
float	_SameLabelMaxObjectProximity__getter (self)
	\cond
	_SameLabelMaxObjectProximity__setter (self, float value)
	Maximum proximity between two predicted objects with the same label.
float	_AbsoluteMaxObjectProximity__getter (self)
	\cond
	_AbsoluteMaxObjectProximity__setter (self, float value)
	Maximum proximity between two predicted objects regardless of their label.
int	_LocatorFeatures__getter (self)
	\cond
Protected Member Functions inherited from eVision.EasyDeepLearning.EDeepLearningTool
bool	_EnableGPU__getter (self)
	\cond
	_EnableGPU__setter (self, bool value)
	Enable the use of a GPU for training and inference of the deep learning tool.
list[int]	_GPUIndexes__getter (self)
	\cond
	_GPUIndexes__setter (self, list[int] value)
	Indexes of the GPUs to use for computations.
int	_NumGPUs__getter (self)
	\cond
str	_Engine__getter (self)
	\cond
	_Engine__setter (self, str value)
	Sets the engine with which to execute or train the neural network.
eVision.EasyDeepLearning.EDeepLearningInferencePrecision	_InferencePrecision__getter (self)
	\cond
	_InferencePrecision__setter (self, eVision.EasyDeepLearning.EDeepLearningInferencePrecision value)
	Inference precision.
int	_NumAvailableDevices__getter (self)
	\cond
list[eVision._eVision.EasyDeepLearning.EDeepLearningDevice]	_AvailableDevices__getter (self)
	\cond
int	_NumActiveDevices__getter (self)
	\cond
	_ActiveDeviceByName__setter (self, str value)
	\cond
	_ActiveDeviceById__setter (self, int value)
	\cond
list[eVision._eVision.EasyDeepLearning.EDeepLearningDevice]	_ActiveDevices__getter (self)
	\cond
	_ActiveDevices__setter (self, list[eVision._eVision.EasyDeepLearning.EDeepLearningDevice] value)
	Devices with which to run or train the model.
	_ActiveDevicesById__setter (self, list[int] value)
	\cond
eVision.EasyDeepLearning.EDeepLearningExecutionSettings	_ExecutionSettings__getter (self)
	\cond
	_ExecutionSettings__setter (self, eVision.EasyDeepLearning.EDeepLearningExecutionSettings value)
	Execution settings of the tool (engine, device(s), inference precision, batch size settings).
eVision.EasyDeepLearning.EDeepLearningDevice	_EngineSetupDataDevice__getter (self)
	\cond
eVision.EasyDeepLearning.EDeepLearningInferencePrecision	_EngineSetupDataInferencePrecision__getter (self)
	\cond
int	_EngineSetupDataBatchSize__getter (self)
	\cond
bool	_OptimizeBatchSize__getter (self)
	\cond
	_OptimizeBatchSize__setter (self, bool value)
	Indicates whether to optimize the batch size (see eVision.EasyDeepLearning.EDeepLearningTool.BatchSize) to maximize the training and inference speed according to the engine, the device and the available memory.
int	_BatchSizeForMaximumInferenceSpeed__getter (self)
	\cond
int	_BatchSize__getter (self)
	\cond
	_BatchSize__setter (self, int value)
	Batch size.
float	_CurrentTrainingProgression__getter (self)
	\cond
int	_CurrentTrainingFinishedIterations__getter (self)
	\cond
int	_CurrentTrainingNumIterations__getter (self)
	\cond
int	_NumTrainedIterations__getter (self)
	\cond
int	_BestIteration__getter (self)
	\cond
int	_ImageCacheSize__getter (self)
	\cond
	_ImageCacheSize__setter (self, int value)
	Size in byte of the image cache.
str	_Path__getter (self)
	\cond
str	_InferenceModelPath__getter (self)
	\cond
str	_TrainingModelPath__getter (self)
	\cond
str	_SettingsPath__getter (self)
	\cond
int	_AutoSavePeriod__getter (self)
	\cond
	_AutoSavePeriod__setter (self, int value)
	Auto-save period.
eVision.EasyDeepLearning.EDeepLearningLearningRateType	_LearningRateType__getter (self)
	\cond
list[float]	_LearningRateParameters__getter (self)
	\cond
bool	_EnableDeterministicTraining__getter (self)
	\cond
	_EnableDeterministicTraining__setter (self, bool value)
	Whether to use deterministic training algorithm that allows to repeatable training results.
int	_DeterministicTrainingRandomSeed__getter (self)
	\cond
	_DeterministicTrainingRandomSeed__setter (self, int value)
	Random seed to use when eVision.EasyDeepLearning.EDeepLearningTool.EnableDeterministicTraining is set to true.
int	_NumLabels__getter (self)
	\cond

Properties
	ToolType = property(_ToolType__getter, None)
	\endcond
	SameLabelMaxOverlap = property(_SameLabelMaxOverlap__getter, _SameLabelMaxOverlap__setter)
	\endcond
	AbsoluteMaxOverlap = property(_AbsoluteMaxOverlap__getter, _AbsoluteMaxOverlap__setter)
	\endcond
Properties inherited from eVision.EasyDeepLearning.ELocatorBase
	Capacity = property(_Capacity__getter, _Capacity__setter)
	\endcond
	Width = property(_Width__getter, _Width__setter)
	\endcond
	Height = property(_Height__getter, _Height__setter)
	\endcond
	Channels = property(_Channels__getter, _Channels__setter)
	\endcond
	PredictionAnchors = property(_PredictionAnchors__getter, _PredictionAnchors__setter)
	\endcond
	DetectionThreshold = property(_DetectionThreshold__getter, _DetectionThreshold__setter)
	\endcond
	MaxNumberOfObjects = property(_MaxNumberOfObjects__getter, _MaxNumberOfObjects__setter)
	\endcond
	SameLabelMaxObjectProximity = property(_SameLabelMaxObjectProximity__getter, _SameLabelMaxObjectProximity__setter)
	\endcond
	AbsoluteMaxObjectProximity = property(_AbsoluteMaxObjectProximity__getter, _AbsoluteMaxObjectProximity__setter)
	\endcond
	LocatorFeatures = property(_LocatorFeatures__getter, None)
	\endcond
Properties inherited from eVision.EasyDeepLearning.EDeepLearningTool
	ToolType = property(_ToolType__getter, None)
	\endcond
	EnableGPU = property(_EnableGPU__getter, _EnableGPU__setter)
	\endcond
	GPUIndexes = property(_GPUIndexes__getter, _GPUIndexes__setter)
	\endcond
	NumGPUs = property(_NumGPUs__getter, None)
	\endcond
	Engine = property(_Engine__getter, _Engine__setter)
	\endcond
	InferencePrecision = property(_InferencePrecision__getter, _InferencePrecision__setter)
	\endcond
	NumAvailableDevices = property(_NumAvailableDevices__getter, None)
	\endcond
	AvailableDevices = property(_AvailableDevices__getter, None)
	\endcond
	NumActiveDevices = property(_NumActiveDevices__getter, None)
	\endcond
	ActiveDeviceByName = property(None, _ActiveDeviceByName__setter)
	\endcond
	ActiveDeviceById = property(None, _ActiveDeviceById__setter)
	\endcond
	ActiveDevices = property(_ActiveDevices__getter, _ActiveDevices__setter)
	\endcond
	ActiveDevicesById = property(None, _ActiveDevicesById__setter)
	\endcond
	ExecutionSettings = property(_ExecutionSettings__getter, _ExecutionSettings__setter)
	\endcond
	EngineSetupDataDevice = property(_EngineSetupDataDevice__getter, None)
	\endcond
	EngineSetupDataInferencePrecision = property(_EngineSetupDataInferencePrecision__getter, None)
	\endcond
	EngineSetupDataBatchSize = property(_EngineSetupDataBatchSize__getter, None)
	\endcond
	OptimizeBatchSize = property(_OptimizeBatchSize__getter, _OptimizeBatchSize__setter)
	\endcond
	BatchSizeForMaximumInferenceSpeed = property(_BatchSizeForMaximumInferenceSpeed__getter, None)
	\endcond
	BatchSize = property(_BatchSize__getter, _BatchSize__setter)
	\endcond
	CurrentTrainingProgression = property(_CurrentTrainingProgression__getter, None)
	\endcond
	CurrentTrainingFinishedIterations = property(_CurrentTrainingFinishedIterations__getter, None)
	\endcond
	CurrentTrainingNumIterations = property(_CurrentTrainingNumIterations__getter, None)
	\endcond
	NumTrainedIterations = property(_NumTrainedIterations__getter, None)
	\endcond
	BestIteration = property(_BestIteration__getter, None)
	\endcond
	ImageCacheSize = property(_ImageCacheSize__getter, _ImageCacheSize__setter)
	\endcond
	Path = property(_Path__getter, None)
	\endcond
	InferenceModelPath = property(_InferenceModelPath__getter, None)
	\endcond
	TrainingModelPath = property(_TrainingModelPath__getter, None)
	\endcond
	SettingsPath = property(_SettingsPath__getter, None)
	\endcond
	AutoSavePeriod = property(_AutoSavePeriod__getter, _AutoSavePeriod__setter)
	\endcond
	LearningRateType = property(_LearningRateType__getter, None)
	\endcond
	LearningRateParameters = property(_LearningRateParameters__getter, None)
	\endcond
	EnableDeterministicTraining = property(_EnableDeterministicTraining__getter, _EnableDeterministicTraining__setter)
	\endcond
	DeterministicTrainingRandomSeed = property(_DeterministicTrainingRandomSeed__getter, _DeterministicTrainingRandomSeed__setter)
	\endcond
	NumLabels = property(_NumLabels__getter, None)
	\endcond

Additional Inherited Members
Static Public Member Functions inherited from eVision.EasyDeepLearning.EDeepLearningTool
eVision.EasyDeepLearning.EDeepLearningTool\|None	Create (str path)
	Factory method to open a deep learning tool.
eVision.EasyDeepLearning.EDeepLearningTool\|None	Create (eVision.ESerializer\|None serializer)
	Factory method to open a deep learning tool.
eVision.EasyDeepLearning.EDeepLearningTool\|None	Create (eVision.EasyDeepLearning.EDeepLearningToolType type)
	Factory method to open a deep learning tool.
int	GetNumAvailableEngines ()
	Number of available engines.
str	GetAvailableEngineName (int id)
	Gets the name of the engine given its id.
list[str]	GetAvailableEngines ()
	Available engines.
list[eVision._eVision.EasyDeepLearning.EDeepLearningDevice]	GetAvailableDevicesForEngine (str engine)
	Available devices for the specified engine.

Detailed Description

EasyLocate tool - axis aligned bounding box version.

The eVision.EasyDeepLearning.ELocator locates and classifies objects (or defects). With this class, an object is defined by the axis-aligned bounding box that surrounds it and a label (see eVision.EasyDeepLearning.ELocatorObject class). The tool must be trained using a dataset with annotated objects. The minimum size resolution supported by the tool is 128. The maximum size of the image supported is 500 000 pixels.

The tool has 5 main parameters:

A set of anchors, i.e. pre-defined object size that it must be able to detect. The anchors can be automatically determined from the training dataset, specified manually using eVision.EasyDeepLearning.ELocatorBase.PredictionAnchors, or generated according to size information about the objects (see eVision.EasyDeepLearning.ELocator.GenerateAnchors).
A detection threshold (eVision.EasyDeepLearning.ELocatorBase.DetectionThreshold) to accept or reject predicted objects based on their score.
The maximum number of objects in an image (eVision.EasyDeepLearning.ELocatorBase.MaxNumberOfObjects)
The maximum overlap between predicted objects with the same label (eVision.EasyDeepLearning.ELocator.SameLabelMaxOverlap, eVision.EasyDeepLearning.ELocatorBase.SameLabelMaxObjectProximity)
The maximum overlap between predicted objects regardless of their label (eVision.EasyDeepLearning.ELocator.AbsoluteMaxOverlap, eVision.EasyDeepLearning.ELocatorBase.AbsoluteMaxObjectProximity). Except for the anchors, all the parameters can be changed before and after training the tool.

Remarks:

License(s): EasyLocate or EasyLocateInference

Constructor & Destructor Documentation

◆ init() [1/2]

None eVision.EasyDeepLearning.ELocator.__init__ ( self )

Constructs a eVision.EasyDeepLearning.ELocator object.

◆ init() [2/2]

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

Copy constructor of a eVision.EasyDeepLearning.ELocator object.

Parameters

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

Member Function Documentation

◆ _AbsoluteMaxOverlap__getter()

float eVision.EasyDeepLearning.ELocator._AbsoluteMaxOverlap__getter ( self )

protected

\cond

Maximum overlap (intersection over union) between two predicted objects regardless of their label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with different labels) and 1 (full overlap allowed between two predicted objects with different labels).

Default value: 1.

Remarks:

This parameter can be changed before and after training.

◆ _AbsoluteMaxOverlap__setter()

eVision.EasyDeepLearning.ELocator._AbsoluteMaxOverlap__setter	(		self,
		float	value )

protected

Maximum overlap (intersection over union) between two predicted objects regardless of their label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with different labels) and 1 (full overlap allowed between two predicted objects with different labels).

Default value: 1.

Remarks:

This parameter can be changed before and after training.

◆ _SameLabelMaxOverlap__getter()

float eVision.EasyDeepLearning.ELocator._SameLabelMaxOverlap__getter ( self )

protected

\cond

Maximum overlap (intersection over union) between two predicted objects with the same label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with the same label) and 1 (full overlap allowed between two predicted objects with the same label). A low value will reduce the amount of falsely detected objects but may increase the number of missed objects. A high value will increase the number of falsely detected objects and reduce the number of missed objects.

Default value: 0.5

Remarks:

This parameter is also used to compute the matching between ground truth and predicted objects during evaluation.

This parameter can be changed before and after training.

◆ _SameLabelMaxOverlap__setter()

eVision.EasyDeepLearning.ELocator._SameLabelMaxOverlap__setter	(		self,
		float	value )

protected

Maximum overlap (intersection over union) between two predicted objects with the same label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with the same label) and 1 (full overlap allowed between two predicted objects with the same label). A low value will reduce the amount of falsely detected objects but may increase the number of missed objects. A high value will increase the number of falsely detected objects and reduce the number of missed objects.

Default value: 0.5

Remarks:

This parameter is also used to compute the matching between ground truth and predicted objects during evaluation.

This parameter can be changed before and after training.

◆ _ToolType__getter()

eVision.EasyDeepLearning.EDeepLearningToolType eVision.EasyDeepLearning.ELocator._ToolType__getter ( self )

protected

\cond

Type of the deep learning tool.

Reimplemented from eVision.EasyDeepLearning.EDeepLearningTool.

◆ GenerateAnchors() [1/2]

list[eVision._eVision.ESize] eVision.EasyDeepLearning.ELocator.GenerateAnchors	(		self,
		eVision.EasyDeepLearning.EDataset	dataset )

Generates anchors based on the objects in the dataset or a formal specification.

For the version that takes a dataset, the properties eVision.EasyDeepLearning.ELocatorBase.Width and eVision.EasyDeepLearning.ELocatorBase.Height must be set.

Remarks:

The dimension of an object corresponds to the square root of its area.

Parameters

dataset Dataset

◆ GenerateAnchors() [2/2]

list[eVision._eVision.ESize] eVision.EasyDeepLearning.ELocator.GenerateAnchors	(		self,
		float	minDimension,
		float	maxDimension,
		int	numSubScales,
		list[float]	aspectRatios )

Generates anchors based on the objects in the dataset or a formal specification.

For the version that takes a dataset, the properties eVision.EasyDeepLearning.ELocatorBase.Width and eVision.EasyDeepLearning.ELocatorBase.Height must be set.

Remarks:

The dimension of an object corresponds to the square root of its area.

Parameters

minDimension	Minimum dimension of objects (minimum value: 16)
maxDimension	Maximum dimension of objects.
numSubScales	Number of sub-scales to produce for each scale covered by the given dimensions.
aspectRatios	Aspect ratios to generate at each scale. The aspect ratios are the ratios between the width and height of the anchor. Recommended value: {1.0f, 0.5f, 2.0f}.

◆ SerializeSettings()

None eVision.EasyDeepLearning.ELocator.SerializeSettings	(		self,
		eVision.ESerializer \| None	serializer )

Serializes the settings of the locator.

Parameters

serializer Pointer to eVision.ESerializer

Reimplemented from eVision.EasyDeepLearning.ELocatorBase.

Property Documentation

◆ AbsoluteMaxOverlap

eVision.EasyDeepLearning.ELocator.AbsoluteMaxOverlap = property(_AbsoluteMaxOverlap__getter, _AbsoluteMaxOverlap__setter)

static

\endcond

Maximum overlap (intersection over union) between two predicted objects regardless of their label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with different labels) and 1 (full overlap allowed between two predicted objects with different labels).

Default value: 1.

Remarks:

This parameter can be changed before and after training.

◆ SameLabelMaxOverlap

eVision.EasyDeepLearning.ELocator.SameLabelMaxOverlap = property(_SameLabelMaxOverlap__getter, _SameLabelMaxOverlap__setter)

static

\endcond

Maximum overlap (intersection over union) between two predicted objects with the same label.

The value of the parameter must be between 0 (no overlap allowed between two predicted objects with the same label) and 1 (full overlap allowed between two predicted objects with the same label). A low value will reduce the amount of falsely detected objects but may increase the number of missed objects. A high value will increase the number of falsely detected objects and reduce the number of missed objects.

Default value: 0.5

Remarks:

This parameter is also used to compute the matching between ground truth and predicted objects during evaluation.

This parameter can be changed before and after training.

◆ ToolType

eVision.EasyDeepLearning.ELocator.ToolType = property(_ToolType__getter, None)

static

\endcond

Type of the deep learning tool.

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ _AbsoluteMaxOverlap__getter()

◆ _AbsoluteMaxOverlap__setter()

◆ _SameLabelMaxOverlap__getter()

◆ _SameLabelMaxOverlap__setter()

◆ _ToolType__getter()

◆ GenerateAnchors() [1/2]

◆ GenerateAnchors() [2/2]

◆ SerializeSettings()

Property Documentation

◆ AbsoluteMaxOverlap

◆ SameLabelMaxOverlap

◆ ToolType

◆ init() [1/2]

◆ init() [2/2]