You are here: Start » FIL.NET » FIS.FisFilter_ScanSingleRidge3D Method

FIS.FisFilter_ScanSingleRidge3D Method

Locates the strongest high or low peak of surface height along a given path.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

public static void FisFilter_ScanSingleRidge3D
(
	FilNet.ScanMapState ioState,
	FilNet.Surface inSurface,
	FilNet.Path inScanPath,
	FilNet.CoordinateSystem2D? inScanPathAlignment,
	float? inSamplingStep,
	int inScanWidth,
	FilNet.InterpolationMethod inSurfaceInterpolation,
	FilNet.RidgeScanParams3D inRidgeScanParams,
	FilNet.Selection inRidgeSelection,
	FilNet.LocalBlindness? inLocalBlindness,
	int? inMaxProfileGapWidth,
	out FilNet.SurfaceRidge1D? outRidge,
	FilNet.Path outAlignedScanPath,
	FilNet.Profile diagHeightProfile,
	FilNet.Profile diagResponseProfile,
	IList<FilNet.Path> diagSamplingPoints,
	out float diagSamplingStep
)

Parameters

Name Type Range Default Description
ioStateFilNet.ScanMapState
inSurfaceFilNet.SurfaceInput surface.
inScanPathFilNet.PathPath along which the scan is performed.
inScanPathAlignmentFilNet.CoordinateSystem2D?Adjusts the scan path to the position of the inspected object. Default value: ftl::NIL.
inSamplingStepfloat?<0.0f, INF>Distance between consecutive sampling points on the scan path; if Nil, the bigger of surface X and Y scales is chosen. Default value: ftl::NIL.
inScanWidthint<1, INF>5Width of the scan field in pixels. Default value: 5.
inSurfaceInterpolationFilNet.InterpolationMethodBilinearInterpolation method used for extraction of surface points. Default value: Bilinear.
inRidgeScanParamsFilNet.RidgeScanParams3DRidgeScanParams3D ( 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. Default value: RidgeScanParams3D ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5.0f RidgeMargin: 2.0f RidgeOperator: Minimum MinMagnitude: 5.0f RidgePolarity: Any ).
inRidgeSelectionFilNet.SelectionSelection mode of the resulting ridge.
inLocalBlindnessFilNet.LocalBlindness?Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges. Default value: ftl::NIL.
inMaxProfileGapWidthint?<0, INF>1Maximal number of consecutive not existing profile points. Default value: 1.
outRidgeFilNet.SurfaceRidge1D?Found surface ridge.
outAlignedScanPathFilNet.PathPath along which the scan is performed; in the image coordinate system.
diagHeightProfileFilNet.ProfileExtracted surface height profile.
diagResponseProfileFilNet.ProfileProfile of the ridge operator response.
diagSamplingPointsSystem.Collections.Generic.IList<FilNet.Path>Array of paths each one containing the sampling points that contributed to a single value of the extracted profile; in the image coordinate system.
diagSamplingStepfloatUsed distance between consecutive sampling points on the scan path.

Function Overrides

See also