API reference

Auto-generated from the in-source docstrings of every binding. Use the search box (top right) to jump straight to a class or function.

Image and pixel types

mitk.Image	N-dimensional medical image with attached geometry and properties.
mitk.PixelType	Describes the per-pixel layout of an Image.
mitk.make_pixel_type(dtype[, components])	Construct a PixelType from a NumPy dtype.

File I/O

mitk.IOUtil	File I/O for MITK objects.
mitk.get_loaded_modules()	Return the names of all currently loaded CppMicroServices modules.

Geometry

mitk.BaseGeometry	Spatial geometry of a 3D object.
mitk.Geometry3D	Concrete 3D spatial geometry.
mitk.PlaneGeometry	Geometry of a 2D plane embedded in 3D world space.
mitk.SlicedGeometry3D	Stack of PlaneGeometry objects forming a 3D volume.
mitk.TimeGeometry	Maps discrete time steps to floating-point time points.
mitk.ArbitraryTimeGeometry	TimeGeometry with user-defined time points per step.
mitk.ProportionalTimeGeometry	TimeGeometry with evenly spaced time points.

Points, vectors, color

mitk.Point2D	2D point in world coordinates.
mitk.Point3D	3D point in world coordinates.
mitk.Vector2D	2D vector in world coordinates.
mitk.Vector3D	3D vector in world coordinates.
mitk.Color	RGB color with three float components in the closed range [0, 1].

Properties

mitk.BaseProperty	Abstract base class for typed property values.
mitk.BoolProperty	Property holding a single bool value.
mitk.IntProperty	Property holding a single int value.
mitk.FloatProperty	Property holding a single float (single-precision) value.
mitk.DoubleProperty	Property holding a single float (double-precision) value.
mitk.StringProperty	Property holding a single str value.
mitk.ColorProperty	Property holding an RGB color.
mitk.TemporoSpatialStringProperty	BaseProperty storing per-(time-step, z-slice) string values.
mitk.PropertyList	Standalone, owning collection of typed properties.
mitk.PropertyKeyPath	Structured representation of a hierarchical property key.
mitk.DICOMTag	A single DICOM tag identified by (group, element).
mitk.DICOMTagPath	Path through nested DICOM tags.
mitk.find_indexed_properties(provider, path)	Find indexed property names matching a path with one [*] wildcard.
mitk.property_from_dict(d)	Reconstruct a BaseProperty subclass from a dict.
mitk.property_view.PropertyView(owner)	Live, lazy view over an object's properties.

Multi-label segmentation

mitk.MultiLabelSegmentation	Multi-label, multi-group segmentation data structure.
mitk.Label	A single label inside a MultiLabelSegmentation.
mitk.LabelGroup	One layer of a MultiLabelSegmentation.
mitk.LabelVector	Immutable, sliceable sequence of Label objects.
mitk.AlgorithmType	Provenance of a Label's segmentation.
mitk.MergeStyle	How an incoming source image should combine with an existing destination in a MultiLabelSegmentation mutation.
mitk.OverwriteStyle	Whether a mutation should respect the per-label locked flag.
mitk.DICOMCodeSequence	DICOM coded entry: a (value, scheme, meaning) triple.
mitk.DICOMCodeSequenceWithModifiers	DICOMCodeSequence extended with optional modifier sequences.
mitk.transfer_labels(source, destination, ...)	Transfer label content from source to destination.
mitk.transfer_labels_at_time_step(source, ...)	Single-time-step variant of transfer_labels().
mitk.split_label_value_mapping_by_source_and_target_group(...)	Partition a label-value mapping by source-group and target-group pair.

Exceptions

mitk.Exception	Exception raised by MITK C++ code.
mitk.PropertyNotOwnedError	Raised when set_property() or remove_property() is called on a property that is provided read-only (not owned) by this object.

MxN layout DSL

The mitk.mxn.layout subpackage is a typed, transport-free Python DSL for constructing, inspecting, transforming, and round-tripping the multi-widget layout documents that drive QmitkMxNMultiWidget. See MxN layout DSL for the narrative tour.

Model

mitk.mxn.layout.MxNLayoutDocument(root[, ...])	A complete MxN layout document.
mitk.mxn.layout.Split(orientation, children)	An interior splitter dividing its area among children.
mitk.mxn.layout.LayoutWindow(id, view_direction)	A leaf render-window.
mitk.mxn.layout.Group(name[, select_all])	Synchronization group: a named entry holding shared state for cells that link to it.
mitk.mxn.layout.Link(group)	Per-cell link to a synchronisation group on a single dimension.
mitk.mxn.layout.MxNWindowSelector(source[, ...])	Filter + bulk-transform over a tree's windows.

Builders

mitk.mxn.layout.grid(rows, cols, *[, ...])	Build a rows x cols grid of windows.
mitk.mxn.layout.three_up(*[, group, ...])	Three windows side by side: axial, sagittal, coronal.
mitk.mxn.layout.two_rows_each_direction(*[, ...])	Two horizontal rows; each row has axial / sagittal / coronal.
mitk.mxn.layout.single_window([...])	A single-window layout, wrapped in a horizontal split.

Presets

mitk.mxn.layout.preset(name)	Return a fresh MxNLayoutDocument for the named preset.
mitk.mxn.layout.list_presets()	Names of all registered presets, sorted lexicographically.

File I/O

mitk.mxn.layout.load_preset(path)	Read a JSON file from disk and parse it via MxNLayoutDocument.from_json().
mitk.mxn.layout.save_preset(path, doc)	Write doc as JSON to disk.

Vocabulary

mitk.mxn.layout.LinkDimension(*values)	Synchronization dimension keys recognised by the v2.0 schema.
mitk.mxn.layout.ViewDirection(*values)	Anatomical plane shown in a render window.