Back to Aurora Vision Library website
You are here: Start » Function Reference » Surface » Surface Features » SurfaceSingleProfileAlongAxis
SurfaceSingleProfileAlongAxis
Header: | AVL.h |
---|---|
Namespace: | avl |
Module: | Vision3DStandard |
Creates the profile of point Z values along X or Y axis.
Syntax
C++
C#
void avl::SurfaceSingleProfileAlongAxis ( const avl::Surface& inSurface, avl::Axis::Type inAxis, double inCoordinateValue, int inSmoothRadius, atl::Optional<double> inProfileDomainStart, atl::Optional<double> inProfileDomainEnd, atl::Optional<int> inMaxInterpolationLength, float inDefaultValue, avl::Profile& outProfile, atl::Optional<double&> outCoordinateValue = atl::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 atl::NIL
to these parameters: outCoordinateValue.
Read more about Optional Outputs.
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. |