Skip to main content

ExtremaParams

Other

Parameters for extrema analysis. Configures the extrema point detection algorithm.

Import

import ScriptingApi as api

# Create parameter instance
params = api.ExtremaParams()

Properties

mask_preview_quality

Mesh quality preset used to generate preview geometry for mask inputs. Use api.MaskPreviewQuality.Optimal

Type: MaskPreviewQuality


method

Extrema computation method. Use api.ExtremaMethod.MaximumAndMinimum. Maximum: Identifies absolute and local maxima on the surface, highlighting peak regions with convex (hill‑like) curvature. Minimum: Identifies absolute and local minima on the surface, emphasizing valley regions with concave (alley‑like) curvature. Maximum and Minimum: Combines both analyses, detecting all peak and valley features across the surface for a comprehensive curvature evaluation.

Type: ExtremaMethod


axis

Direction vector [x, y, z] used when computing directional extrema. Select the axis used for caliper assignment. You can choose a principal axis (e.g., X, Y, Z) or a custom direction vector to guide caliper placement for dimensional or curvature analysis.

Type: list


See Also