You are here: Start » AVL.NET » Function Reference » Profile » Profile Features » AVL.ProfileRidges
Finds the high or low peaks in the input profile.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void ProfileRidges ( AvlNet.Profile inProfile, AvlNet.Range? inRange, bool inCyclic, AvlNet.RidgeScanParams inRidgeScanParams, float inMinDistance, float? inMaxDistance, AvlNet.LocalBlindness? inLocalBlindness, IList<AvlNet.ProfileRidge> outRidges, NullableRef<List<float>> outDistances, NullableRef<AvlNet.Profile> outResponseProfile )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inProfile | AvlNet.Profile | Input profile. | |||
inRange | AvlNet.Range? | ||||
inCyclic | bool | ||||
inRidgeScanParams | AvlNet.RidgeScanParams | RidgeScanParams ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5 RidgeMargin: 2 MinMagnitude: 5.0f RidgePolarity: Bright ) | Parameters controlling the ridge extraction process. Default value: RidgeScanParams ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5 RidgeMargin: 2 MinMagnitude: 5.0f RidgePolarity: Bright ). | ||
inMinDistance | float | <0.0f, INF> | 0.0f | Minimal distance between consecutive ridges. Default value: 0.0f. | |
inMaxDistance | float? | <0.0f, INF> | Maximal distance between consecutive ridges. Default value: atl::NIL. | ||
inLocalBlindness | AvlNet.LocalBlindness? | Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges. Default value: atl::NIL. | |||
outRidges | System.Collections.Generic.IList<AvlNet.ProfileRidge> | Found ridges. | |||
outDistances | AvlNet.NullableRef<System.Collections.Generic.List<float>> | Output distances between consecutive ridges. Can be null to skip this parameter calculation. | |||
outResponseProfile | AvlNet.NullableRef<AvlNet.Profile> | Profile of the ridge operator response. Can be null to skip this parameter calculation. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Range exceeds the input profile in ProfileRidges. |
Function Overrides
- ProfileRidges(Profile, Boolean, RidgeScanParams, Single, IList<ProfileRidge>)
- ProfileRidges(Profile, Nullable<Range>, Boolean, RidgeScanParams, Single, Nullable<Single>, Nullable<LocalBlindness>, IList<ProfileRidge>)
- ProfileRidges(Profile, Nullable<Range>, Boolean, RidgeScanParams, Single, Nullable<Single>, Nullable<LocalBlindness>, IList<ProfileRidge>, IList<Single>, Profile)