SurfaceDeterminationEstimate
Result of estimate_surface_determination. Fields that could not be resolved keep their validity flag false; their numbers are then not meaningful.
Import
import ScriptingApi as api
# Access the class
# SurfaceDeterminationEstimate is available via api.SurfaceDeterminationEstimate
Properties
valid
True when the settings resolve and a determination can run.
Type: bool
status
Outcome name: Success, NoSurface, Cancelled, InvalidInput, InvalidEstimate, ResourceLimit.
Type: str
message
Explanation when valid is false.
Type: str
iso_value
Resolved global isovalue.
Type: float
materials_valid
True when background and material gray values are available.
Type: bool
background_gray_value
Estimated or supplied background gray value.
Type: float
material_gray_value
Estimated or supplied material gray value.
Type: float
background_sigma
Standard deviation of the background population (estimated materials only).
Type: float
material_sigma
Standard deviation of the material population (estimated materials only).
Type: float
separation
(material - background) / (backgroundSigma + materialSigma), 0 when unavailable.
Type: float
background_clipped
True when the background mode sits in the first histogram bin (possible clipping).
Type: bool
material_clipped
True when the material mode sits in the last histogram bin (possible clipping).
Type: bool
search_distance_valid
True when a search distance is resolved (advanced method only).
Type: bool
search_distance_voxels
Resolved search distance in voxel units.
Type: float
search_distance_physical
Resolved search distance in physical units.
Type: float
edge_width_voxels
Median 16 to 84 percent edge width in voxel units (automatic search distance only).
Type: float
sampled_crossings
Initial crossings sampled for the edge width.
Type: int
valid_widths
Crossings that yielded a usable width.
Type: int
voxel_unit
Voxel unit h = min(spacing) in physical units.
Type: float