Back to Adaptive Vision Library website
You are here: Start » Function Reference » 1D Edge Detection 3D » AvsFilter_ScanSingleRidge3D
![](../../img/icon\ScanSingleRidge.png)
AvsFilter_ScanSingleRidge3D
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Locates the strongest high or low peak of surface height along a given path.
Header: | AVL.h |
---|
Syntax
void avs::AvsFilter_ScanSingleRidge3D ( ScanSingleRidge3DState& ioState, const avl::Surface& inSurface, const avl::Path& inScanPath, atl::Optional<const avl::CoordinateSystem2D&> inScanPathAlignment, int inScanWidth, avl::InterpolationMethod::Type inSurfaceInterpolation, const avl::RidgeScanParams3D& inRidgeScanParams, avl::Selection::Type inRidgeSelection, atl::Optional<const avl::LocalBlindness&> inLocalBlindness, atl::Optional<int> inMaxProfileGapWidth, atl::Conditional<avl::SurfaceRidge1D>& outRidge, atl::Optional<avl::Path&> outAlignedScanPath = atl::NIL, avl::Profile& diagHeightProfile, avl::Profile& diagResponseProfile )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | ScanSingleRidge3DState& | Object used to maintain state of the function. | |||
![]() |
inSurface | const Surface& | Input surface | ||
![]() |
inScanPath | const Path& | Path along which the scan is performed | ||
![]() |
inScanPathAlignment | Optional<const CoordinateSystem2D&> | NIL | Adjusts the scan path to the position of the inspected object | |
![]() |
inScanWidth | int | 1 - ![]() |
5 | Width of the scan field in pixels |
![]() |
inSurfaceInterpolation | InterpolationMethod::Type | Bilinear | Interpolation method used for extraction of surface points | |
![]() |
inRidgeScanParams | const RidgeScanParams3D& | RidgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5.0f RidgeMargin: 2.0f RidgeOperator: Minimum MinMagnitude: 5.0f RidgePolarity: Any ) | Parameters controlling the surface ridge extraction process | |
![]() |
inRidgeSelection | Selection::Type | Selection mode of the resulting ridge | ||
![]() |
inLocalBlindness | Optional<const LocalBlindness&> | NIL | Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges | |
![]() |
inMaxProfileGapWidth | Optional<int> | 0 - ![]() |
1 | Maximal number of consecutive not existing profile points |
![]() |
outRidge | Conditional<SurfaceRidge1D>& | Found surface ridge | ||
![]() |
outAlignedScanPath | Optional<Path&> | NIL | Path along which the scan is performed; in the image coordinate system | |
![]() |
diagHeightProfile | Profile& | Extracted surface height profile | ||
![]() |
diagResponseProfile | Profile& | Profile of the ridge operator response |