Automatic hanging-protocol selection¶

Some reader-study cases or algorithm outputs have varying numbers of data to be shown. By default, the viewer dynamically tries to show all data. However, sometimes a more nuanced hanging for each of these different number of data is required. In those cases, the viewer can automatically select a good-fitting custom hanging for you.

To use this automatic selection for custom hanging, leave the default hanging protocol unset and only populate the optional hanging protocols. Selection uses view content, together with the data, to see which of the hanging protocols fits best under the following conditions:

• Minimally, show all the available data given the configured view content.
• Select the one that has the least number of empty viewports.

If none apply, the viewer dynamically creates a hanging that shows all or most of the data.

Example¶

For instance, if the view content is configured as follows:

{
  "main": [
    "abdominal-mri"
  ],
  "secondary": [
    "roc-curve"
  ],
  "tertiary": [
    "report"
  ],
  "quatenary": [
    "ct-image"
  ]
}

That is, we have quite a diverse range of things we would like to show.

And we have three hanging protocols configured as optional protocols, where the respective data is shown exactly as intended:

• Hanging protocol A, having "main"
• Hanging protocol B, having "main", "secondary"
• Hanging protocol C, having "main", "secondary", "tertiary"
• Hanging protocol D, having "quaternary"

The automatic selection then finally depends on the different data found in each case.

In the case we only have an abdominal-mri (mapped to "main"), the hanging protocol A will be select: it is the only one that shows all the data and has no empty view ports.

In the case we have an abdominal-mri (→"main") and a roc-curve (→"secondary"), the hanging protocol B is selected. Hanging protocol C also shows the data but would have an empty view port on "tertiary"

Finally, in the case where we have an abdominal-mri (→"main") and a ct-image (→"quaternary") none of the hanging protocols are selected, and the viewer falls back to creating a new hanging that shows them side-by-side.