dicom_toolkit library

Classes

ColorMapLut
Generates 256-element RGBA LUT bytes for each color map.
DicomConfig
Configuration options for the DICOM processing engine.
DicomDecoder
Decodes raw DICOM bytes into a DicomParseResult.
DicomExport
Exports rendered DICOM images as PNG bytes.
DicomFileInfo
Lightweight DICOM metadata + file identity, returned by readDicomInfo.
DicomFrameResult
Represents a single processed DICOM frame, ready for rendering.
DicomInt16PixelData
16-bit signed monochrome pixel data — the most common modality for CT, MR, CR, DX.
DicomMetadata
Wraps the generated generated.DicomMetadata with generic tag access.
DicomParser
The primary entry point for reading DICOM files.
DicomParseResult
The result of parsing a single DICOM file.
DicomPixelData
The pixel data extracted from a DICOM file.
DicomRenderer
GPU-accelerated DICOM image renderer.
DicomRoi
A rectangular region of interest with statistical computation.
DicomRuler
Computes real-world distances from pixel coordinates using DICOM physical spacing metadata.
DicomShaderPainter
A performance-critical CustomPainter that offloads medical rendering to the GPU.
DicomTagId
An immutable identifier for a DICOM data element (group, element).
DicomToolkit
Entry point for the dicom_toolkit library.
DicomViewer
A production-ready, interactive widget for high-performance DICOM rendering.
DicomViewerController
Reactive state controller for the DicomViewer widget.
DicomWindowPreset
A named windowing preset (center + width) and a collection of common radiological presets.
LibShaders Constants
A centralized registry for shader asset paths used within the library.
RoiStatistics
Computed statistics for a rectangular region of interest.
RustDecoder
The default decoder — delegates to the high-performance Rust FFI bridge.
RustLib
Main entrypoint of the Rust API

Enums

DicomColorMap
Available color maps for DICOM image colorization.

Functions

applyWindowingRgba(List<int> pixels, int pixelCount, {required double windowCenter, required double windowWidth, required double slope, required double intercept, Uint8List? lut, bool invert = false}) → Uint8List
Applies window-center/window-width rescaling (with the Hounsfield slope / intercept transform) to pixels and packs the result into an RGBA Uint8List.
pack16Bit(List<int> pixels, int pixelCount) → Uint8List
Packs 16-bit pixels into an RGBA Uint8List for GPU consumption.
packRgb(List<int> pixels, int pixelCount, {bool invert = false, int bitsStored = 8}) → Uint8List
Packs 8-bit or 16-bit RGB pixels (triplets R, G, B, R, G, B...) into an RGBA Uint8List.
readDicomInfo(String filePath) → Future<DicomFileInfo>
Reads DICOM metadata from a file without loading pixel data or GPU shaders.

Typedefs

DicomPoint = ({double x, double y})
A pixel-space point within a DICOM image.
PngEncoder = Future<ByteData?> Function(Image image)
Encodes a rendered ui.Image into PNG ByteData.

Exceptions / Errors

DicomConfigurationException
Thrown when an invalid configuration is passed to the SDK.
DicomException
Base exception for all DICOM-related errors in the SDK.
DicomInitializationException
Thrown when the native Rust engine cannot be loaded into the current process.
DicomProcessingException
Thrown when the high-performance Rust engine fails to parse or process the file.
DicomShaderException
Thrown when the GPU Fragment Shader fails to load or compile.