You are here: Start » FIL.NET » Invoke.ScanSingleRidge3D_Direct

Invoke.ScanSingleRidge3D_Direct

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

Namespace:Fil
Assembly:FilNet.dll

Syntax

C++
C#
 
public static void ScanSingleRidge3D_Direct
(
	Fil.Surface inSurface,
	Fil.Path inScanPath,
	Optional<Fil.CoordinateSystem2D> inScanPathAlignment,
	Optional<float> inSamplingStep,
	int inScanWidth,
	Fil.InterpolationMethod inSurfaceInterpolation,
	Fil.RidgeScanParams3D inRidgeScanParams,
	Fil.Selection inRidgeSelection,
	Optional<Fil.LocalBlindness> inLocalBlindness,
	Optional<int> inMaxProfileGapWidth,
	Conditional<Fil.SurfaceRidge1D> outRidge,
	Optional<Fil.Path> outAlignedScanPath,
	Optional<Fil.Profile> outHeightProfile,
	Optional<Fil.Profile> outResponseProfile,
	Diagnostic<List<Fil.Path>> diagSamplingPoints,
	Diagnostic<float> diagSamplingStep
)

Parameters

Name Type Range Default Description
inSurfaceFil.SurfaceInput surface.
inScanPathFil.PathPath along which the scan is performed.
inScanPathAlignmentFtl.Optional<Fil.CoordinateSystem2D>Adjusts the scan path to the position of the inspected object. Default value: ftl::NIL.
inSamplingStepFtl.Optional<float><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.
inSurfaceInterpolationFil.InterpolationMethodBilinearInterpolation method used for extraction of surface points. Default value: Bilinear.
inRidgeScanParamsFil.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 ).
inRidgeSelectionFil.SelectionSelection mode of the resulting ridge.
inLocalBlindnessFtl.Optional<Fil.LocalBlindness>Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges. Default value: ftl::NIL.
inMaxProfileGapWidthFtl.Optional<int><0, INF>1Maximal number of consecutive not existing profile points. Default value: 1.
outRidgeFtl.Conditional<Fil.SurfaceRidge1D>Found surface ridge.
outAlignedScanPathFtl.Optional<Fil.Path>Path along which the scan is performed; in the image coordinate system.
outHeightProfileFtl.Optional<Fil.Profile>Extracted surface height profile.
outResponseProfileFtl.Optional<Fil.Profile>Profile of the ridge operator response.
diagSamplingPointsFil.Diagnostic<System.Collections.Generic.List<Fil.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.
diagSamplingStepFil.Diagnostic<float>Used distance between consecutive sampling points on the scan path.

See also