Skip to main content

RegionGrowSegmentationParams

Parameters

Parameters for region growing segmentation.

Import​

import ScriptingApi as api

# Create parameter instance
params = api.RegionGrowSegmentationParams()

Properties​

source_mask_name​

Source mask on which the segmentation will be performed.

Type: str

target_mask_name​

Target mask name. If empty, a new mask will be created.

Type: str

seeds​

List of seed points in world coordinates [x, y, z].

Type: list

keep_original_mask​

Keep the original source mask unchanged. If True, the source mask won't be modified in any case, but if False, the source mask will be modified by removing the segmented voxels from it.

Type: bool

multiple_layer​

Apply region growing to all slices (3D). If False, only applies to specified slice.

Type: bool

connectivity​

Connectivity type. Use api.VoxelConnectivity.Connectivity6 for face neighbours only, or api.VoxelConnectivity.Connectivity26 for all neighbours.

Type: VoxelConnectivity

slice_plane​

Target slice plane index (0=YZ, 1=XZ, 2=XY). Only used when multipleLayer=False.

Type: int

slice_index​

Slice index in the specified plane. Only used when multipleLayer=False.

Type: int

replace_result​

Replace the target mask content. If False, merges with existing mask.

Type: bool

See Also​