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

SurfaceSingleProfileAlongAxis

Header:	FIL.h
Namespace:	fil
Module:	Vision3DStandard

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

Syntax

void fil::SurfaceSingleProfileAlongAxis
(
	const fil::Surface& inSurface,
	fil::Axis::Type inAxis,
	double inCoordinateValue,
	int inSmoothRadius,
	ftl::Optional<double> inProfileDomainStart,
	ftl::Optional<double> inProfileDomainEnd,
	ftl::Optional<int> inMaxInterpolationLength,
	float inDefaultValue,
	fil::Profile& outProfile,
	ftl::Optional<double&> outCoordinateValue = ftl::NIL
)

Parameters

Name	Type	Range	Default	Description
inSurface	const Surface&			Input surface
inAxis	Axis::Type			Axis along which the profile is extracted
inCoordinateValue	double			Determines the coordinate the profile will be extracted from
inSmoothRadius	int	0 -		Increases the number of neighbouring profiles taken into account extracting a profile
inProfileDomainStart	Optional<double>		NIL	Minimal X coordinate of the output profile
inProfileDomainEnd	Optional<double>		NIL	Maximal X coordinate of the output profile
inMaxInterpolationLength	Optional<int>	0 -	NIL	Maximal number of consecutive not existing profile points to be interpolated
inDefaultValue	float			Default value of the not existing and not interpolated surface point
outProfile	Profile&			The resulting profile of the surface height
outCoordinateValue	Optional<double&>		NIL	The coordinate the output profile was extracted from

Optional Outputs

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Incorrect output profile domain in SurfaceSingleProfileAlongAxis.
DomainError	Input coordinate value exceeds surface in SurfaceSingleProfileAlongAxis.
DomainError	Unknown axis type in SurfaceSingleProfileAlongAxis.