Back to FabImage Library website
You are here: Start » Function Reference » Computer Vision » 1D Edge Detection 3D » ScanSingleRidge3D
ScanSingleRidge3D
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | Vision3DStandard |
Locates the strongest high or low peak of surface height along a given path.
Syntax
C++
C#
void fil::ScanSingleRidge3D ( const fil::Surface& inSurface, const fil::ScanMap& inScanMap, const fil::RidgeScanParams3D& inRidgeScanParams, fil::Selection::Type inRidgeSelection, ftl::Optional<const fil::LocalBlindness&> inLocalBlindness, ftl::Optional<int> inMaxProfileGapWidth, ftl::Conditional<fil::SurfaceRidge1D>& outRidge, ftl::Optional<fil::Profile&> outHeightProfile = ftl::NIL, ftl::Optional<fil::Profile&> outResponseProfile = ftl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | const Surface& | Input surface | |||
inScanMap | const ScanMap& | Data precomputed with CreateSurfaceScanMap | |||
inRidgeScanParams | const RidgeScanParams3D& | Parameters controlling the surface ridge extraction process | |||
inRidgeSelection | Selection::Type | Selection::Best | 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 | |||
outHeightProfile | Optional<Profile&> | NIL | Extracted surface height profile | ||
outResponseProfile | Optional<Profile&> | NIL | Profile of the ridge operator response |
Optional Outputs
The computation of following outputs can be switched off by passing value ftl::NIL
to these parameters: outHeightProfile, outResponseProfile.
Read more about Optional Outputs.