AiSegmentation
High-level interface for AI-powered image segmentation.
AiSegmentationModelType
AI segmentation model families supported by the scripting API.
TotalSegmentatorParams
Configuration parameters for TotalSegmentator AI model.
NnUnetParams
Configuration parameters for nnU-Net AI model.
MonaiParams
Configuration parameters for MONAI bundle AI model.
CellposeParams
Configuration parameters for Cellpose-SAM AI model.
AnalysisOperations
Provides tools for creating, running, and managing analysis objects.
AnalysisType
- WallThicknessSurface: Wall-thickness analysis generated from a surface object.
WallThicknessMethod
Methods for wall thickness analysis computation.
DeviationMethod
Methods for deviation analysis computation.
CurvatureMethod
Methods for curvature analysis computation.
ExtremaMethod
Methods for extrema analysis computation.
LookupTableType
Types of lookup tables for analysis visualization.
MaskPreviewQuality
Quality presets for mask-based analysis surface generation.
VoidInclusionTargetType
Target types for void/inclusion analysis.
VoidInclusionMethod
Method types for void/inclusion contrast thresholding.
AnalysisInfo
Basic information about an analysis object.
WallThicknessAnalysisStatistics
Statistics for wall thickness analyses.
WallThicknessSample
A single wall thickness sample.
WallThicknessAnalysisResults
Results for wall thickness analyses (mask or surface based).
DeviationAnalysisStatistics
Statistics for deviation analyses.
DeviationSample
A single actual-surface vertex deviation sample.
DeviationAnalysisResults
Results for deviation analyses (mask-mask, surface-surface, mask-surface).
CurvatureAnalysisStatistics
Statistics for curvature analyses.
CurvatureSample
A single curvature sample.
CurvatureAnalysisResults
Results for curvature analyses (mask or surface based).
ExtremaAnalysisStatistics
Statistics for extrema analyses.
ExtremaSample
A single extrema sample.
ExtremaAnalysisResults
Results for extrema analyses (mask or surface based).
GrayValueAnalysisStatistics
Statistics for gray value analyses.
GrayValueSample
A single gray value sample.
GrayValueAnalysisResults
Results for gray value analyses (mask or surface based).
AnalysisDisplaySettings
Visual settings for analysis result display.
WallThicknessParams
Parameters for wall thickness analysis.
DeviationParams
Parameters for deviation analysis.
CurvatureParams
Parameters for curvature analysis.
ExtremaParams
Parameters for extrema analysis.
GrayValueParams
Parameters for gray value analysis.
VoidInclusionFilteringParams
Filtering parameters for void/inclusion analysis.
VoidInclusionParams
Parameters for void/inclusion analysis.
VoidInclusionStatistic
Statistic values computed for a single metric.
VoidInclusionLabelStatistics
Statistics for an individual detected component/label.
VoidInclusionDescriptiveStatistic
Descriptive statistics calculated across all labels for a metric.
CaptionMeasurement
Caption measurement result containing position and gray value.
VoidInclusionWholeMaskStatistic
Aggregate statistics computed for the whole mask.
VoidInclusionResults
Results from void/inclusion analysis.
Image2D
Represents a 2D image as raw byte data along with its dimensions and format.
VolumeUint8
Represents a 3D image where voxel data is stored as 8-bit unsigned integers (uint8), including its dimensions, physical origin, and voxel spacing.
VolumeInt16
Represents a 3D image where voxel data is stored as 16-bit signed integers (int16), including its dimensions, physical origin, and voxel spacing.
VolumeUint16
Represents a 3D image where voxel data is stored as 16-bit unsigned integers (uint16), including its dimensions, physical origin, and voxel spacing.
VolumeFloat32
Represents a 3D image where voxel data is stored as 32-bit floating-point numbers (float32), including its dimensions, physical origin, and voxel spacing.
MaskUint8
Represents a 3D mask image where voxel data is stored as 8-bit unsigned integers (uint8), including its dimensions, physical origin, and voxel spacing.
MaskUint16
Represents a 3D mask image where voxel data is stored as 16-bit unsigned integers (uint16), including its dimensions, physical origin, and voxel spacing.
SurfaceGeometryData
Represents a surface mesh using vertex positions, triangle cells, and optional RGB color arrays.
VolumeMeshGeometryData
Represents a volume mesh using vertex positions, flat cell connectivity, and optional RGB color arrays.
MsgBoxLevel
Message levels for the message box.
MsgBoxSuppression
Suppression modes for the message boxes shown by the application.
Mask3dPreviewQuality
Quality levels for 3D mask previews.
VoxelConnectivity
Voxel connectivity used when regions, islands or cavities are identified.
SnapshotType
individual 2D slice views.
Application
The root application class for the Scripting API.
FemOperations
Provides tools for managing Finite Element Model (FEM) data on volume meshes.
FemExportFormat
FEM export formats supported by the FemOperations class.
FemMaterialModel
FEM material model types.
FemSectionType
FEM element section types.
FemIntegrationScheme
FEM integration scheme types.
FemSetSource
Indicates how a node set, element set, or surface was created.
FemSurfaceType
Intended role of an FEM surface.
FemMaterialPreset
Material preset types for quick material creation.
FemMechanicalProperties
Mechanical properties for FEM materials.
FemThermalProperties
Thermal properties for FEM materials.
FemMaterialParams
Parameters for creating or updating an FEM material.
FemSolidSectionParams
Solid section properties for 3D elements.
FemShellSectionParams
Shell section properties for 2D elements.
SurfaceSmoothAlgorithm
Smooth algorithms for surface smoothing operations.
FemPartParams
Parameters for creating or updating an FEM part.
FemNodeSetParams
Parameters for creating an FEM node set.
FemElementSetParams
Parameters for creating an FEM element set.
FemSurfaceParams
Parameters for creating an FEM surface.
FemExportOptions
Common export options for all FEM formats.
FemAbaqusExportOptions
Abaqus-specific export options.
FemNastranExportOptions
Nastran-specific export options.
FemLsDynaExportOptions
LS-DYNA-specific export options.
FemOpenFOAMExportOptions
OpenFOAM-specific export options.
FemFluentExportOptions
Fluent-specific export options.
FemGmshExportOptions
Gmsh-specific export options.
FemExportResult
Result from FEM export operation.
FemModelStatistics
Statistics about an FEM model.
SurfaceSmoothParams
Parameters for surface smooth operations.
FemMaterialInfo
Information about a material in the FEM model.
FemPartInfo
Information about a part in the FEM model.
FemNodeSetInfo
Information about a node set in the FEM model.
FemElementSetInfo
Information about an element set in the FEM model.
FemSurfaceInfo
Information about a surface in the FEM model.
MaskOperations
Provides tools for creating, editing, and analyzing 3D mask objects.
MorphologicalOperationType
Defines morphological operation types for mask processing.
BooleanOperation
Defines boolean operation types for combining two masks.
InterpolationAxis
Defines interpolation axis for 3D mask interpolation.
HollowShellMode
Defines shell modes for hollow mask operation.
SurfaceDeterminationMethod
Method the Surface Determination tool uses to place the surface.
SurfaceDeterminationStartingMethod
Global surface the advanced surface determination starts from.
SurfaceEdgeCriterion
Edge position criterion of the advanced surface determination.
HistogramThresholdMethod
Histogram threshold calculators of the surface determination.
MaskLabelInfo
Represents information about a mask label.
MaskToSurfaceParams
Parameters used when converting masks to surface objects (and generating mask previews).
ThresholdParams
Parameters for range-based threshold segmentation.
RegionGrowSegmentationParams
Parameters for region growing segmentation.
DynamicRegionGrowConnectivitySegmentationParams
Parameters for dynamic region growing using connectivity method.
DynamicRegionGrowThresholdSegmentationParams
Parameters for dynamic region growing using threshold method.
GrowCutSegmentationParams
Parameters for GrowCut segmentation.
VoidInclusionSegmentationParams
Parameters for void/inclusion segmentation.
SurfaceDeterminationParams
Parameters of the Surface Determination tool.
SurfaceDeterminationEstimate
Result of estimate_surface_determination.
MaskRenderPropertiesOperations
Provides an interface for managing render properties of 3D mask objects.
MeasurementOperations
Provides tools for creating, editing, and analyzing 3D measurement objects.
MeasurementType
Measurement object types.
MeasurementAnnotationType
Representation types for measurement annotations.
MeasurementData
Measurement data containing name, visibility, lock status, and point coordinates.
MeasurementProperties
User-configurable measurement appearance and type-specific editing properties.
PointMeasurement
Point measurement result containing position and gray value.
DistanceMeasurement
Distance measurement result containing two endpoints and the distance.
AngleMeasurement
Angle measurement result containing three points and the angle.
DiameterMeasurement
Diameter measurement result containing points, diameter, and centroid.
ContourMeasurement
Contour measurement result containing points, area, perimeter, and centroid.
CircleMeasurement
Circle measurement result containing diameter and centroid.
EllipseMeasurement
Ellipse measurement result containing axes, area, perimeter, and eccentricity.
RectangleMeasurement
Rectangle measurement result containing dimensions, area, perimeter, and centroid.
BoxMeasurement
Box measurement result containing dimensions, volume, perimeter, and centroid.
AnnotationMeasurement
Annotation measurement result containing position and gray value.
MeasureOperations
Provides tools for statistical analysis and measurement operations on volume, mask, surface, and mesh objects.
VolumeStatisticsTarget
Target scope for volume statistics computation.
SliceMode
Slice selection mode for statistics computation.
HistogramYAxisMode
Histogram Y-axis mode for visualization.
HistogramGraphType
Histogram graph type for visualization.
PrimitiveFittingSource
Primitive fitting input source types.
GrayscaleStatisticType
Grayscale statistic types for volume and mask statistics.
LabelStatisticType
Label statistic types for mask shape and region statistics.
SurfaceMeshStatisticType
Surface mesh statistic types.
VolumeMeshStatisticType
Volume mesh statistic types.
SurfaceMeshQualityMetric
Surface mesh quality metric types.
VolumeMeshQualityMetric
Volume mesh quality metric types.
PrimitiveFittingType
Primitive fitting types.
VolumeStatisticsParams
Parameters for volume statistics computation.
VolumeStatisticsResult
Results from volume statistics computation.
VolumeSimilarityResult
Results from volume similarity statistics computation.
MaskLabelStatistics
Statistics for a single label/region in a mask.
MaskStatisticsResult
Results from mask statistics computation.
MaskComparisonLabelStatistics
Statistics for comparing two labels between masks.
MaskComparisonResult
Results from mask comparison (overlap statistics).
PrimitiveFittingParams
Parameters for primitive fitting operation.
SurfaceMeshStatistics
Statistics for a single surface mesh or region.
SurfaceMeshStatisticsResult
Results from surface mesh statistics computation.
VolumeMeshStatistics
Statistics for a single volume mesh.
VolumeMeshStatisticsResult
Results from volume mesh statistics computation.
QualityMetricStatistics
Quality metric statistics (min, max, mean, stddev).
SurfaceMeshQualityResult
Results from surface mesh quality analysis.
VolumeMeshQualityResult
Results from volume mesh quality analysis.
PrimitiveFittingResult
Results from primitive fitting operation.
PrimitiveMeasurementResult
Results from measurement between two primitives.
HistogramParams
Parameters for histogram generation.
HistogramResult
Results from histogram generation.
OperationLogOperations
Reads the recorded history of what happened in the application.
LogSource
Which recorded history a listing or an export names.
LogExportFormat
Which file an export writes.
LogPreset
The question a listing is asking, matching the presets of the Operation Log dock.
LogFilter
How a listing is narrowed, matching the controls of the Operation Log dock.
LogEntry
One listed action, which is one row of the Operation Log.
LogListing
What a caller holds between the pages of one listing.
LogStatus
What the recorded history can say about history it no longer holds.
PreferencesOperations
Provides scripting access to the application preferences.
HighDpiScaleFactorRoundingMode
Scale factor rounding modes for high-resolution displays.
ApplicationFontSize
Application font size presets.
UndoStorageLocation
Storage locations for undo history.
ProjectFileCompressionLevel
Project save compression presets.
ImageInterpolationMethod
Image interpolation methods used during resampling.
SurfaceExtractionAlgorithm
Surface extraction methods used for each label when building a multilabel mask 3D preview.
UserInterfaceOptions
Snapshot of the User Interface preference values.
GeneralOptions
Snapshot of the General preference values.
RenderingOptions
Snapshot of the Rendering preference values.
View3dOptions
Snapshot of the 3D View preference values.
View2dOptions
Snapshot of the 2D View preference values.
CadFileImportOptions
CAD import preference values.
ImportOptions
Snapshot of the Import preference values.
PrimitiveOperations
Provides tools for creating, editing, and managing 3D primitive objects (ROIs).
PrimitiveType
- Line: A cylinder connecting two points.
SplineMode
Spline mode types for PrimitiveSpline.
PrimitiveData
Primitive data containing name, visibility, lock status, and geometric properties.
PrimitiveDisplayProperties
Common display properties for primitive objects.
PrimitiveProperties
User-configurable primitive appearance and type-specific geometry properties.
PointPrimitive
Properties for point primitives.
CirclePrimitive
Properties for circle primitives.
SpherePrimitive
Properties for sphere primitives.
EllipsoidPrimitive
Properties for ellipsoid primitives.
LinePrimitive
Properties for line primitives (also used for cylinder, capsule, tube, cone, arrow).
CylinderPrimitive
Properties for cylinder primitives.
CapsulePrimitive
Properties for capsule primitives.
TubePrimitive
Properties for tube primitives.
ConePrimitive
Properties for cone primitives.
ArrowPrimitive
Properties for arrow primitives.
PlanePrimitive
Properties for plane primitives.
CubePrimitive
Properties for cube primitives.
CuboidPrimitive
Properties for cuboid primitives.
SplinePrimitive
Properties for spline primitives.
RegistrationOperations
Provides global and landmark registration operations for aligning project objects.
GlobalRegistrationObjectType
Object types for global registration operations.
GlobalRegistrationSurfaceAlgorithm
Surface registration algorithms for global registration.
GlobalRegistrationImageAlgorithm
Image registration algorithms for global registration (volume-to-volume).
GlobalRegistrationMode
Global registration transformation mode for surface (ICP) registration.
GlobalRegistrationObject
Identifies a project object by name and type for global registration.
PointMatchingParams
Parameters for point matching (ICP) surface registration algorithm.
FeatureMatchingParams
Parameters for feature matching surface registration algorithm.
PointPlusFeatureMatchingParams
Parameters for combined point + feature matching surface registration algorithm.
ImageRegistrationParams
Parameters for image-based (volume-to-volume) registration.
SurfaceRegistrationParams
Parameters for surface-based global registration (applies to masks, surfaces, volume meshes, primitives).
GlobalRegistrationResult
Result from global registration operation.
LandmarkRegistrationResult
Result from landmark registration operation.
SurfaceOperations
Provides tools for creating, editing, and analyzing 3D surface objects.
RegistrationTargetObject
Target object types for registration operations.
RegistrationMode
Registration transformation modes.
PlatonicSolidType
Types of platonic solids.
DirectionAxis
Direction axes for primitive orientation.
SurfaceFilterShellsMethod
Filter shells methods.
IntensityNormalizationMode
Intensity normalization modes for cone beam reconstruction preprocessing.
SurfaceBooleanOperation
Boolean operation types.
SpeckleRemovalMode
Speckle removal modes for cone beam reconstruction preprocessing.
SurfaceVoxelizeMethod
Voxelization methods for voxel-based boolean and remesh operations.
RingArtifactReductionLevel
Ring artifact reduction levels for cone beam reconstruction preprocessing.
SurfaceVoxelConversionMethod
Voxelization fill modes for converting surfaces to masks.
BeamHardeningPreset
Beam hardening correction presets for cone beam reconstruction preprocessing.
SurfaceHoleFillingMethod
Methods for filling holes in surfaces.
ProjectionSmoothingLevel
Projection smoothing levels for cone beam reconstruction preprocessing.
SurfaceRemeshQuality
Remesh quality presets.
ClampingType
Clamping type for intensity value limiting.
SurfaceRemeshMethod
Remesh methods.
SurfaceHollowMethod
Hollow methods.
SurfaceHollowDirection
Hollow direction types.
SurfaceHollowResolution
Resolution presets for hollow operation.
SurfaceSubdivisionMethod
Subdivision methods for increasing triangle count.
VolumeMeshResolution
Volume mesh quality resolution presets for tetrahedral meshers.
VolumeMeshMethod
Volume mesh generation methods.
VolumeMeshElementType
Element type of a generated volume mesh.
SurfaceRepresentation
Surface visualization representation modes.
SurfaceInterpolation
Surface shading interpolation methods.
FaceCullingType
Face culling types for controlling which surface sides are visible.
MaterialType
Predefined material type presets.
BasicSurfaceMeshInfo
Holds basic information about a surface mesh.
ProjectedTextParams
Parameters for creating text projected onto a surface as a separate surface object.
GlobalRegistrationResultRow
Represents a single row in the registration RMSE table.
SurfaceDiagnosticsChecks
Selects surface diagnostic checks and controls the corresponding automatic repairs.
SurfaceDiagnosticsResult
Holds diagnostic information about a surface.
SurfaceFilterShellsParams
Parameters for surface filter shells operations.
SurfaceScreenedPoissonRemeshParams
Parameters for remeshing with screened Poisson surface reconstruction.
SurfaceUnscreenedPoissonRemeshParams
Parameters for remeshing with unscreened Poisson surface reconstruction.
VolumeMeshParams
Parameters for converting surfaces to volume meshes.
SurfaceRenderPropertiesOperations
Provides an interface for managing render properties of 3D surface objects.
ViewOperations
Provides operations for application views, scene orientation, camera, layout, rendering representation, and visualization settings.
LayoutPreset
- Plane3Only: Only the Plane 3 (XY / axial) slice view is shown.
SceneOrientation
Scene orientation types for medical and engineering viewpoints.
StandardView
Standard camera view directions for the 3D view.
WidgetObjectType
Object types for bounding box widget operations.
ContourObjectType
Contour object types for 3D contours in 2D slice views.
RulerType
Ruler style for the 3D and 2D slice views.
RulerColor
Ruler color for the 3D and 2D slice views.
OrientationMarkerType
Orientation marker style for the 3D and 2D slice views.
OrientationMarkerSize
Orientation marker size for the 3D and 2D slice views.
StereoType
Stereo display mode for the 3D view.
AnimationMode3d
Animation mode for the 3D view.
Background3dPreset
Background color preset for the 3D view.
Background2dPreset
Background color preset for the 2D slice views.
Background3dType
Background type for the 3D view custom background.
GradientDirection
Gradient direction for the 3D view gradient background.
FlipType
Flip direction for a 2D slice view.
Interpolation2d
Slice image interpolation mode for the 2D slice views.
VoxelInformationDisplayMode
Display mode for voxel information in the 2D slice views.
SliceViewIndex
Index identifying one of the three 2D slice views.
GpuMemoryBudget
GPU memory budget for grayscale volume rendering in the 3D view.
RenderingQuality
Interactive rendering quality for the 3D view.
FloorShadowsQuality
Shadow quality for the floor shadows in the 3D view.
ShadowFloorPlane
World plane the virtual shadow floor is aligned with in the 3D view.
CameraSettings
3D camera settings used for reading and applying a full camera state.
VolumeMeshOperations
Provides tools for creating, editing, and analyzing 3D volume mesh objects.
VolumeMeshCellType
Supported volume mesh cell shapes, used by get_geometry_data and set_geometry_data.
VolumeMeshRepresentation
Volume mesh visualization representation modes.
VolumeMeshInterpolation
Volume mesh shading interpolation methods.
VolumeMeshRenderPropertiesOperations
Provides an interface for managing render properties of 3D volume mesh objects.
VolumeOperations
Provides tools for creating, editing, and analyzing 3D volume images.
VoxelDataType
Voxel data types for volume operations.
RawVoxelDataType
Voxel data types stored in a headerless (raw) volume file.
MorphologicalOperation
Morphological operation types.
Interpolation
Interpolation methods for volume and mask resampling.
FlipAxis
Axis specification for flip operations.
SlicePlane
Slice plane options for image export and video generation.
SwapAxesPair
Axis pair specification for swap-axes operations.
CombineOperation
Volume combination operations.
CBR_IntensityNormalizationMode
Intensity normalization modes for cone beam reconstruction preprocessing.
CBR_SpeckleRemovalMode
Speckle removal modes for cone beam reconstruction preprocessing.
CBR_RingArtifactReductionLevel
Ring artifact reduction levels for cone beam reconstruction preprocessing.
CBR_BeamHardeningPreset
Beam hardening correction presets for cone beam reconstruction preprocessing.
CBR_ProjectionSmoothingLevel
Projection smoothing levels for cone beam reconstruction preprocessing.
CBR_ClampingType
Clamping type for intensity value limiting.
CBR_ReconstructionFilter
Reconstruction (ramp apodization) filter for cone beam reconstruction.
CBR_NoiseReductionMode
Noise reduction filter applied to the reconstructed volume.
CBR_NoiseReductionLevel
Strength of the post-reconstruction noise reduction filter.
DicomTag
Metadata details stored for a single DICOM tag.
MetaDataEntry
A metadata entry stored on a volume.
DicomSeriesInfo
Summary of a detected DICOM series.
DicomSeriesImportOptions
Options used when scanning and importing DICOM series.
RawVolumeImportOptions
Options describing the layout of a headerless (raw) volume file.
ImageStackImportOptions
Options for importing an image stack from ordered 2D files.
SlicePlaneRenderSettings
Settings for 3D slice plane rendering properties.
ConeBeamReconstructionSettings
Settings for cone beam reconstruction.
VolumeRenderPropertiesOperations
Provides an interface for managing render properties of 3D volume objects.