9 releases
0.2.0 | Jul 23, 2023 |
---|---|
0.1.5 | Dec 12, 2022 |
0.1.4 | Oct 23, 2022 |
0.1.3 | Jul 19, 2022 |
0.1.0-rc.1 | Nov 18, 2021 |
#312 in Images
1,747 downloads per month
Used in 2 crates
2.5MB
40K
SLoC
DICOM-rs pixeldata
This sub-project is directed at users of the DICOM-rs ecosystem. It provides constructs for handling DICOM pixel data and is responsible for decoding pixel data elements into images or multi-dimensional arrays.
This crate is part of the DICOM-rs project.
lib.rs
:
This crate contains the DICOM pixel data handlers and is responsible for decoding various forms of native and compressed pixel data, such as JPEG lossless, and convert it into more usable data structures.
dicom-pixeldata
currently supports a small,
but increasing number of DICOM image encodings in pure Rust.
As a way to mitigate the current gap,
this library has an integration with GDCM bindings
for an extended range of encodings.
This integration is behind the Cargo feature "gdcm",
which requires CMake and a C++ compiler.
dicom-pixeldata = { version = "0.1", features = ["gdcm"] }
Once the pixel data is decoded, the decoded data can be converted to:
- a vector of flat pixel data values;
- a multi-dimensional array, using
ndarray
; - or a dynamic image object, using
image
.
This conversion includes eventual Modality and value of interest (VOI) transformations.
WebAssembly support
This library works in WebAssembly with the following two measures:
- Ensure that the "gdcm" feature is disabled. This allows the crate to be compiled for WebAssembly albeit at the cost of supporting a lesser variety of compression algorithms.
- And either set up
wasm-bindgen-rayon
or disable therayon
feature.
Examples
To convert a DICOM object into a dynamic image
(requires the image
feature):
use dicom_object::open_file;
use dicom_pixeldata::PixelDecoder;
let obj = open_file("dicom.dcm")?;
let image = obj.decode_pixel_data()?;
let dynamic_image = image.to_dynamic_image(0)?;
dynamic_image.save("out.png")?;
To convert a DICOM object into an ndarray
(requires the ndarray
feature):
use dicom_object::open_file;
use dicom_pixeldata::PixelDecoder;
use ndarray::s;
let obj = open_file("rgb_dicom.dcm")?;
let pixel_data = obj.decode_pixel_data()?;
let ndarray = pixel_data.to_ndarray::<u16>()?;
let red_values = ndarray.slice(s![.., .., .., 0]);
In order to parameterize the conversion,
pass a conversion options value to the _with_options
variant methods.
use dicom_object::open_file;
use dicom_pixeldata::{ConvertOptions, PixelDecoder, VoiLutOption};
let obj = open_file("dicom.dcm")?;
let image = obj.decode_pixel_data()?;
let options = ConvertOptions::new()
.with_voi_lut(VoiLutOption::Normalize)
.force_8bit();
let dynamic_image = image.to_dynamic_image_with_options(0, &options)?;
See ConvertOptions
for the options available,
including the default behavior for each method.
Dependencies
~6–11MB
~205K SLoC