Back to FabImage Library website

You are here: Start » Function Reference » Surface » Surface Features » SurfaceMultipleProfilesAlongAxis

SurfaceMultipleProfilesAlongAxis


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Creates the profiles of point Z values along X or Y axis.

Syntax

C++
C#
 
void fil::SurfaceMultipleProfilesAlongAxis
(
	const fil::Surface& inSurface,
	fil::Axis::Type inAxis,
	ftl::Optional<double> inCoordinateValueStart,
	ftl::Optional<double> inCoordinateValueEnd,
	ftl::Optional<double> inCoordinateValueStep,
	int inSmoothRadius,
	ftl::Optional<double> inProfileDomainStart,
	ftl::Optional<double> inProfileDomainEnd,
	ftl::Optional<int> inMaxInterpolationLength,
	float inDefaultValue,
	ftl::Array<fil::Profile>& outProfiles,
	ftl::Optional<ftl::Array<double>&> outCoordinateValues = ftl::NIL
)

Parameters

Name Type Range Default Description
Input value inSurface const Surface& Input surface
Input value inAxis Axis::Type Axis along which the profile is extracted
Input value inCoordinateValueStart Optional<double> NIL Determines the coordinate the first profile will be extracted from
Input value inCoordinateValueEnd Optional<double> NIL Limits the coordinate the last profile will be extracted from
Input value inCoordinateValueStep Optional<double> 0 - NIL Determines the distance between consecutive extracted profiles
Input value inSmoothRadius int 0 - Increases the number of neighbouring profiles taken into account extracting a single profile
Input value inProfileDomainStart Optional<double> NIL Minimal X coordinate of the output profiles
Input value inProfileDomainEnd Optional<double> NIL Maximal X coordinate of the output profiles
Input value inMaxInterpolationLength Optional<int> 0 - NIL Maximal number of consecutive not existing profile points to be interpolated
Input value inDefaultValue float Default value of the not existing and not interpolated surface point
Output value outProfiles Array<Profile>& The resulting profiles of the surface height
Output value outCoordinateValues Optional<Array<double>&> NIL The coordinates the output profiles were extracted from

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outCoordinateValues.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Coordinate value range exceeds input surface in SurfaceMultipleProfilesAlongAxis.
DomainError Incorrect output profile domain in SurfaceMultipleProfilesAlongAxis.
DomainError Non-positive coordinate value step in SurfaceMultipleProfilesAlongAxis.
DomainError Unknown axis type in SurfaceMultipleProfilesAlongAxis.