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

SurfaceMultipleProfilesAlongAxis

Header:	AVL.h
Namespace:	avl
Module:	Vision3DStandard

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

Syntax

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

Parameters

Name	Type	Range	Default	Description
inSurface	const Surface&			Input surface
inAxis	Axis::Type			Axis along which the profile is extracted
inCoordinateValueStart	Optional<double>		NIL	Determines the coordinate the first profile will be extracted from
inCoordinateValueEnd	Optional<double>		NIL	Limits the coordinate the last profile will be extracted from
inCoordinateValueStep	Optional<double>	0 -	NIL	Determines the distance between consecutive extracted profiles
inSmoothRadius	int	0 -		Increases the number of neighbouring profiles taken into account extracting a single profile
inProfileDomainStart	Optional<double>		NIL	Minimal X coordinate of the output profiles
inProfileDomainEnd	Optional<double>		NIL	Maximal X coordinate of the output profiles
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
outProfiles	Array<Profile>&			The resulting profiles of the surface height
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 atl::NIL to these parameters: outCoordinateValues.

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.