Skip to main content

SurfaceDeterminationParams

Parameters

Parameters of the Surface Determination tool. The same settings drive the interface panel and the scripting method.

Import​

import ScriptingApi as api

# Create parameter instance
params = api.SurfaceDeterminationParams()

Properties​

target_mask_name​

Name of the mask to replace. Empty creates a new mask. Multi-label masks are not accepted.

Type: str

method​

Surface determination method. Use api.SurfaceDeterminationMethod.Iso50 or another member.

Type: SurfaceDeterminationMethod

starting_method​

Global surface the advanced method starts from. Use api.SurfaceDeterminationStartingMethod.Iso50 or another member.

Type: SurfaceDeterminationStartingMethod

iso_value​

Isovalue of the Manual method and of the Manual starting method.

Type: float

automatic_materials​

True to estimate the background and material gray values from the histogram; false to use the supplied values.

Type: bool

background_gray_value​

Background gray value when automaticMaterials is false. Zero and negative values are valid levels.

Type: float

material_gray_value​

Material gray value when automaticMaterials is false. Must be above the background gray value.

Type: float

level_percent​

Level between the background (0) and the material (100) gray value, strictly between 0 and 100. 50 is ISO50.

Type: float

histogram_method​

Histogram threshold calculator of the HistogramMethod method and starting method. Use api.HistogramThresholdMethod.Otsu or another member.

Type: HistogramThresholdMethod

edge_criterion​

Edge position criterion of the advanced method. Use api.SurfaceEdgeCriterion.MaximumGradient or LocalLevel.

Type: SurfaceEdgeCriterion

automatic_search_distance​

True to derive the search distance from the measured edge width; false to use searchDistanceVoxels.

Type: bool

search_distance_voxels​

Search distance of the advanced method in voxel units (multiples of the smallest spacing), 1.5 to 6.

Type: float

profile_smoothing_sigma_voxels​

Gaussian smoothing of the gray value profiles in voxel units, 0 disables it.

Type: float

See Also​