Deprecation of Saving Viewer Segmentations as Acquisition Files
Change
Saving segmentations from the Viewer as DICOM SEG files in an acquisition is deprecated as of Flywheel version 23.2.0. This option is scheduled to be removed in the Flywheel 25.0.0 release.
Starting in Flywheel 23.2.0, you can save segmentations from the Viewer as Flywheel segmentations. Flywheel stores a Flywheel segmentation with the image series it belongs to, not as a file in the acquisition.
Until the 25.0.0 release, you can continue to save segmentations as DICOM SEG files in the acquisition of their reference image series. For details on the current behavior, see Save segmentations.
Reason for Change
This change brings segmentations in line with the way Flywheel already saves measurements. Flywheel stores segmentation metadata in its database and shows it alongside the associated image files in Flywheel Core, instead of storing each segmentation only as a file in the acquisition.
Flywheel segmentations also provide:
- Full version history for each segmentation
- An audit trail of changes to segmentations
- Permissions that support inter-reader blinding, so readers cannot see each other's segmentations
- A dedicated segmentation API and Python SDK methods, so scripts can find and work with segmentations without locating and parsing DICOM SEG files in an acquisition
Who Is Affected
- Viewer users who save segmentations, which Flywheel currently stores as DICOM SEG files in the acquisition.
- Anyone with scripts, gears, or gear rules that find, download, or process DICOM SEG files that the Viewer saved in an acquisition.
What Flywheel Segmentations Support in 23.2.0
In Flywheel 23.2.0, you can do the following with Flywheel segmentations:
- Download: Download individual segmentations.
- Bulk Export: Export the segmentations in a project. The export must also include the images that the segmentations are associated with.
- Smart Copy: Include segmentations when you use Smart Copy to copy a project.
- API and Python SDK: Access saved segmentations through the Flywheel API and the Python SDK.
Flywheel segmentations do not yet support the following:
- Selecting a segmentation as a gear input
- Saving a segmentation as a gear output
- Search
- Data Views
Flywheel is working toward support for these capabilities and will update this notice as each capability becomes available.
What Happens to Existing Segmentations
DICOM SEG files that you saved in an acquisition before the 25.0.0 release stay in place. You can still open them in the Viewer.
Recommended Action
When your site upgrades to 23.2.0:
- If your workflows use only the capabilities that Flywheel segmentations support, start saving new segmentations as Flywheel segmentations.
- If your workflows use gears, Search, or Data Views with segmentations, continue to save segmentations as DICOM SEG files in the acquisition. This option remains supported until the 25.0.0 release.
Prior to the 25.0.0 release, review any scripts, gears, or gear rules that expect the Viewer to save new DICOM SEG files in an acquisition, and update them.
If you have questions about this change, contact Flywheel Support.