Back to FabImage Library website

You are here: Start » Function Reference » Point3DGrid Basics » MakePoint3DGridFromImage

MakePoint3DGridFromImage


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header:FIL.h
Namespace:fil

Creates a Point3DGrid structure from coordinates encoded in pixels of a 3 channel image.

Syntax

void fil::MakePoint3DGridFromImage
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	double inXOffset,
	double inXScale,
	double inYOffset,
	double inYScale,
	double inZOffset,
	double inZScale,
	fil::Point3DGrid& outPoint3DGrid
)

Parameters

Name Type Range Default Description
inImage const Image& Source 3 channel image with per pixel encoded XYZ coordinates
inRoi Optional<const Region&> NIL Region determining valid points in resulting point grid
inXOffset double 0.0D
inXScale double - - + 1.0D
inYOffset double 0.0D
inYScale double - - + 1.0D
inZOffset double 0.0D
inZScale double - - + 1.0D
outPoint3DGrid Point3DGrid&

Requirements

For input inImage only pixel formats are supported: 3⨯uint8, 3⨯int8, 3⨯uint16, 3⨯int16, 3⨯int32, 3⨯real.

Read more about pixel formats in Image documentation.

Errors

List of possible exceptions:

Error type Description
DomainError Not a 3 channel image on input of MakePoint3DGridFromImage.
DomainError Not supported inImage pixel format in MakePoint3DGridFromImage.