Back to Adaptive Vision Studio website

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

SurfaceMultipleProfilesAlongAxis


Module: Vision3DStandard

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

Name Type Range Description
inSurface Surface Input surface
inAxis Axis Axis along which the profile is extracted
inCoordinateValueStart Double* Determines the coordinate the first profile will be extracted from
inCoordinateValueEnd Double* Limits the coordinate the last profile will be extracted from
inCoordinateValueStep Double* Determines the distance between consecutive extracted profiles
inSmoothRadius Integer 0 - Increases the number of neighbouring profiles taken into account extracting a single profile
inProfileDomainStart Double* Minimal X coordinate of the output profiles
inProfileDomainEnd Double* Maximal X coordinate of the output profiles
inMaxInterpolationLength Integer* 0 - Maximal number of consecutive not existing profile points to be interpolated
inDefaultValue Real Default value of the not existing and not interpolated surface point
outProfiles ProfileArray The resulting profiles of the surface height
outCoordinateValues DoubleArray The coordinates the output profiles were 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 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.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of SurfaceProfileAlongAxis filter group.