Back to Aurora Vision Library website

You are here: Start » Function Reference » Point3DGrid » Point3DGrid Spatial Transforms » AlignPoint3DGridToPlane

AlignPoint3DGridToPlane


Header: AVL.h
Namespace: avl
Module: Vision3DLite

Rotates a grid of 3D points with a rotation that transforms the input plane to be parallel to XY plane.

Syntax

C++
C#
 
void avl::AlignPoint3DGridToPlane
(
	const avl::Point3DGrid& inGrid,
	const avl::Plane3D& inPlane,
	avl::Point3DGrid& outGrid,
	atl::Optional<avl::Matrix&> outTransform = atl::NIL,
	atl::Optional<avl::Matrix&> outInvertedTransform = atl::NIL
)

Parameters

Name Type Default Description
Input value inGrid const Point3DGrid&
Input value inPlane const Plane3D& The plane that determines rotation transform
Output value outGrid Point3DGrid&
Output value outTransform Optional<Matrix&> NIL Matrix of the transform used to align the input grid
Output value outInvertedTransform Optional<Matrix&> NIL Matrix of the transform rotating the output grid to the input one

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outTransform, outInvertedTransform.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite plane on input in AlignPoint3DGridToPlane.