View content

With the view content, you describe which image (defined by its interface) will be linked to which viewport from the hanging protocol. If you selected a hanging protocol that contains viewports "main" and "secondary", the view content will need to have these same viewports defined. For example, if you want to use the main viewport to display frontal x-rays and the secondary viewport to display lateral x-rays, you'd define your view content as:

{
    "main": ["frontal-x-ray"],
    "secondary": ["lateral-x-ray"]
}

If you want to add an overlay to a viewport, add it to the list of items for that viewport. E.g.:

{
    "main": ["frontal-x-ray", "frontal-overlay"],
    "secondary": ["lateral-x-ray"]
}
Static and Dynamic Viewer labels

The label option of the Hanging protocol allows you to add a static label to a viewport. It is also possible to display dynamic information from either the Display Set (in the context of a Reader Study), Archive Item or Algorithm result. The label displayed below is an example of both label options combined. The Hanging Protocol has the static label "Static label from hanging protocol", while the display set contains an json file with the text "Scan acquired at Radboudumc in 2020" and interface text-report.

The following steps are needed to achieve this dynamic labelling:

  • Select a Hanging Protocol in your Reader Study/Archive/Algorithm.
  • Add an item to each Display set/Archive Item/Algorithm with an interface of type string, boolean, or number.
  • Add this interface to the View content to have that value displayed on the view item.

View content for the example above:

{
    "main": ["frontal-x-ray", "text-report"]
}
Additional content types

Besides displaying images, overlays and annotations, more and more datatypes are supported on Grand Challenge and our viewer. See the table below for the supported formats and how Cirrus will display the data:

Format Interface Kind Displayed as Comments
Text String Html paragraph
Thumbnail Thumbnail jpg Html enbedded
Mp4 MP4 Embedded mp4 player Not supported in Safari and other non-Chromium browsers
PDF PDF Embedded pdf viewer
Chart data Chart Vega Lite plugin See these examples

To add data such as string, mp4, Thumbnails, PDF and Chart data take the following steps:

  • Select a Component Interface of the correct Kind for your data, see interfaces. Contact support@grand-challenge.org if the existing interfaces do not meet your needs.
  • Add your data to each Display set/Archive Item/Algorithm with the selected interface.
  • Add these interfaces to the View content to have the data displayed in the view item. In the example below a ROC curve and PDF report are displayed besides an MRI:
{
  "main": [
    "abdominal-mri"
  ],
  "secondary": [
    "roc-curve"
  ],
  "tertiary": [
    "report"
  ]
}

Strings will be displayed as scrollable text, video data using a video player, and thumbnail images as static images that cannot be interacted with. PDF will be displayed with the standard feautures such as page selection, search and zoom options, but is only supported in Firefox and Chromium-based browsers such as Chrome and Edge.

Combining Hanging protocol with view content

Neither hanging protocol nor view content is required to have a valid layout. These are the options:

  • No view content, no hanging protocol. In this case, the viewer will use a default hanging protocol with a single view. The first image will be shown, optionally with an overlay if one is present. This means 3D images will get side views if there are fewer than 4 images per set. Multiresolution images will be loaded with a minimap overview if there are fewer than 3 images per set.

  • No view content, but hanging protocol configured. Again, the viewer will use a single view but use the chosen hanging protocol. The first image will be shown, optionally with an overlay if one is present. All viewports other than the main will be ignored. In the current version, it is impossible to configure the side views for 3D images or the overview for multi-resolution images.

  • View content configured, no hanging protocol.result The viewer will show the images as defined in the view content but will use the default hanging protocol. This means 3D images will get side views if there are fewer than 4 images per set. Multiresolution images will be loaded with a minimap overview if there are fewer than 3 images per set. The images will be loaded in a layout that will show all images at the same size.

  • Both view content and hanging protocol configured. The viewer will show the images as configured in the view content and hanging protocol. In the current version, it is impossible to configure the side views for 3D images or the overview for multi-resolution images.