DICOM-rs 0.6.0

[Enet4]

A new milestone has arrived for DICOM-rs! Version 0.6.0 brings a wide assortment of much needed changes and an interesting array of features! In the spotlight we have a new API for attribute selection and manipulation, a redesigned pixel data adapter API, constants for normative UIDs, DICOM JSON support, an SOP Class dictionary, and many new useful conversions and methods for a better development experience.

I also wrote a bit more about this release in this Dev.to post.

Changes

• Pixel data adapters were moved from encoding to transfer-syntax-registry (Move pixel data adapters to transfer-syntax-registry #251)
• [transfer-syntax-registry] Pixel data adapters in transfer syntax registry are now available behind Cargo features (Replace colored with owo-colors #328)
• [pixeldata] Specific capabilities have also been feature-gated: image, ndarray, rayon (Feature gate capabilities: image, ndarray, rayon, transfer-syntax-registry adapters #238)
• [dictionary-std] Update tag dictionary from DCMTK, with some breaking changes ([dictionary-std] Update tag dictionary from DCMTK #302)
• [dictionary-builder] The tool was moved to devtools, and now also supports DICOM UID dictionaries (New UID constants + SOP class dictionary #372)
• [pixeldata] Require Send + Sync for pixeldata::Error (Require Send + Sync for pixeldata::Error #323)
• [core] several changes were made to DicomValue for ergonomics (Changes to DicomValue API and sequences #353, Extend value sequence implementations #376, [core] Change default type parameter P of DataElement #390)
  • Type parameter P (in DicomValue and in DataElement) now has a default of Vec<u8>, which is more convenient
  • DicomValue now uses independent sequence types DataSetSequence and PixelFragmentSequence
  • Changed PartialEq implementation of DicomValue between data set items, which now ignores the items' recorded length
  • Fixed the error type returned for some of the conversion methods
• [parser] LazyDataSetReader::next has been renamed to advance (Extend data set readers #342)
• [object] Error types have been split for more efficiency (Split errors in object crate #344)
• [ul] PDU association variants and association types have been changed for more versatility (Change PDU association variants and association types #345)
• [core] Some type name changes in the dictionary module were made (New UID constants + SOP class dictionary #372)
  • Primarily to make room for other kinds of dictionaries
• [core] Impls PartialEq<[u16; 2]> and PartialEq<(u16, u16)> for Tag were removed (Remove unneeded PartialEq impls for Tag #389)
  • Developers should prefer converting u16 pairs to a Tag first.
• [ul] Corrected AbortRQServiceProviderReason ([ul] correct AbortRQServiceProviderReason #282)

New

• [core] Extend value retrieval API for encapsulated pixel data (Extend value retrieval API for encapsulated pixel data #339)
• [core] Added a public prelude module for an assortment of types users are likely to import ([core] add prelude module #391)
• [core/object] Attribute operations API, to describe operations in data and perform them onto DICOM data sets (Add attribute operations API #326, Change attribute actions (Set, SetIfMissing, Replace) #360, Enhance attribute operations to support sequential attribute selectors #383)
  • Attribute operations include Set, SetIfMissing, Replace, Remove, PushStr, and many more.
  • Attribute selector API enables selecting elements at an arbitrary data set nesting.
• [object] New value_at method to get values at an arbitrary data set nesting ([object] Add method value_at #394)
• [pixeldata] New encapsulation module helps build encapsulated pixel data (Pixel encapsulation #312 @dougyau)
• [core/dictionary] SOP class dictionary (New UID constants + SOP class dictionary #372, Fix documentation in dicom_dictionary_std::sop_class module #379)
• [dictionary] normative UID constant declarations now available in module uids (New UID constants + SOP class dictionary #372)
• [storescp] Can now handle C-ECHO requests (Handle C-ECHO request in storeSCP CLI tool #338 @PierreBou91)
• [core] DataDictionary trait has been extended with new default methods (Expand DataDictionary trait with new default methods #357)
  • parse_tag extends DICOM tag parsing capabilities to include a look-up by keyword
• [core] Extend value API with mutable accessors (items_mut, etc.) ([core] Extend value/element API a bit more #377)
• [core] Extend data element API with an update_value method ([core] Extend value/element API a bit more #377)
• [object] New command_from_element_iter constructor functions for DICOM objects (New command_from_element_iter constructor functions for DICOM objects #365)
• [parser] Extend data set reader to support peeking (Extend data set readers #342)
• [encoding] Extend transfer_syntax module and re-export inventory (Extend transfer_syntax module and re-export inventory #359)
  • Submitting new transfer syntaxes has been made easier: no need to add inventory yourself, more re-exports at crate root, and new macros are available (submit_ele_transfer_syntax!)
• [transfer-syntax-registry] Support for encoding to JPEG baseline (Encoding to JPEG transfer syntaxes #286 @Almeida-a)

Fixes

• [ul] Add SopClassExtendedNegotiationSubItem for Pdu (Add SopClassExtendedNegotiationSubItem for Pdu #313 @jmlaka)
• [core] Clear leading whitespaces from values with VR DS and IS (Leading whitespaces in VR DS and IS  #335 @lalberge)
• [pixeldata] Change LUT to discard high bits of pixel data sample inputs (Change LUT to discard high bits of pixel data sample inputs  #347)
• [core] Fix using dicom_value! without smallvec import (Fix using dicom_value! without smallvec import #366)
• [object] Reset length in InMemDicomObject to UNDEFINED after any modification, fixes data set writing errors (InMemDicomObject Length::UNDEFINED after modify #364 @jmlaka)
• [findscu] Do not override Query/Retrieve Level when specified by the user ([findscu] Do not override query retrieve level #385)
• [transfer-syntax-registry] Fix RLE decoding in cases where number of samples > 1 (Fix RLE lossless decoding #393)

Enhancements

• Update inventory to 0.3 (Update inventory to 0.3 #272)
• [core] Strings can now be converted directly to DicomValue ([core] Extend value/element API a bit more #377)
• [dump] Fix and improve pixel sequence printing in dicom-dump (Fix and improve pixel sequence printing #340)
• [object] Detect the presence of a file preamble with ReadPreamble::Auto (Change ReadPreamble::Auto to automatic preamble detection #354)
• Support parsing strings in the form "ggggeeee" to a DICOM Tag (Support parsing "ggggeeee" to Tag #363)
  • This form is often used in DICOM JSON
• [dictionary-std] Data element dictionary now recognizes group length tags and private creator tags (Support group length tags in dictionary, update dictionary-std documentation and implementation #367, Support private creator element detection in dictionary #370)
• [dictionary-std] Update documentation and implementation (Support group length tags in dictionary, update dictionary-std documentation and implementation #367)
• [dicom] dicom_dump has been added to the parent crate (Add dicom-dump to parent crate & extend documentation #369)
• [dicom] new extended documentation containing a guided overview of the DICOM-rs library (Add dicom-dump to parent crate & extend documentation #369, [parent] tweak root crate documentation #386)
• [dump] further sanitize control characters in value summary ([dump] further sanitize value summary #371)
• [object] Optimize size of WithMetaError (Optimize WithMetaError #374)
• [echoscu] Improve output in verbose mode ([echoscu] Enhance verbose output #384)
• [findscu] Now supports nested attributes in C-FIND query construction (Use attribute ops API for C-FIND query construction #387)
• [findscu] Add support for modality worklist information model ([findscu] Add support for modality worklist information model #381)

Miscellaneous

• Update rstest to 0.16 (Update rstest to 0.16 #327)
• Update all CLI tools to Clap v4 (Update all CLI tools to Clap v4 #249)
• [dump] Replace colored with owo-colors (Replace colored with owo-colors #328)
• [object] Remove pixeldata module from dicom-object crate (Remove pixeldata module #318)
• [core] Remove unused util module (Remove unused util module #331)
• [pixeldata] Fix rustc warning at DecodedPixelData::frame_data (Fix rustc warning at DecodedPixelData::frame_data #332)
• Update Cargo.lock files (Update Cargo.lock files #341, Update cargo locks #358)
• Clippy lint fix (2023-06) (Clippy lint fix (2023-06) #355)
• [core] Remove default Cargo features from chrono (Remove Cargo features from chrono #356)
• [core] Fix documentation in value module ([core] Fix documentation in value module #375)
• Update implementation class & version for DICOM-rs 0.6 (Update implementation class & version for DICOM-rs 0.6 #380)
• Clippy lint fix (2023-07, pre-0.6) (Clippy lint fixing (pre-0.6) #395)
• Update itertools to v0.11 (Update itertools (v0.11) #396)

📦 New crates

• dicom-json 0.1.0

📦 Updated crates

• dicom-core 0.6.0
• dicom-encoding 0.6.0
• dicom-dictionary-std 0.6.0
• dicom-parser 0.6.0
• dicom-transfer-syntax-registry 0.6.0
• dicom-ul 0.5.0
• dicom-scpproxy 0.5.0
• dicom-object 0.6.0
• dicom-dump 0.6.0
• dicom-pixeldata 0.2.0
• dicom 0.6.0
• dicom-echoscu 0.3.0
• dicom-storescu 0.3.0
• dicom-storescp 0.2.0
• dicom-findscu 0.2.0
• dicom-toimage 0.2.0
• dicom-fromimage 0.2.0
• dicom-dictionary-builder 0.4.0

🙏 New Contributors

A warm thank you to new contributors @dougyau for #312, @lalberge (for #335), @PierreBou91 for #338, and @Almeida-a for #286.

New Website

DICOM-rs has a new website, primarily to serve as a nicer-looking flair to the project with a quick pitch on what it contains and what it can do. More ideas to improve it are on the way! Feel free to reach out on Zulip or discussions to provide feedback on this website. The site's full source code is also available.

Full Changelog: v0.5.4...v0.6.0

---

This discussion was created from the release DICOM-rs 0.6.0.