Skip to content

Report dialog: let the user describe what one save contains #6262

Description

@wayfarer3130

Problem

The series description is the only text that the user gives when the viewer stores a
segmentation, a contour set, or a measurement report. The report dialog offers the
description for a new series only. A save into an existing series keeps the description
of that series, so the user gives no text at all.

The user therefore has no place to say what one save contains, such as added the tumor
or corrected the left edge. A series holds many versions of the same object, and a
reader of the series cannot tell the versions apart by the series description, because
every version of the series shares one description.

User requirements

  • REPORT-DESC-1: The user can give a free text description of the save. The user can
    give the text for every destination, and not for a new series only.
  • REPORT-DESC-2: The viewer stores the text with the saved object, so a later reader of
    the object can see the text.
  • REPORT-DESC-3: The text is optional. A user that gives no text saves the object in
    the same way as before.

Implementation requirements

  • REPORT-DESC-4: Show the text field in the segmentation side panel for now, and not in
    the report dialog. The panel already holds the name of the segmentation, so the panel is
    the cheapest place for a second text field.
  • REPORT-DESC-5: Store the text in a DICOM text attribute of the stored instance.
    ContentDescription (0070,0081) is the first candidate for a SEG: DerivedPixels in
    dcmjs already writes the attribute, and the attribute defaults to an empty string.
    ImageComments (0020,4000) is a second candidate, but DerivedDataset writes
    NOT FOR CLINICAL USE into ImageComments, so a decision about the attribute must come
    first.
  • REPORT-DESC-6: Pass the text to createReportDialogPrompt, and then to the adapter,
    in the same way as defaultSeriesDescription.

Related

PR #6261 makes defaultSeriesDescription the first name that the Save as new field
offers, ahead of the description of the series that the viewer loaded the data from. The
segmentation panel writes a rename into segmentation.label, and storeSegmentation
passes the label as defaultSeriesDescription, so the field now shows a rename that the
user made before the save. That change covers the name of the object. This issue covers
the text about one save.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions