DeepLearning_LocatePoints

Header:	AVLDL.h
Namespace:	avl

Performs points localization using a trained deep-learning model.

Syntax

void avl::DeepLearning_LocatePoints
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	const avl::DeepModel_PointLocation& inDeepModel,
	const float inMinDetectionScore,
	const atl::Optional<float>& inMinDistanceRatio,
	const bool inOverlap,
	atl::Array<avl::Location>& outLocations,
	atl::Array<int>& outClassIds,
	atl::Array<atl::String>& outClassNames,
	atl::Array<float>& outScores
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRoi	Optional<const Region&>		NIL	Area of interest
inDeepModel	const DeepModel_PointLocation&			Trained model
inMinDetectionScore	const float	0.0 - 1.0	0.5f	Minimal score of found points
inMinDistanceRatio	const Optional<float>&	0.01 - 1.0	NIL	Minimal distance between found points defined as portion of Feature Size
inOverlap	const bool		True	Add tiles overlapping to improve results quality
outLocations	Array<Location>&			Locations of found points
outClassIds	Array<int>&			Ids of found point classes
outClassNames	Array<String>&			Names of found point classes
outScores	Array<float>&			Scores of found points

Requirements

For input inImage only pixel formats are supported: 1⨯uint8, 3⨯uint8.

Read more about pixel formats in Image documentation.

Hints

Loading Deep Learning Model may take longer timer. Consider using DeepLearning_LoadModel_PointLocation for pre-loading model before execution starts.

Remarks

Model provided on inDeepModel input will be loaded automatically on first usage of this filter.
This filter should not be executed along with running Deep Learning Service as it may result in degraded performance or even out-of-memory errors. However, if stopping Deep Learning Service is not an option (e.g. program uses other Deep Learning filters related to Anomaly Detection or Instances Segmentation) it is advised that this filter should be executed before other Deep Learning filters. Such "warm up" execution does not have to use real image or roi as long as provided image and roi have similar size.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

Errors

List of possible exceptions:

Error type	Description
DomainError	Not supported inImage pixel format in DeepLearning_LocatePoints.