0.12.0

New features

• Implementation of Key Object Selection Document Storage SOP Class (#132)
• Allow users to specify Content Label (#130)

Enhancements

• Add Total Pixel Matrix Rows/Columns attributes to Segmentation and Parametric Map objects (#131)
• Add anatomy attributes to annotations groups
• Add example for creation of Secondary Capture images
• Enforce Series Number and Instance Number to be positive integers (#127)

Bug fixes

• Fix JPEG2000 encoding of frames (#119)
• Add missing import statements for Structured Report examples and fix typos in documentation (#125)
• Fix Pixel Spacing in Secondary Capture image (#128)
• Include API documentation for new packages

0.11.0

New features

• Implement Microscopy Bulk Simple Annotations (#114)

Enhancements

• Use Explicit VR Little Endian transfer syntax by default for all SOP classes (#114)

Bug fixes

• Use correct attribute in dimension index of segmentation (#116)
• Allow reference of more than one frame for segmentation source images of planar regions (#118)
• Prevent inclusion of empty content sequence into SR content items (#121)

0.10.0

New features

• Add methods and properties for parsing referenced segments in SR document content (#104)

Improvements

• Include Image Orientation (Slide) and Total Pixel Matrix Origin Sequence attributes in Segmentation (#102)

Bug fixes

• Add missing import statement in example code snippet of documentation (#113)
• Correct value types of Volume Surface content item(s) in SR document content (#112)
• Fix indentation issue in legacy package (#111)

0.9.2

Bug fixes

• Correct code name of Specimen Preparation Step (#108)
• Correct attribute name of legacy converted images (#105)

Documentation

• Add example on how to create secondary capture image (#109)

0.9.1

Bug fixes

• Allow inclusion of content items without Relationship Type into content sequences defined by Acquisition and Protocol templates (#107)

0.9.0

New features

• Implement Parametric Map IOD (#89)
• Enable construction of highdicom objects from existing pydicom objects (#93)

  dataset = pydicom.filereader.dcmread(...)
  segmentation = hd.seg.Segmentation.from_dataset(dataset)

• Add properties and methods to classes derived from highdicom.sr.ContentItem and highdicom.sr.Template to facilitate data access

  document = hd.sr.ComprehensiveSR(...)
  measurement_groups = document.content.get_planar_roi_measurements()

Improvements

• Add unit tests
• Improve description of parameters in docstrings
• Add docstrings to enums
• Add image library entries for SR documents based on TID 1500 (#77)

Bug fixes

• Fix many mypy errors
• Record evidence correctly (Current Requested Procedure Evidence Sequence versus Pertinent Other Evidence Sequence)
• Fix highdicom.sr.RelationshipType
• Fix default value for Pixel Origin Interpretation
• Allow Concept Name Code Sequence to be absent
• Write error traceback to stderr instead of stdout

Major changes

• Change implementation of highdicom.sr.QualitativeEvaluation (is now derived from highdicom.sr.Template rather than highdicom.sr.ContentItem for consistency with highdicom.sr.Measurement)
• Make value and unit parameters of highdicom.sr.NumContentItem required (the corresponding attributes are required by the standard)
• Change fields of highdicom.PatientSexValues to single letters (for consistency with other enums)
• Add references to Current Requested Procedure Evidence Sequence rather than Pertinent Other Evidence Sequence if instances are referenced in the SR document content tree

0.8.0

Bug fixes

• Fix Dimension Organization of Segmentation instances (#92).

Major changes

• Deprecate Segmentation.add_segments() method (#92). All segments now need to be passed to the constructor method. See more detailed release notes about this issue here.

0.7.0

Improvements

• Improve import logic for subpackages and modules to allow:

  import highdicom as hd
  seg_image = hd.seg.Segmentation(...)

• Update API documentation to reflect namespaces of public API
• Add unit tests and increase test coverage

0.6.0

Improvements

• Increase test coverage of highdicom.sr.templates and highdicom.sr.content modules
• Add hyperlinks for context groups (CIDs) and templates (TIDs) to docstrings
• Add checks to ensure that argument segment_number of highdicom.seg.sop.Segmentation.add_segments method is a positive number
• Add checks to ensure that segments added to Segmentation instance via highdicom.seg.sop.Segmentation.add_segments are ordered correctly
• Add checks to prevent Content Sequence in Finding Sites from being empty
• Make tests stricter by enforcing valid value representation in pydicom
• Add alternative constructor methods for highdicom.sr.content classes

Bug fixes

• Make algorithm_identification parameter of highdicom.seg.content.SegmentDescription constructor optional to support manual segmentation
• Make laterality parameter highdicom.sc.sop.SCImage constructor optional
• Fix referencing segments in Planar/Volumetric ROI Measurements and Qualitative Evaluations templates
• Fix Code Value in highdicom.sr.templates.DeviceObserverIdentifyingAttributes
• Include documentation of highdicom.uid module
• Fix constructor of highdicom.sr.templates.TimePointContext

0.5.1

Bug fixes

• Fix addition of segments to Segmentation image with different plane positions

Improvements

• Increase unit test coverage