Back to Aurora Vision Studio website

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

SurfaceSingleProfileAlongAxis

Advanced

Module: Vision3DStandard

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

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

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

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.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of SurfaceProfileAlongAxis filter group.