Skip to main content

VoidInclusionParams

Other

Parameters for void/inclusion analysis. Configures the void and inclusion detection algorithm with preprocessing and filtering options.

Import​

import ScriptingApi as api

# Create parameter instance
params = api.VoidInclusionParams()

Properties​

mode​

Target defect type to detect (void or inclusion). Use api.VoidInclusionTargetType.Void

Type: VoidInclusionTargetType

method​

Detection method (absolute or relative contrast). Use api.VoidInclusionMethod.Absolute

Type: VoidInclusionMethod

auto_absolute_contrast​

Automatically estimate absolute contrast from data instead of using a fixed value.

Type: bool

absolute_contrast​

Contrast difference (Hounsfield units) between background and target when auto is disabled.

Type: float

auto_air_gray_value​

Automatically estimate air/background gray value instead of using a fixed value.

Type: bool

air_gray_value​

Air/background gray value (Hounsfield units) used when auto estimation is disabled.

Type: float

relative_contrast_percent​

Relative contrast percentage used when the relative detection method is selected.

Type: float

requested_statistics​

Statistic names to compute for each detected component; empty uses application defaults. Available values: "Voxel count", "Volume (mm³)", "Volume fraction (%)", "Surface area (mm²)", "Centroid X (mm)", "Centroid Y (mm)", "Centroid Z (mm)", "Feret diameter (mm)", "Equivalent diameter (mm)", "Equivalent ellipsoid diameter (mm)", "Circumsphere diameter (mm)", "Gap (sphere) (mm)", "Equivalent spherical surface area (mm²)", "Border voxel count", "Surface area on border (mm²)", "Surface area on border ratio", "Sphericity", "Compactness", "Elongation", "Flatness", "Shape factor", "Box origin X (mm)", "Box origin Y (mm)", "Box origin Z (mm)", "Diameter X (mm)", "Diameter Y (mm)", "Diameter Z (mm)", "Orientation angle to X-axis (deg)", "Orientation angle to Y-axis (deg)", "Orientation angle to Z-axis (deg)", "Principal X moments", "Principal Y moments", "Principal Z moments", "Principal axis X", "Principal axis Y", "Principal axis Z", "PCA deviation 1", "PCA deviation 2", "PCA deviation 3", "PCA max. deviation ratio", "PCA min. deviation ratio", "Projected size X (mm)", "Projected size Y (mm)", "Projected size Z (mm)", "Projected area YZ (mm²)", "Projected area XZ (mm²)", "Projected area XY (mm²)", "Min. gray value", "Max. gray value", "Mean gray value", "Median gray value", "Std. dev. of gray values", "5% quantile value", "25% quantile value", "50% quantile value", "75% quantile value", "95% quantile value", "Grayvalues", "Number of pixels".

Type: list

filter_result_params​

Filtering configuration applied to detected components. Use api.VoidInclusionFilteringParams()

Type: VoidInclusionFilteringParams

See Also​