Back to FabImage Library website

You are here: Start » Function Reference » Point3DGrid » Point3DGrid Fitting » Point3DGridDistance

Point3DGridDistance


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Computes distances between two input grids.

Syntax

C++
C#
 
void fil::Point3DGridDistance
(
	const fil::Point3DGrid& inReference,
	const fil::Point3DGrid& inCompare,
	ftl::Optional<const fil::Region&> inRoi,
	const float inThreshold,
	ftl::Array<fil::Point3D>& outCorrectPoints,
	ftl::Array<fil::Point3D>& outIncorrectPoints,
	float& outMaxDistance,
	float& outMinDistance,
	ftl::Array<float>& outDistances
)

Parameters

Name Type Range Default Description
Input value inReference const Point3DGrid& Reference grid
Input value inCompare const Point3DGrid& Data points for which the distances will be computed.
Input value inRoi Optional<const Region&> NIL Range of points for which the distance will be computed.
Input value inThreshold const float 0.0 - Defines for each data point a maximum allowed distance to the reference grid.
Output value outCorrectPoints Array<Point3D>& All data points with distance to the reference grid smaller that the given threshold
Output value outIncorrectPoints Array<Point3D>& All data points with distance to reference grid greater that the given threshold
Output value outMaxDistance float& Maximum computed distance
Output value outMinDistance float& Minimum computed distance
Output value outDistances Array<float>& All computed distances

Errors

List of possible exceptions:

Error type Description
DomainError Input point array is empty in Point3DGridDistance.
DomainError Region of interest exceeds an input Point3DGrid in Point3DGridDistance.