Weasis: Free DICOM viewer

A free/libre DICOM viewer

Weasis is a multipurpose standalone and web-based DICOM viewer designed with a highly modular architecture. It is a very popular clinical viewer used in healthcare by hospitals, health networks, multicenter research trials, and by patients.

As free/libre and open source software (FLOSS), Weasis is cross-platform, multi-language, and supports flexible integration with PACS, RIS, HIS, or EHR systems. The viewer is compatible with Windows, Linux, and macOS across various processor architectures (see the available download packages).

Leveraging the OpenCV library, Weasis delivers high-performance and high-quality medical imaging renderings.

From version 4 onwards, Weasis features a responsive user interface aligned with operating system options, offering an enhanced experience on high-resolution screens.

Weasis has been designed to meet the evolving needs of clinical information systems in medical imaging. Its features focus on providing web-based access to radiological images, supporting a wide range of DICOM types, and offering multimedia capabilities.

Key Viewer Features (see also Tutorials)

  • Data type support

    • Weasis provides a highly detailed implementation of the DICOM standard, enabling effortless display and interaction with most types of DICOM files.
    • Display most DICOM files including multi-frame, enhanced, MPEG-2, MPEG-4, MIME Encapsulation, DOC, SR, PR, KOS, SEG, AU, RT, and ECG
    • Display DICOM image containing float or double data (Parametric Map)
    • Import DICOM files with DICOM Query/Retrieve (C-GET, C-MOVE and WADO-URI) and DICOMWeb (QUERY and RETRIEVE)
    • Import and export DICOM CD/DVD with DICOMDIR
    • Import and export DICOM ZIP files
    • Viewer for common image formats (TIFF, BMP, GIF, JPEG, PNG, RAS, HDR, and PNM)
  • Exporting data

    • Export DICOM files locally with several options (DICOMDIR, ZIP, ISO image file with Weasis, TIFF, JPEG, PNG…)
    • Send DICOM files to a remote PACS or DICOMWeb server (C-STORE or STOW-RS)
    • Save measurements and annotations in DICOM Presentation States or XML file
  • Viewing and image rendering

    • Support of several screens with different calibration, support of HiDPI (High Dots Per Inch) monitors, full-screen mode
    • Image manipulation with mouse buttons (pan, zoom, windowing, rotation, scroll, crosshair)
    • Support of DICOM Modality LUTs, VOI LUTs, LUT Shapes, and Presentation LUTs (even non-linear)
    • Apply DICOM Presentation States (GSPS) and display graphics as overlays
    • Support DICOM Overlays, Shutters, and DICOM Pixel Padding
    • Volume rendering with 3D presets
    • Layouts for comparing series or studies
    • Advanced series synchronization options
    • Display cross-lines
    • 3D cursor
    • Oblique Multi-planar Reconstruction (MPR)
    • Maximum Intensity Projection
    • Persistent magnifier glass
  • Measurement and annotation tools

    • Length, area, and angle measurement
    • Region statistics of pixels (Min, Max, Mean, StDev, Skewness, Kurtosis, Entropy)
    • Histogram of modality values
    • SUV measurement
  • Specific viewers

    • DICOM ECG: display all the DICOM waveforms and allow to make some measurements
    • DICOM SR: structured report viewer with hyperlinks to images and associated graphics
    • DICOM AU: audio player (allow to export to WAV files)
  • Other tools

    • Dicomizer module to convert standard images into DICOM
    • Printing views to DICOM and system printers
    • Apply and Create DICOM Key Object Selection by selecting images with the star button
    • Display and search into all DICOM attributes
    • DICOM RT tools for radiotherapy: display RT structure set, dose, and DVH chart

Subsections of Weasis: Free DICOM viewer

Getting Started

Try Weasis now

Visit the Download Page for a comprehensive list of installation options adapted to your system.

Since version 4, only the distribution with a native installer is maintained to ensure a better user experience in terms of installation, configuration and compatibility. This distribution also supports launching Weasis from a web context via the weasis protocol.

Download Weasis DICOM Viewer binaries
Pack. System Arch. Size Weasis installer Comments
DEB  Linux x86-64 49.9 MB weasis_4.5.1-1_amd64.deb Requires GLIBC_2.17
DEB  Linux arm-64 47.2 MB weasis_4.5.1-1_arm64.deb Requires GLIBC_2.27
DEB  Linux arm-32 50.5 MB weasis_4.5.1-1_armhf.deb Requires GLIBC_2.17. Only tested with Raspberry Pi 4
MSI  Windows x86-64 47.7 MB Weasis-4.5.1-x86-64.msi Requires Windows 10 or higher
PKG  macOS arm-64 57.7 MB Weasis-4.5.1-aarch64.pkg Requires macOS 12 or higher (Apple Silicon)
PKG  macOS x86-64 60.1 MB Weasis-4.5.1-x86-64.pkg Requires macOS 11 or higher
RPM  Linux x86-64 63.3 MB weasis-4.5.1-1.x86_64.rpm Requires GLIBC_2.17, libstdc++.so.6 and libgcc

For details about GLIBC versions and Linux distribution compatibility, see this page.

Note

To manage Weasis version at the server side, it is possible to install the Weasis web package which will upgrade the native installation at the client side (it works for minor releases by updating all the plugins except the launcher).
Explore more integration possibilities with other systems here.

Tip

Stay informed about new releases and updates by joining our Google Group. Choose “Email” to get updates directly to your inbox.

General Topics

Get started with these links to learn more about Weasis and its features:

Developer Documentation

Dive into advanced topics and technical resources for developers:

Subsections of Getting Started

Download Weasis DICOM Viewer

Package management systems

Get automatic updates for Weasis by installing it via these package management systems:

Windows

macOS

Linux

Warning

The package management systems above can limit certain functionalities because they work in sandbox mode, especially for Flatpak (see Fedora issue) and Snap (see removable media issue).

The Snap package installation uses a <user.home>/snap/weasis/current/.weasis directory instead of the <user.home>/.weasis directory for all other installations.

List of All Installers

All the packages can be found on Github Github Github and the legacy repository Sourceforge Sourceforge Sourceforge

For details about GLIBC versions and Linux distribution compatibility, see this page.

Download Weasis DICOM Viewer binaries
Pack. System Arch. Size Weasis installer Comments
 
v4.5.1 publised on Sep 18, 2024 Github v4.5.1 downloads
DEB  Linux x86-64 49.9 MB weasis_4.5.1-1_amd64.deb Requires GLIBC_2.17
DEB  Linux arm-64 47.2 MB weasis_4.5.1-1_arm64.deb Requires GLIBC_2.27
DEB  Linux arm-32 50.5 MB weasis_4.5.1-1_armhf.deb Requires GLIBC_2.17. Only tested with Raspberry Pi 4
MSI  Windows x86-64 47.7 MB Weasis-4.5.1-x86-64.msi Requires Windows 10 or higher
PKG  macOS arm-64 57.7 MB Weasis-4.5.1-aarch64.pkg Requires macOS 12 or higher (Apple Silicon)
PKG  macOS x86-64 60.1 MB Weasis-4.5.1-x86-64.pkg Requires macOS 11 or higher
RPM  Linux x86-64 63.3 MB weasis-4.5.1-1.x86_64.rpm Requires GLIBC_2.17, libstdc++.so.6 and libgcc
 
v4.5.0 publised on Aug 15, 2024 Github v4.5.0 downloads
DEB  Linux x86-64 49.9 MB weasis_4.5.0-1_amd64.deb
DEB  Linux arm-64 47.2 MB weasis_4.5.0-1_arm64.deb
DEB  Linux arm-32 50.5 MB weasis_4.5.0-1_armhf.deb
MSI  Windows x86-64 47.7 MB Weasis-4.5.0-x86-64.msi
PKG  macOS arm-64 57.8 MB Weasis-4.5.0-aarch64.pkg
PKG  macOS x86-64 60.2 MB Weasis-4.5.0-x86-64.pkg
RPM  Linux x86-64 63.3 MB weasis-4.5.0-1.x86_64.rpm
 
v4.4.0 publised on May 6, 2024 Github v4.4.0 downloads
DEB  Linux x86-64 50.4 MB weasis_4.4.0-1_amd64.deb
DEB  Linux arm-64 47.4 MB weasis_4.4.0-1_arm64.deb
DEB  Linux arm-32 50.7 MB weasis_4.4.0-1_armhf.deb
MSI  Windows x86-64 47.8 MB Weasis-4.4.0-x86-64.msi
PKG  macOS arm-64 58.4 MB Weasis-4.4.0-aarch64.pkg
PKG  macOS x86-64 60.8 MB Weasis-4.4.0-x86-64.pkg
RPM  Linux x86-64 64.3 MB weasis-4.4.0-1.x86_64.rpm
 
v4.3.0 publised on Feb 17, 2024 Github v4.3.0 downloads
DEB  Linux x86-64 49.5 MB weasis_4.3.0-1_amd64.deb
DEB  Linux arm-64 46.5 MB weasis_4.3.0-1_arm64.deb
DEB  Linux arm-32 47.6 MB weasis_4.3.0-1_armhf.deb
MSI  Windows x86-64 46.8 MB Weasis-4.3.0-x86-64.msi
PKG  macOS arm-64 57.4 MB Weasis-4.3.0-aarch64.pkg
PKG  macOS x86-64 59.9 MB Weasis-4.3.0-x86-64.pkg
RPM  Linux x86-64 63.5 MB weasis-4.3.0-1.x86_64.rpm
 
v4.2.1 publised on Nov 11, 2023 Github v4.2.1 downloads
DEB  Linux x86-64 49.0 MB weasis_4.2.1-1_amd64.deb
DEB  Linux arm-64 46.4 MB weasis_4.2.1-1_arm64.deb
DEB  Linux arm-32 47.5 MB weasis_4.2.1-1_armhf.deb
MSI  Windows x86-64 46.7 MB Weasis-4.2.1-x86-64.msi
PKG  macOS arm-64 57.2 MB Weasis-4.2.1-aarch64.pkg
PKG  macOS x86-64 59.7 MB Weasis-4.2.1-x86-64.pkg
RPM  Linux x86-64 62.9 MB weasis-4.2.1-1.x86_64.rpm
 
v4.2.0 publised on Aug 18, 2023 Github v4.2.0 downloads
DEB  Linux x86-64 50.5 MB weasis_4.2.0-1_amd64.deb
DEB  Linux arm-64 48.8 MB weasis_4.2.0-1_arm64.deb
DEB  Linux arm-32 50.0 MB weasis_4.2.0-1_armhf.deb
MSI  Windows x86-64 48.1 MB Weasis-4.2.0-x86-64.msi
PKG  macOS x86-64 61.2 MB Weasis-4.2.0-x86-64.pkg
RPM  Linux x86-64 62.7 MB weasis-4.2.0-1.x86_64.rpm
 
v4.1.2 publised on Jun 16, 2023 Github v4.1.2 downloads
DEB  Linux x86-64 48.7 MB weasis_4.1.2-1_amd64.deb
DEB  Linux arm-64 47.1 MB weasis_4.1.2-1_arm64.deb
DEB  Linux arm-32 48.6 MB weasis_4.1.2-1_armhf.deb
MSI  Windows x86-64 46.4 MB Weasis-4.1.2-x86-64.msi
PKG  macOS x86-64 58.8 MB Weasis-4.1.2-x86-64.pkg
RPM  Linux x86-64 61.6 MB weasis-4.1.2-1.x86_64.rpm
 
v4.1.1 publised on May 22, 2023 Github v4.1.1 downloads
DEB  Linux x86-64 48.7 MB weasis_4.1.1-1_amd64.deb
MSI  Windows x86-64 46.4 MB Weasis-4.1.1-x86-64.msi
PKG  macOS x86-64 58.8 MB Weasis-4.1.1-x86-64.pkg
RPM  Linux x86-64 61.6 MB weasis-4.1.1-1.x86_64.rpm
 
v4.1.0 publised on May 8, 2023 Github v4.1.0 downloads
DEB  Linux x86-64 48.7 MB weasis_4.1.0-1_amd64.deb
DEB  Linux arm-64 48.3 MB weasis_4.1.0-1_arm64.deb
DEB  Linux arm-32 48.6 MB weasis_4.1.0-1_armhf.deb
MSI  Windows x86-64 46.1 MB Weasis-4.1.0-x86-64.msi
PKG  macOS x86-64 58.8 MB Weasis-4.1.0-x86-64.pkg
RPM  Linux x86-64 61.7 MB weasis-4.1.0-1.x86_64.rpm
 
v4.0.3 publised on Nov 13, 2022 Github v4.0.3 downloads
DEB  Linux x86-64 41.0 MB weasis_4.0.3-1_amd64.deb
DEB  Linux arm-64 39.1 MB weasis_4.0.3-1_arm64.deb
DEB  Linux arm-32 38.9 MB weasis_4.0.3-1_armhf.deb
MSI  Windows x86-64 41.0 MB Weasis-4.0.3-x86-64.msi
PKG  macOS x86-64 53.4 MB Weasis-4.0.3-x86-64.pkg
RPM  Linux x86-64 56.4 MB weasis-4.0.3-1.x86_64.rpm
 
v4.0.2 publised on Aug 1, 2022 Github v4.0.2 downloads
DEB  Linux x86-64 39.4 MB weasis_4.0.2-1_amd64.deb
DEB  Linux arm-64 38.7 MB weasis_4.0.2-1_arm64.deb
DEB  Linux arm-32 38.4 MB weasis_4.0.2-1_armhf.deb
MSI  Windows x86-64 39.4 MB Weasis-4.0.2-x86-64.msi
PKG  macOS x86-64 51.0 MB Weasis-4.0.2-x86-64.pkg
RPM  Linux x86-64 53.9 MB weasis-4.0.2-1.x86_64.rpm
 
v4.0.1 publised on Jun 17, 2022 Github v4.0.1 downloads
DEB  Linux x86-64 39.3 MB weasis_4.0.1-1_amd64.deb
DEB  Linux arm-64 38.7 MB weasis_4.0.1-1_arm64.deb
DEB  Linux arm-32 38.4 MB weasis_4.0.1-1_armhf.deb
MSI  Windows x86-64 39.4 MB Weasis-4.0.1-x86-64.msi
PKG  macOS x86-64 51.0 MB Weasis-4.0.1-x86-64.pkg
RPM  Linux x86-64 53.8 MB weasis-4.0.1-1.x86_64.rpm
 
v4.0.0-rc publised on Apr 30, 2022 Github v4.0.0-rc downloads
DEB  Linux x86-64 38.9 MB weasis_4.0.0-1_amd64.deb
DEB  Linux arm-64 38.1 MB weasis_4.0.0-1_arm64.deb
DEB  Linux arm-32 37.9 MB weasis_4.0.0-1_armhf.deb
MSI  Windows x86-64 38.9 MB Weasis-4.0.0-x86-64.msi
PKG  macOS x86-64 50.5 MB Weasis-4.0.0-x86-64.pkg
RPM  Linux x86-64 53.4 MB weasis-4.0.0-1.x86_64.rpm
 
v3.8.1 publised on Feb 4, 2022 Github v3.8.1 downloads
DEB  Linux x86-64 39.3 MB weasis_3.8.1-1_amd64.deb
DEB  Linux arm-64 38.2 MB weasis_3.8.1-1_arm64.deb
DEB  Linux arm-32 38.7 MB weasis_3.8.1-1_armhf.deb
MSI  Windows x86-64 39.0 MB Weasis-3.8.1-x86-64.msi
PKG  macOS x86-64 51.4 MB Weasis-3.8.1-x86-64.pkg
RPM  Linux x86-64 55.1 MB weasis-3.8.1-1.x86_64.rpm
 
v3.8.0 publised on Dec 11, 2021 Github v3.8.0 downloads
DEB  Linux x86-64 39.3 MB weasis_3.8.0-1_amd64.deb
DEB  Linux arm-64 38.2 MB weasis_3.8.0-1_arm64.deb
DEB  Linux arm-32 38.7 MB weasis_3.8.0-1_armhf.deb
MSI  Windows x86-64 39.0 MB Weasis-3.8.0-x86-64.msi
PKG  macOS x86-64 51.4 MB Weasis-3.8.0-x86-64.pkg
RPM  Linux x86-64 55.1 MB weasis-3.8.0-1.x86_64.rpm
 
v3.7.1 publised on Jun 6, 2021 Github v3.7.1 downloads
DEB  Linux x86-64 38.0 MB weasis_3.7.1-1_amd64.deb
DEB  Linux arm-32 44.5 MB weasis_3.7.1-1_armhf.deb
MSI  Windows x86-64 38.4 MB Weasis-3.7.1-x86-64.msi
PKG  macOS x86-64 50.3 MB Weasis-3.7.1-x86-64.pkg
RPM  Linux x86-64 52.1 MB weasis-3.7.1-1.x86_64.rpm
 
v3.7.0 publised on Feb 6, 2021 Github v3.7.0 downloads
DEB  Linux x86-64 36.9 MB weasis_3.7.0-1_amd64.deb
MSI  Windows x86-64 37.3 MB Weasis-3.7.0-x86-64.msi
PKG  macOS x86-64 49.5 MB Weasis-3.7.0.pkg
RPM  Linux x86-64 51.1 MB weasis-3.7.0-1.x86_64.rpm
 
v3.6.2 publised on Aug 27, 2020 Github v3.6.2 downloads
DEB  Linux x86-64 34.9 MB weasis_3.6.2-1_amd64.deb
MSI  Windows x86-64 35.2 MB Weasis-3.6.2-x86-64.msi
MSI  Windows x86-32 43.4 MB Weasis-3.6.2-x86.msi
PKG  macOS x86-64 47.4 MB Weasis-3.6.2.pkg
RPM  Linux x86-64 48.6 MB weasis-3.6.2-1.x86_64.rpm
 
v3.6.1 publised on Jul 5, 2020 Github v3.6.1 downloads
DEB  Linux x86-64 39.0 MB weasis_3.6.1-1_amd64.deb
MSI  Windows x86-64 35.1 MB Weasis-3.6.1-x86-64.msi
MSI  Windows x86-32 36.7 MB Weasis-3.6.1-x86.msi
PKG  macOS x86-64 47.9 MB Weasis-3.6.1.pkg
RPM  Linux x86-64 55.2 MB weasis-3.6.1-1.x86_64.rpm
 
v3.6.0 publised on Mar 6, 2020 Github v3.6.0 downloads
DEB  Linux x86-64 40.3 MB weasis_3.6.0-1_amd64.deb
MSI  Windows x86-64 40.1 MB Weasis-3.6.0-x86-64.msi
MSI  Windows x86-32 41.2 MB Weasis-3.6.0-x86.msi
PKG  macOS x86-64 51.5 MB Weasis-3.6.0.pkg
RPM  Linux x86-64 57.3 MB weasis-3.6.0-1.x86_64.rpm
 
v3.5.4 publised on Nov 1, 2019 Github v3.5.4 downloads
DEB  Linux x86-64 38.7 MB weasis_3.5.4-1_amd64.deb
MSI  Windows x86-64 37.8 MB Weasis-3.5.4-x86-64.msi
MSI  Windows x86-32 39.7 MB Weasis-3.5.4-x86.msi
PKG  macOS x86-64 49.4 MB Weasis-3.5.4.pkg
RPM  Linux x86-64 55.8 MB weasis-3.5.4-1.x86_64.rpm
 
v3.5.3 publised on Aug 10, 2019 Github v3.5.3 downloads
DEB  Linux x86-64 38.3 MB weasis_3.5.3_amd64.deb
MSI  Windows x86-64 37.2 MB Weasis-3.5.3-x86-64.msi
MSI  Windows x86-32 39.0 MB Weasis-3.5.3-x86.msi
PKG  macOS x86-64 47.5 MB Weasis-3.5.3.pkg
RPM  Linux x86-64 55.3 MB weasis-3.5.3-1.x86_64.rpm

Embedding in dcm4chee

This page describes how installing Weasis to be the default web viewer of dcm4chee-arc-light web interface. See How to launch Weasis from any environments to integrate Weasis into your own user interface.

Weasis is launched from the dcm4chee administrative web interface with the weasis protocol, as shown in the pictures below.

dcm4chee-arc-light dcm4chee-arc-light

For a simpler and faster installation without server components, please follow these instructions; no need to consider the following points on this page. Otherwise if you need more advanced configurations then follow these steps:

  1. Install dcm4chee, if not already done (Installation with Docker is straightforward).

  2. Go here and download these following files:

    Warning

    Download issue: Some browsers (like Internet Explorer) may rename war files to zip. If so, use the Save As option when downloading and change the name back to war.

    • From weasis-pacs-connector folder:
      • [weasis-pacs-connector.war] Requires at least the version 7.1.2
    • From the folder with the latest version number (Optional if you want to run only the native version installed on the client system):
    • From the folder with the latest version number:
  3. Open the wildfly management console (at http://<your-host>:9990).

    • Select the “Deployments” tab
    • Add the .war files using the “Add” button (Choose Upload a new deployment or select Replace when the file already exists)
      Note

      Alternatively one may deploy .war files using JBoss Command Line Interface Console.

  4. Configure weasis-pacs-connector (This step is optional if you just want to keep the default configuration).
    The default configuration is stored in two files inside weasis-pacs-connector.war. To override the default configuration:

    • Download the current download>weasis-pacs-connector.properties and download>dicom-dcm4chee-arc.properties (configuration of the dcm4chee archive)
    • Edit the configuration as needed. For example, dcm4chee may be running on a different computer than Weasis, or the AE Title of dcm4chee may have been changed. If so, edit weasis-pacs-connector.properties or dicom-dcm4chee-arc.properties (Change pacs.host, pacs.port, and pacs.aet).
    • Copy weasis-pacs-connector.properties and dicom-dcm4chee-arc.properties into $WILDFLY_HOME/standalone/configuration (where $WILDFLY_HOME is the path of the running Wildfly).
      With the docker installation use the docker copy command ($ docker cp …)
      Tip

      Instead of copying the files into $WILDFLY_HOME/standalone/configuration, JBoss Command Line Interface Console can be used to override files in the war. Add the two configuration files with the deployment-overlay command:

      deployment-overlay add --name=dcm4chee-arc --deployments=weasis-pacs-connector.war --content=WEB-INF/classes/weasis-pacs-connector.properties=/tmp/weasis-pacs-connector.properties,WEB-INF/classes/dicom-dcm4chee-arc.properties=/tmp/dicom-dcm4chee-arc.properties --redeploy-affected
    • For applying the new configuration, from the management console “Disable” weasis-pacs-connector.war and then “Enable”
  5. To activate Weasis in the dcm4chee-arc-light user interface (see the matrix of the required versions in the table below): you need to add attributes by either editing docker-compose.env (from 5.22.0) or from the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE (add &cdb to the URL if weasis.war has not been deployed on the server-side):

    • Configure the URL for having a view button for the patient or study level.
      • From dcm4chee-arc-light 5.10.2 to 5.19.0 the left menu Configuration > Devices > dcm4chee-arc > Extensions > Archive Device
      • From dcm4chee-arc-light 5.19.1 the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE
      • From dcm4chee-arc-light 5.22.0 by editing docker-compose.env (It allows you to directly apply the properties when deploying, then the can be edited in the web portal). Note: the character ‘&’ must be escaped (e.g. IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}\&access_token={{access_token}})
        Note

        URL parameters

        • access_token is necessary in secure mode (secured RESTful services) from dcm4chee-arc-light 5.15.1
        • _self avoids to open a new empty window in the web browser
        • cdb cdb parameter to override the URL of the Weasis web context to null (when you want only the native local version or when weasis.war has not be deployed with weasis-pacs-connector)
        • See also Invoke Image Display in dcm4chee
        Tip

        Absolute path: The values above starting by “../” are the default relative path when weasis-pacs-connector is installed in the same JBoss as dcm4chee. Otherwise replace the relative URL by an absolute value, ex: http://<your-host>:<port>/weasis-pacs-connector/...

    • InfoOptional Add other properties in the URL.
    • Refresh the web page and the view button should appear as in the screenshot above
    • To launch the viewer from the web portal, the client computer must have installed the Weasis package.
Mode dcm4chee version Configuration
Unsecured from 5.10.2 to 5.19.0 ../../weasis-pacs-connector/weasis?&patientID={}&target=_self
../../weasis-pacs-connector/weasis?&studyUID={}&target=_self
Unsecured* from 5.10.2 to 5.19.0 ../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self
../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self
Secured from 5.15.1 to 5.19.0 ../../weasis-pacs-connector/weasis?&patientID={}&target=_self&access_token={}
../../weasis-pacs-connector/weasis?&studyUID={}&target=_self&access_token={}
Secured* from 5.15.1 to 5.19.0 ../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self&access_token={}
../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self&access_token={}
Unsecured from 5.19.1 to 5.22.1 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&target=_self
IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&target=_self
Unsecured* from 5.19.1 to 5.22.1 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self
IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self
Secured from 5.19.1 to 5.22.1 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&target=_self&access_token={}
IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&target=_self&access_token={}
Secured* from 5.19.1 to 5.22.1 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?&patientID={}&cdb&target=_self&access_token={}
IID_STUDY_URL=../../weasis-pacs-connector/weasis?&studyUID={}&cdb&target=_self&access_token={}
Secured from 5.22.2 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?patientID={{patientID}}&access_token={{access_token}}
IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}&access_token={{access_token}}
IID_URL_TARGET=_self
Secured* from 5.22.2 IID_PATIENT_URL=../../weasis-pacs-connector/weasis?patientID={{patientID}}&cdb&access_token={{access_token}}
IID_STUDY_URL=../../weasis-pacs-connector/weasis?studyUID={{studyUID}}&cdb&access_token={{access_token}}
IID_URL_TARGET=_self

* Running only the local native version of Weasis (when not connected to a remote version - weasis.war -)

Weasis Web Protocol

The Weasis Protocol enables the launch of Weasis (starting from v3.6.0 ) in a web context using a specific URI scheme: weasis://commands.

How to Use the Weasis Protocol

To launch Weasis from various contexts:

  1. From a Web Page: Create a link that begins with weasis:// (see below How to build an URI).
    If certain web frameworks (e.g. WIKI) or contexts only support HTTP protocols, you can use a URL redirection starting with https://. A tool such as Weasis PACS Connector can assist with this.
  2. From the Command Line: Utilize the appropriate Weasis command from the terminal:
    start weasis://%24dicom%3Aget+-w+%22https%3A%2F%2Fnroduit.github.io%2Fdemo-archive%2FLumbar%2Fmf.xml%22
    xdg-open weasis://%24dicom%3Aget+-w+%22https%3A%2F%2Fnroduit.github.io%2Fdemo-archive%2FLumbar%2Fmf.xml%22
    open weasis://%24dicom%3Aget+-w+%22https%3A%2F%2Fnroduit.github.io%2Fdemo-archive%2FLumbar%2Fmf.xml%22

How to Build a URI

The weasis:// URI scheme allows you to launch Weasis directly from the system’s URI handler. By constructing the correct URI path, you can execute Weasis commands to load images or perform other actions.

Weasis PACS Connector can dynamically generate manifests (listing references for images to load) and build the required URI through an API. This tool also manages user preferences and other launch parameters.

If you’re not using the Weasis PACS Connector, you can build a URI manually by following these steps:

  1. Choose Commands: Select one or more commands to execute.
  2. Encode the Commands: Use a URL encoder to format the commands correctly for URI inclusion.
  3. Prefix the Commands: Add the weasis:// scheme at the beginning of the encoded command string to create the final URI.
Example: Loading a Remote Image
  1. Use $dicom:get to load an image from URL
    $dicom:get -r "https://nroduit.github.io/demo-archive/us-palette.dcm"
  2. Format the URI path with a URL encoder
    %24dicom%3Aget+-r+%22https%3A%2F%2Fnroduit.github.io%2Fdemo-archive%2Fus-palette.dcm%22
  3. Make the final URI by adding “weasis://” at the beginning Open the remote image
Tip

For loading multiple images, it’s recommended to use a manifest file that references all desired images instead of including each image individually in the URI. The easiest way to build this manifest dynamically is by using the Weasis PACS Connector. Alternatively, you can create the manifest manually following the provided instructions.

Examples to Load Images

If you use weasis-pacs-connector, please refer to Launch Weasis.

  • Use $dicom:get to load a static XML manifest containing direct links (without WADO server) Launch
    $dicom:get -w "https://nroduit.github.io/demo-archive/Lumbar/mf.xml"
  • Use $dicom:rs to load DICOM files with DICOMWeb RESTful services (see other examples) Launch
    $dicom:rs --url "https://demo.orthanc-server.com/dicom-web" -r "patientID=5Yp0E"
  • Use $dicom:get to load an image from URL and remove all the previous images if Weasis is already open Launch
    $dicom:close --all $dicom:get -r "https://nroduit.github.io/demo-archive/us-palette.dcm"
  • Use $dicom:get to load multiple local folders and a remote image Launch
    $dicom:get -l "D:/DICOM/Overlay" -l "D:/DICOM/Shutter" -r "https://nroduit.github.io/demo-archive/us-palette.dcm"
  • Use $image:get to load a non DICOM image Launch
    $image:get -u "https://user-images.githubusercontent.com/993975/59107662-6c9ed300-8939-11e9-83ee-28f2725f4ae1.jpg"

Modify the Launch Parameters

The command for modifying the configuration at launch is $weasis:config which can have different arguments:

  • cdb is the Weasis web context (The URL of weasis.war). If the value is null, the weasis version installed from the native installer is used. In the weasis-pacs-connector configuration, the default value is defined by weasis.base.url.
  • cdb-ext is the extension web context of Weasis (The URL of weasis-ext.war containing additionnal plugins). In the weasis-pacs-connector configuration, the default value is defined by weasis.ext.url.
  • arg is an argument for the launcher. The value must start by $, like arg="$dicom:close –all" (Note: the value can also be directly in the base URI, outside $weasis:config). Single-valued argument but can be specified multiple times.
  • pro is a property for the launcher containing a key and a value separate by a space. Single-valued property but can be specified multiple times.
  • auth is the web authorization parameter
  • wcfg is the URL the remote Weasis configuration service.

Here are some examples that modify the launcher properties without using weasis-pacs-connector:

  • Configuration for launching Weasis Dicomizer Launch
    $weasis:config pro="felix.extended.config.properties file:conf/dicomizer.json" pro="gosh.port 17181"
  • Change the user, by default is the one of the current system session. The local preferences are associated to a user. Launch
    $weasis:config pro="weasis.user user2"

Building Weasis

These instructions guide you through building Weasis directly from its GitHub repository. For IDE-based builds, refer to the Weasis plugin development guidelines.

Prerequisites

  1. JDK 23 or higher
  2. Maven 3.6.3 or higher
    If your computer is behind a proxy server, refer to the Maven proxy configuration guide.
  3. Git

Getting the Source Code

In order to clone the repository, install Git and either use a graphical client or run the following command in a terminal:

git clone https://github.com/nroduit/Weasis.git

Building All Plugins

  • Navigate to the root directory of the cloned Weasis repository, compile and install all plugins into the local Maven repository:

    mvn clean install

  • Package weasis-native.zip (located in target/native-dist/), since Version4.0.0 :

    mvn -P compressXZ -f weasis-distributions clean package
    Tip

    -P compressXZ: Option for compressing the packages in xz, only from Weasis 3.6.0. The compression pack200 is not supported anymore (removed from Java 14), before 3.6.0 the profile was -P pack200.

    Tip

    -P purgeI18nPackage: Option to delete the translation package in the local maven repository (active by default). To disable this option, add - before the profile:

    mvn -P compressXZ,-purgeI18nPackage -f weasis-distributions clean package
    Warning

    For production, the version must not include SNAPSHOT (as packages with a SNAPSHOT are always downloaded, not cached). To remove SNAPASHOT or create your own release (use a specific name to prevent package conflicts in the cache), update the changelist property. From the Weasis root folder, execute:

    mvn -Dchangelist=-mybuild-beta clean install
    mvn -Dchangelist=-mybuild-beta -P compressXZ -f weasis-distributions clean package

Building native binaries and installers

Starting with Version4.0.0, the native installer has fully replaced the portable and Java WebStart distributions.

The official build process is executed via GitHub Actions using GitHub-hosted runners across Linux, macOS, and Windows.

However, you can also build the native binaries and installer locally using the package-weasis.sh script. This process is not guaranteed to work on all systems, as it requires proper configuration of multiple tools. Refer to the jpackage prerequisites for more details.

  • Obtain the weasis-native.zip file, extract the archive, and navigate to the root folder in a Bash prompt.
  • Run the following command to build the native binaries and installer:
    ./build/script/package-weasis.sh --jdk "/home/.jdks/openjdk-23"
Note
  • Replace --jdk with the path to your local JDK installation.
  • To generate only the native binaries (without creating an installer), include the --no-installer flag.
  • For additional command options, run:
    ./build/script/package-weasis.sh --help
Tip

On Windows the bash script must be executed with Git Bash or Cygwin. Avoid having spaces in the input and output paths.

Guidelines

Weasis Plugin Development

This page describes the necessary configurations to be able to debug Weasis using an IDE. For developers who want to create new plugins, you can visit How to build and install a plugin.

We recommend the use of IntelliJ IDEA because the following instructions are based on it. Nevertheless, it is possible to use other IDEs by configuring weasis-launcher with similar instructions described in Add a launcher.

Prerequisites

  1. Install IntelliJ IDEA (Community or Ultimate Edition 2024.3 or higher)
  2. Use JDK 23 or higher and set the language level to SDK Default in File > Project Structure… >.
    Required Maven version is 3.6.3 or higher.
  3. In File > Settings… > Plugins install google-java-format plugin from Marketplace and enable it from google-java-format Settings

Code style and convention

Weasis uses google-java-format as coding conventions. The format can be applied by Maven through the Spotless plugin or from the IDE (by importing the IntelliJ Java Google Style file). Formatting code with an IDE is not 100% compatible with Spotless, so it is better to use the latter before submitting new commits. This guarantees identical code formatting regardless of the system or code editor used.

  • From Maven command: mvn spotless:apply
  • From the Maven panel Maven Spotless Maven Spotless

Getting the source and building Weasis

  • Getting the Source
    • For external Git client, see Building Weasis.
    • From IntelliJ IDEA: New > Project from Version Control…
      • In the Get from Version Control dialog, select the menu Repository URL and enter the following URL: https://github.com/nroduit/Weasis.git (public repository)
  • Building Weasis plugins
    • In the maven panel, select clean/install in Lifecycle of weasis-framework (root) to compile and to install all the plugins in the local Maven repository.
Tip
  • It is possible to use a JVM Option (e.g. -Dweasis.arch=linux-x86-64) to limit the build of native plugins only to the architecture of the current system (do not use this option when building the distribution).
  • See also building the final Weasis Distributions

Add a launcher

For running or debugging Weasis, you need to create a launcher:

  • Open Run > Edit Configurations…

  • Create a new Application

    • Select weasis-launcher as a module (field starting by -cp)
    • Main Class: browse org.weasis.launcher.AppLauncher
    • Click on Modify Options
      • Select Add dependencies with “Provided” scope to classpath
      • Select Do not build before run
      • Select Add VM Options and enter -Xms64m -Xmx768m -Dgosh.port=17179
    • Working Directory: remove the current value and add %MODULE_WORKING_DIR% from the Insert Macros button Launcher Configuration Launcher Configuration
      Note

      As the default build task has been removed it is necessary to apply the Maven command install on modules with modified code before launching the Run or Debug mode.
      Keeping the build task and delegating the build to Maven does not seem configurable for a multi-module project, see this issue.

  • Examples of launching parameters by entering values in the Program arguments text box

    • Loading DICOM files from a local path:
      $dicom:get -l \"D:\images test\dicom\"
      Note

      Some command interpreters need to escape the quotes or double quotes required for paths or URLs. This is the case with IntelliJ IDEA or Eclipse.
      For more commands at startup see also Weasis commands.

      Warning

      In Eclipse launcher parameters, ‘&’ within URLs needs to be escaped with a backslash.

  • Examples of other VM options for overriding the default Preferences

    • Removing the possibility of exporting DICOM: -Dweasis.export.dicom=false
    • Defines a new user (for getting specific preferences): -Dweasis.user=user1
    • Examples with specific configuration files:
      • For launching Weasis Dicomizer: -Dfelix.extended.config.properties=file:target/conf/dicomizer.json
      • Configuration from an URL: -Dfelix.extended.config.properties=https://mysite.com/weasis/conf/config.json
        Note

        felix.config.properties defines the location of base.json (the OSGI configuration and the list of plugins to install/start)
        felix.extended.config.properties defines the location of a json file (extends/overrides base.json)

Internationalization

Translation files are hosted and managed on the Transifex website. Get an account and help to translate to your language! If your language is missing, just head over to Transifex and request a new language.

Warning

Text length: The translations for many languages frequently exceed the length of the corresponding English source. It could be a problem for the layout of graphical components (e.g. buttons). Some elements have a character limit on the translation tool.

Tip

Special characters: Some characters representing values (%d, %s), newline (\n) and HTML tags must not be translated. For other translating recommendations, see Transifex help
For special words or particular contexts look at the “Instructions” text box (gives explanations or definitions).

Building Weasis-i18n

weasis-i18n is the internationalization project (i18n) of Weasis. As a separate project, it can have its own release cycle. The OSGi fragments of plugins contain only the translation files which are merged during runtime to the matching module of the application.

To obtain daily built packages, see this page.

Note

That means the translation packages can be deployed at any time, it does not need to follow the Weasis life cycle. With remote packages, the plugin translation will be updated by Weasis only if the timestamp number has changed. This timestamp is set during the build phase described below.

Info

Additional projects to obtain a full translation of Weasis:
The java-swing-dialogs translations must be updated manually in the weasis-launcher module and docking-frames translations must be packaged witin the library.

Prerequisites

  1. JDK 11 or higher
  2. Maven 3 or higher
    If your computer is behind a proxy server, configure maven.
  3. Git or directly download the source code from GitHub

Getting the Source

To clone the repository, first install GIT and either clone using a graphical GIT client (such as Tortoise Git) or directly from the command line using the command:

$ git clone https://github.com/nroduit/weasis-i18n.git

Build the distribution

Go in the weasis-i18n directory, Compile and install all the plugins in the local Maven repository

$ mvn clean install -Dtransifex.token="<your-token>"

All the APIs require to be authenticated. So the value “your-token” must be replaced by your generate token, see how to get this token on Transifex.

Command if you are behind a proxy server:

$ mvn clean install -DproxySet=true -DproxyHost="host" -DproxyPort="port" -Dtransifex.token="<your-token>"

Info

The distribution files are located in the weasis-i18n-dist/target/dist folder.

Apply the translations

The translation package can be built manually as described below or it is automatically built every 24 hours and can be downloaded from here. When Building Weasis, the last package is downloaded automatically.

  • In order to update Weasis with new translations, unzip weasis-i18n.zip and either:
    • Pass the weasis.i18n location into the launch command:
      $weasis:config pro="weasis.i18n <your-uri>"
      $weasis:config pro="weasis.i18n file:/home/weasis-i18n-dist-4.0.0-SNAPSHOT"
      $weasis:config pro="weasis.i18n https://<your-domain>/weasis-i18n-dist-4.0.0"
    • Replace the files in the “bundle-i18n” folder where Weasis is installed (not possible when Weasis is distributed from an application store or the Mac signed package).
Note

weasis-launcher-i18n cannot be updated dynamically as the launcher is not an OSGi module. It must be imported manually into the Weasis source (weasis-launcher).

Tip

Subsections of Basics

Weasis Architecture

Weasis is built on a modular architecture powered by OSGi: the dynamic module system for Java. This design allows for a highly flexible, dynamic, and extendable structure. At its core, Weasis utilizes the Apache Felix OSGi framework, a lightweight open-source implementation of the OSGi specification.

Key Architectural Features

The following diagrams illustrate the main plugin types (known as bundles in OSGi terminology) and their relationships. These include Viewer, Viewer Tool Pane, Tool Bar, Data Explorer, and Codec bundles, which are dynamically registered using Declarative Services—a mechanism to seamlessly provide or consume services in the OSGi environment.

OSGI plugins Weasis Launcher and Apache Felix OSGi framework Codec [Codec] Data Explorer [DataExplorerView,ExplorerModel] Weasis Core Weasis Base UI (UI plugins aggregator) Viewer [ViewerPlugin] Viewer Tool Pane [DockableTool] Tool Bar [Toolbar] [...] = Java abstract class or interface to implement Web Browser Desktop App Mime Type Open a viewer related to the mime type Weasis protocol (URI) Mime types / Extensions

Understanding The Categories of Plugins

Weasis employs a modular approach, where individual plugins (or bundles in OSGi terminology) handle specific functionalities. Here are the plugin categories represented by layers in the diagram:

  1. Media Viewer and Editor
    This category handles the main viewing and editing functionalities. Except the 2D viewer, it includes specialized viewers for different modalities and representations.
  2. UI Aggregator
    UI Aggregator plugins bring together various interface components to create a cohesive and user-friendly experience. They dynamically adapt the interface to include provided tools or modules, ensuring that Weasis remains customizable and modular.
  3. Data Access and Management (Data Explorer)
    This category focuses on managing how data is loaded, retrieved, and handled within the system.
  4. Codec (Media Decoding)
    Codec plugins are responsible for decoding and interpreting medical media files in the DICOM format and other supported formats. They sometimes include native libraries.
  5. Utility and Core Services
    This plugin provides essential utility functions and core services needed to support the other modules.

Each of these categories contributes to the flexibility and extensibility of Weasis, enabling it to be customized and adapted to different clinical and research workflows.

packages packages

Fragment Bundles

A fragment bundle is a special type of bundle that is attached to a host bundle to provide additional resources or classes. In Weasis, fragment bundles are used to provide translations and native libraries for codecs. This design allows for a clean separation of concerns and ensures that only the required resources are loaded at runtime.

Bundle Translation Management

Each bundle has its translation files packaged in a separate bundle fragment (ending in i18n), an OSGi concept that merges these files dynamically during runtime. This design allows translations to be maintained independently, and they are automatically loaded by the application whenever they are available.

Codec Support with Native Libraries

Certain Codec bundles contain fragments with native libraries (using JNI wrappers). The Weasis launcher dynamically loads only the required native binaries relevant to the platform on which it is running, ensuring lightweight and efficient operation.

Shortcuts

Keyboard and Mouse Shortcuts

Here is a list of the most common keyboard and mouse shortcuts in Weasis. The shortcuts are divided into different categories for better understanding.

Central panel containing viewers and editors

Shortcut Action
Ctrl + Tab Select the next tab (since v4.2.1 )
Ctrl + Shift + Tab Select the previous tab (since v4.2.1 )
Ctrl + Shift + E Open a the docking panel list for selection
Ctrl + M Maximize/Restore the selected tab
Ctrl + W Close the tab
Tab Right-click Open the contextual menu for more options

Selected view in the 2D DICOM Viewer

Shortcut Action
Left Arrow Display previous series (since v4.2.1 )
Right Arrow Display next series (since v4.2.1 )
Page Up Display first series (since v4.2.1 )
Page Down Display last series (since v4.2.1 )
Ctrl + Left Arrow Display previous study (since v4.2.1 )
Ctrl + Right Arrow Display next study (since v4.2.1 )
Ctrl + Page Up Display first study (since v4.2.1 )
Ctrl + Page Down Display last study (since v4.2.1 )
Up Arrow Display previous image (since v4.2.1 )
Down Arrow Display next image (since v4.2.1 )
Home Display first image (since v4.2.1 )
End Display last image (since v4.2.1 )
Shift + Up Arrow Go 10 images back (since v4.2.1 )
Shift + Down Arrow Go 10 images forward (since v4.2.1 )
Ctrl + Up Arrow Display previous patient (since v4.2.1 )
Ctrl + Down Arrow Display next patient (since v4.2.1 )
Ctrl + Home Display first patient (since v4.2.1 )
Ctrl + End Display last patient (since v4.2.1 )
Tab Go the next view when layout has more than one view
Shift + Tab Go the previous view when layout has more than one view
Alt + Arrows Move image of 5 pixels (since v4.2.1 )
Alt + Shift + Arrows Move image of 10 pixels (since v4.2.1 )
Ctrl + Plus (+) Zoom in (since v4.2.1 )
Ctrl + Minus (-) Zoom out (since v4.2.1 )
Ctrl + Enter Set zoom to best fit (since v4.2.1 )
T Translate (pan) the image canvas
W Window / Level
S Series scroll
Z Zoom
R Rotation
H Crosshair: in multiview mode synchronizes the crosshair position to all the views (Note: Ctrl + click or Ctrl + Shift + click allows changing the Window/Level values)
C Cine Start / Stop
M Measure
D Distance measurement
A Angle measurement
Y Polyline measurement
B Textbox
Q Context menu
Ctrl + Spacebar Change to the next action
Ctrl + mouse drag Accelerate the current action
Ctrl + Shift + mouse drag Accelerate more the current action
Alt + R 90° rotation (clockwise)
Alt + L 90° rotation (counterclockwise)
Alt + F Flip horizontally (after rotation action)
0 1 2 3 DICOM presets
K Toggle key image state
Spacebar Show/Hide all the annotations (three states)
I Show/Hide all the annotations (three states)
Escape Reset the selected view
P Print view(s) with the operating system printer
Right-click Open the contextual menu for more options
Double click or F11 Toggle fullscreen (F11 since v4.5.2 )
Drag files/directories
(from the OS file manager)
Open DICOMs files

Selected view in the MPR Viewer

MPR view inherits the same shortcuts as the 2D viewer, with the following additional shortcuts since v4.5.2 :

Shortcut Action
Alt + A Center crosshair of the selected view
Alt + S Show/Hide the crosshair center of the selected view
Alt + D Show/Hide the crosshair of the selected view
Alt + C Center crosshair of all views
Alt + V Show/Hide the crosshair center of all views
Alt + B Show/Hide the crosshair of all views

DICOM explorer

Shortcut Action
Ctrl + click on the thumbnail Select multiple series
Click on a thumbnail and then Shift + click on another one Select all series between
Ctrl + A Select all the series
Home or Page Up Select the first series
End or Page Down Select the last series
Up Arrow Select previous series
Down Arrow Select next series
Enter Open the selected series in the default viewer
Click + drag a thumbnail in the main view Display a series
Right-click Open the contextual menu for more options
Drag files/directories
(from the OS file manager)
Open DICOMs files
Note

Downloading Priorities: Selecting a thumbnail gives the best priority to download.

Graphics

Shortcut Action
Click on a graphic Select a Graphics
Click + mouse drag In selection mode: select all the graphics inside the selection area.
In drawing mode: draw the selected graphic shape.
Ctrl + A Select all the graphics
Ctrl + D Deselect all the graphics
Delete Delete the selected graphics
Shift + click on a graphic In selection mode: add or remove a graphic to the current selection.
In drawing mode: force to draw on another graphic (without shift the graphic is selected).
Double click Stop adding points for polyline (also available in the context menu)
Right-click Open the contextual menu for more options

Tips and Tricks

Window / Level Adjustment

  • Move the mouse horizontally to the right to increase the window width (reduce the perceived contrast).
  • Move the mouse vertically upwards to lower the window center (increase the perceived brightness).
    Tip: Use Preferences to reverse the direction of level adjustments.

Drawing a Segment

You can draw a segment in two ways:

  1. Click + Drag: Click, drag to draw, then release.
  2. Click > Release > Drag: Click to start, release, drag to draw, and release again.

Subsections of Customize

Integration

How to launch Weasis from any environments

Here we present how to launch Weasis with associated images from any context either using weasis-pacs-connector or by building your own connector. The launch of the application is based on the weasis protocol available since Version3.5.3.

Using weasis-pacs-connector allows a high degree of integration and facilitates connection to a PACS. Here are some of the advantages:

  • Automatically build a manifest according to a configuration with a PACS
  • The initial URL starts with HTTP and is then redirected to weasis:// (as weasis:// is not allowed by wiki, blog…)
  • Manages to build the manifest simultaneously with the start of Weasis (Loading time optimization)
  • The URL returns a manifest ID which can be requested only once (and must be consumed within 5 min)

However, it is also possible

Note

Requires Weasis installed on the system with the native installer.

Use weasis-pacs-connector

For connecting to dcm4chee web interface, follow the instructions in Installing Weasis in DCM4CHEE. Otherwise, refer to the documentation of weasis-pacs-connector.

Standard workflow when connecting Weasis to a PACS, RIS, EMR, EPR or any web interface:

PACSLauncherDICOMQueryWeasisConfig(Configurationoftheuserpreferencesandthelauncherparameters)XMLmanifestBuilder(asynchronoustaskstartinstep2andreturndirectlyanURLwithanIDorder)2.manifestbuilderURL3.URLredirectionintoweasisprotocol(weasis://parameters)DownloadManager(ReadXMLmanifest)1.Request(URLwithUIDs,includeInvokeImageDisplayIHEProfile)6.GetDICOMfilesbyWADO5.GetthemanifestWeasisweasis-pacs-connectorClient(oranywebordesktopapplications)dcm4cheewebui4.Executeweasisprotocol

Note

The schema above shows that the queries to the PACS are made at the same time as the viewer starts. This makes it possible to optimize the launch by simultaneously launching weasis and building the manifest.

Tip

weasis-pacs-connector services allow either to build a manifest from a PACS via DICOM C-Find or to upload the manifest by http POST.

Build your own connector

This documentation describes how to create your own connector without weasis-pacs-connector and with different DICOM archive types. The weasis protocol allows you to build URIs to launch Weasis according to different configurations and allows to load DICOM files locally or remotely.

Here are examples with XML manifests or with DICOMWeb RESTful services.

Build an XML manifest

Use $dicom:get to load a XML manifest returned by your service.

$dicom:get -w "https://myservice/manifest?studyUID=2.16.756.5.5.100.397184556.14391.1373576413.1508"

Build an XML file containing the UIDs of the images which will be retrieved from Weasis. There is XLS to validate the content of xml. This output file can be either compressed in gzip or uncompressed. Here is an example:

<?xml version="1.0" encoding="UTF-8" ?>
<manifest xmlns="http://www.weasis.org/xsd/2.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <arcQuery additionnalParameters="" arcId="1001" baseUrl="http://archive-weasis.rhcloud.com/archive/wado" requireOnlySOPInstanceUID="false">
        <Patient PatientID="H13885_9M" PatientName="TEST NON SQUARE PIXELS" PatientSex="F">
            <Study AccessionNumber="" ReferringPhysicianName="" StudyDate="20130711" StudyDescription="TEST NON SQUARE PIXELS" StudyID="PKD" StudyInstanceUID="2.16.756.5.5.100.397184556.14391.1373576413.1508" StudyTime="170013">
                <Series Modality="US" SeriesDescription="NON SQUARE PIXELS: PIXEL ASPECT RATIO" SeriesInstanceUID="1.2.40.0.13.1.1.87878503032592846377547034671833520632" SeriesNumber="2">
                    <Instance InstanceNumber="107" SOPInstanceUID="1.2.40.0.13.1.1.126082073005720329436273995268222863740"/>
                </Series>
                <Series Modality="MR" SeriesDescription="NON SQUARE PIXELS: PIXEL SPACING" SeriesInstanceUID="2.16.756.5.5.100.397184556.7220.1373578035.1" SeriesNumber="40001">
                    <Instance InstanceNumber="1" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578035.1.0"/>
                    <Instance InstanceNumber="2" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578035.1.1"/>
                    <Instance InstanceNumber="3" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578035.1.2"/>
                    <Instance InstanceNumber="4" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578035.1.3"/>
                </Series>
                <Series Modality="MR" SeriesDescription="NON SQUARE PIXELS: PIXEL SPACING" SeriesInstanceUID="2.16.756.5.5.100.397184556.7220.1373578664.2" SeriesNumber="50001">
                    <Instance InstanceNumber="1" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578664.2.0"/>
                    <Instance InstanceNumber="2" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578664.2.1"/>
                    <Instance InstanceNumber="3" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578664.2.2"/>
                    <Instance InstanceNumber="4" SOPInstanceUID="2.16.756.5.5.100.397184556.7220.1373578664.2.3"/>
                </Series>
            </Study>
        </Patient>
    </arcQuery>
</manifest>
Note

Important Parameters (except mandatory parameters defined in xsd):

  • PatientBirthDate helps to identify a patient.
  • StudyDate, StudyTime, Modality, SeriesNumber and InstanceNumber help to sort data before downloading images.
  • SeriesDescription and StudyDescription allow immediately displaying the descriptions before downloading the images.

Tip

From Weasis 2.5 it is possible to have multiple archives (allows several arcQuery tags) and the presentations tag which contains the image annotations.

Build an XML manifest (no WADO server)

This example requires only a WEB server. Weasis will download DICOM files by URLs.

Use $dicom:get to load a XML manifest containing direct links Launch

$dicom:get -w "https://nroduit.github.io/demo-archive/Lumbar/mf.xml"

Note

Required Parameters:

  • DirectDownloadFile defines the URL of the DICOM file to download (the final URL is the combination of wadoURL + DirectDownloadFile)
  • DirectDownloadThumbnail defines the URL of the JPEG file representing the series (the final URL is the combination of wadoURL + DirectDownloadThumbnail)
  • See in the previous note above.

Download directly with DICOMWeb RESTful services

This integration requires a PACS/VNA with DICOMweb services (QUERY/RETRIEVE) where the requests are managed directly by Weasis. Here are some of the advantages:

  • Straightforward integration
  • Do not require to install weasis-pacs-connector
  • Allow passing token directly in headers (not in the URL)

The following configurations allow images to be loaded by initiating the request from a WEB context. However, it is possible to access DICOMWeb services by initiating the request directly from the Weasis import.

Use $dicom:rs to load DICOM files. Here are some configuration examples of DICOMweb applications:

dcm4chee-arc-light

This configuration requires at least dcm4chee-arc-light 5.22.2 and Weasis 3.6.0. To activate Weasis in dcm4chee-arc-light user interface, you need to add the four following properties in the web portal from the left menu Configuration > Devices > dcm4chee-arc > Extensions > Edit extension > Child Objects > Web Applications > DCM4CHEE

IID_PATIENT_URL=weasis://$dicom:rs --url "{{qidoBaseURL}}{{qidoBasePath}}" -r "patientID={{patientID}}" --query-ext "&includedefaults=false" -H "Authorization: Bearer {{access_token}}"
IID_STUDY_URL=weasis://$dicom:rs --url "{{qidoBaseURL}}{{qidoBasePath}}" -r "studyUID={{studyUID}}" --query-ext "&includedefaults=false" -H "Authorization: Bearer {{access_token}}"
IID_URL_TARGET=_self

The properties can also be passed directly to the docker-compose.env file:

IID_PATIENT_URL=weasis://$dicom:rs --url "{{qidoBaseURL}}{{qidoBasePath}}" -r "patientID={{patientID}}" --query-ext "\&includedefaults=false" -H "Authorization: Bearer {{access_token}}"
IID_STUDY_URL=weasis://$dicom:rs --url "{{qidoBaseURL}}{{qidoBasePath}}" -r "studyUID={{studyUID}}" --query-ext "\&includedefaults=false" -H "Authorization: Bearer {{access_token}}"
IID_URL_TARGET=_self

Finally, refresh the page for having the viewer button.

Warning

Configuration notes:

  • See configuration for versions before 5.22.2.
  • From 5.24.0 {{qidoBaseURL}} must be replaced by your base URL (e.g. https://pacs2.test.com:8443)
  • The character ‘&’ must be escaped in the Docker environment variables.
  • The Authorization header is not required for unsecure service.
  • URL with HTTPS requires a real valid certificate; otherwise, the certificate must be imported into the Weasis Java keystore. For testing purposes in secure mode, you can use the HTTP URL if it is mapped in the OIDC client of keycloack (–url “http://:8080/dcm4chee-arc/aets/DCM4CHEE/rs”).
Note

Known issue: Weasis cannot open the images because of the token length which is cut by IE and Chrome only under Windows. It is working with Firefox on Windows.

Orthanc WEB Server

https://www.orthanc-server.com/static.php?page=dicomweb

$dicom:rs --url "https://demo.orthanc-server.com/dicom-web" -r "patientID=ozp00SjY2xG"
Launch

Currently, the DICOMWeb service of Orthanc doesn’t support:

  • Thumbnail service is not implemented.

Google Cloud Healthcare API

https://cloud.google.com/healthcare/docs/how-tos/dicomweb

$weasis:config pro="dicom.qido.query.multi.params true" $dicom:rs --url "https://healthcare.googleapis.com/v1beta1/projects/chc-nih-chest-xray/locations/us-central1/datasets/nih-chest-xray/dicomStores/nih-chest-xray/dicomWeb" -r "studyUID=1.3.6.1.4.1.11129.5.5.184301693334578016850836775758484230512396" -H "Authorization: Bearer <your-token>"

Currently, the DICOMWeb service for getting thumbnails doesn’t work in the Google API.

Note

<your-token> must be replaced by a valid token.

DICOMcloud (for Azure cloud)

https://github.com/DICOMcloud/DICOMcloud

$dicom:rs --url "https://dicomcloud.azurewebsites.net/api" -r "studyUID=1.3.6.1.4.1.14519.5.2.1.4429.7055.198257099234774234268879426857"
Launch
Note

The demo server is no longer accessible.

Currently, the DICOMWeb service of DICOMcloud doesn’t support:

  • Thumbnail service is not implemented.

Preferences

ViewerHub (is a separate project that will be available soon) is a tool designed for managing server-side Weasis preferences across all native client installations. The preferences are defined in each release package (bin-dist/weasis/conf within weasis-native.zip) and can be modified either through the ViewerHub web portal or via the Weasis protocol with the pro parameter.

Some server-side preferences are applied by Weasis only during the initial launch, as they can later be adjusted in the Weasis user interface. On the other hand, certain server-side preferences are utilized by Weasis during every launch and cannot be modified through the User Interface (client-side).

Changing Preferences in Weasis

Client-Side Preferences

Local preferences can be modified in the following ways:

  • Through the Weasis User Interface: Navigate to File > Preferences.
  • Using the Weasis Protocol: Use the weasis:config command with the pro parameter.

Server-Side Preferences

Server-side preferences can be updated using any of the following methods:

  • Through the ViewerHub Web Portal: Manage preferences directly via the web portal for all users, for user group or for a specific hostname.
  • By Extending the Configuration File: Create a new JSON file to extend the base.json configuration.

Priority order for loading a property

Here is the priority order to set a property:

  1. Java System property providing from parameters of weasis:config or the launching URI)
  2. Property defined in weasis/conf/xxx.json
  3. The default value of the property (see table below)

Example to change language property (It will work only during the first launch of Weasis on a user session, otherwise delete ${user.home}/.weasis/preferences/).

  1. If you are using weasis-pacs-connector, add the property locale.lang.code:
    http://localhost:8080/weasis-pacs-connector/weasis?patientID=9702672&pro="locale.lang.code%20fr_CH"
  2. Add the property in weasis/conf/xxx.json:
    locale.lang.code=fr_CH
  3. The default value is “en_US”

List of Preferences

The preferences listed below are extracted from the base.json file, which is located in the source code.

The properties are grouped into categories (note: not all categories are shown in the list below), and each property includes the following details:

  1. Property Key: The name of the property, used as a key by the viewer.
  2. Default Value: The property’s default value, provided after the arrow. If it is marked as Null, the property is not set by default.
  3. First Badge: The JavaType of the property, indicating its type in Java (String, Integer, Boolean, etc.).
  4. Second Badge: Represents the Type, defining how the viewer handles the property:
    • F: Processed only during the viewer’s initial launch as it can be adjusted in the client-side preferences.
    • A: Always processed by the viewer.
    • AP: Always processed by the viewer but only from base.json or other .json files.
  5. Description: A brief explanation of the property, provided on the second line.

Dicom Category

  • weasis.aetNull string A
    Calling AETitle for DICOM send and Dicomizer publish. ? null means displaying the DICOM calling node combobox otherwise the combo is not displayed and the value is directly used
  • weasis.dicom.root.uid2.25 string A
    Set values for dicom root UID when creating DICOM objects (KO or PR). See company list at https://www.iana.org/assignments/enterprise-numbers
  • weasis.download.immediatelytrue boolean F
    Start to download series immediately
  • download.concurrent.series3 int A
    The number of concurrently downloaded series
  • download.concurrent.series.images4 int A
    The number of concurrently downloaded images in a series

General Category

  • weasis.themeorg.weasis.launcher.FlatWeasisTheme string F
    FaltLaf Look and feel, see https://www.formdev.com/flatlaf/themes/
  • weasis.confirm.closingfalse boolean F
    Show a message of confirmation when closing the application
  • locale.lang.codeen string F
    Language code (see Java Locale: https://www.oracle.com/java/technologies/javase/jdk20-suported-locales.html). Default value is "en".
  • locale.format.codesystem string F
    If value is "system" then the locale of the operating system will be used (in client-side). See Java Locale: https://www.oracle.com/java/technologies/javase/jdk20-suported-locales.html

Launch Category

  • felix.native.processor.alias.arm_learmv7a string A
    Processor alias for 32-bit arm native libraries
  • weasis.clean.previous.versionfalse boolean A
    If true, the bundle cache is cleared when the weasis version has changed from the previous launch
  • weasis.main.uiweasis-base-ui string A
    Application main user interface bundle. Mandatory with the default launcher.
  • weasis.nameWeasis string AP
    Change the name of the application everywhere in UI
  • weasis.profiledefault string AP
    Application profile: when no profile name is provided, the value is "default". It allows having a custom preferences' directory on the client side (will not share preferences with other Weasis instances)
  • weasis.userNull string AP
    Defines a user name to store its own preferences. Null value will be the system user.
  • weasis.pref.store.local.sessionNull string AP
    Store user preferences when weasis.user is not specified (only with remote preferences service)
  • flatlaf.uiScaleNull string F
    Specifies a custom scale factor used to scale the user interface. Allowed values: e.g. 1.5, 1.5x, 150% or 144dpi (96dpi is 100%)
  • weasis.resources.url${dollar}{weasis.codebase.url}/resources.zip string A
    Application resources (logo, presets, LUTs, dicom annotations configuration...) "resources.zip" is downloaded again only when the last modified date has changed
  • weasis.show.disclaimertrue boolean A
    Show a disclaimer at the first launch of Weasis (requires to be accepted to start the application)
  • weasis.show.releasetrue boolean A
    Show a message when the release has changed
  • weasis.update.releasetrue boolean A
    Show a message when a new release is available
  • weasis.portable.dicom.directorydicom,DICOM,IMAGES,images string A
    For loading automatically DICOMs in the portable Weasis distribution (CD/DVD). Comma-separated directories relative to the Weasis executable file.

Log Category

  • felix.log.level1 int A
    Set the logging levels for OSGI framework 0=None / 1(default)=Error / 2=Warning / 3=Information / 4=Debug
  • org.apache.sling.commons.log.levelINFO string F
    Application logging level. This may be any of the defined logging levels TRACE, DEBUG, INFO, WARN, ERROR
  • org.apache.sling.commons.log.file.activatefalse boolean F
    Activation of rolling log files
  • org.apache.sling.commons.log.file.number20 int F
    The max number of rolling log files
  • org.apache.sling.commons.log.file.size10MB string F
    The max size of a rolling log file
  • org.apache.sling.commons.log.pattern%d{dd.MM.yyyy HH:mm:ss.SSS} *%-5level* [%thread] %logger{36}: %msg%ex{3}%n string F
    Log pattern: {0} The timestamp of type java.util.Date, {1} the log marker, {2} the name of the current thread, {3} the name of the logger, {4} the debug level and {5} the actual debug message.
  • org.apache.sling.commons.log.stack.limit3 int F
    Defines the maximum number of lines for stack trace (0 => NONE, -1 => ALL). Default value is 3
  • audit.logfalse boolean A
    Audit log for giving statistics about usage of Weasis

Ui Category

  • weasis.import.imagestrue boolean A
    Show the import image toolbar and menu
  • weasis.import.dicomtrue boolean A
    Show the DICOM import menu and dialog
  • weasis.import.dicom.qrtrue boolean A
    Show the DICOM Q/R page in the DICOM Export dialog
  • weasis.export.dicomtrue boolean A
    Show the DICOM export menu and dialog
  • weasis.export.dicom.sendtrue boolean A
    Show the send page in the DICOM Export dialog
  • weasis.toolbar.mouse.buttons7170 int A
    Show all mouse buttons. Sum of LEFT=1024 + MIDDLE=2048 + RIGHT=4096 + SCROLL=2. Show all:7170 and show none:0.
  • weasis.all.cinetoolbar.visiblefalse boolean A
    Show all the cine toolbars
  • weasis.all.keyobjecttoolbar.visiblefalse boolean A
    Show all the key object toolbars
  • weasis-dicom-viewer2d.all.rotationtoolbar.visiblefalse boolean A
    Show the rotation toolbars in DICOM 2D viewer
  • weasis.contextmenu.lutShapefalse boolean A
    Show LUT Shape in the contextual menu
  • weasis.contextmenu.lutfalse boolean A
    Show LUT in the contextual menu
  • weasis.contextmenu.filterfalse boolean A
    Show Filter in the contextual menu
  • weasis.plugins.licensetrue boolean A
    Show license activation in Help menu

Viewer Category

  • weasis.color.wl.applytrue boolean F
    Allow applying Window/Level on color images
  • weasis.level.inversetrue boolean F
    Inverse level direction (moving the cursor down to increase brightness
  • weasis.apply.latest.prfalse boolean F
    Apply by default the most recent Presentation State to the related image
  • weasis.force.3dfalse boolean A
    Force to detect a graphic card at every launch
  • weasis.toolbar.mouse.leftwinLevel string F
    Left mouse button action, possible values: pan|winLevel|sequence|zoom|rotation|measure|drawings|contextMenu|crosshair|none
  • weasis.toolbar.mouse.middlepan string F
    Middle mouse button action, possible values: pan|winLevel|sequence|zoom|rotation|measure|drawings|contextMenu|crosshair|none
  • weasis.toolbar.mouse.rightcontextMenu string F
    Right mouse button action, possible values: pan|winLevel|sequence|zoom|rotation|measure|drawings|contextMenu|crosshair|none
  • weasis.toolbar.mouse.wheelsequence string F
    Mouse wheel action, possible values: sequence|zoom|rotation|none

Customize resources

The default resources are located:

  • With ViewerHub you can upload a new package “resources.zip” for a specific release.
  • For the installed distribution in installedPath/app/resources

How to add DICOM nodes or DICOM printers at the server-side

  • From the graphical user interface, configure the DICOM printers from File > Print > DICOM Print or DICOM nodes from File > Preferences > Dicom node list
  • Go to the folder ${user.home}/.weasis/data/weasis-dicom-explorer
  • Copy the desired configuration files: dicomNodes.xml, dicomPrinterNodes.xml, dicomWebNodes.xml and dicomCallingNodes.xml
  • Paste at the root path of resources. For web distribution, unzip, place files and zip again.
  • The new configurations should appear for all the users as non-editable configurations in Weasis

Build Plugins

How to build and install a plugin

This page provides a guide on creating new Weasis plugins and explains how to integrate them into the distributions. For details on configuring the development environment, refer to this guidelines page.

Types of Plugins in Weasis

The following list describes the types of plugins, the interfaces they implement and the factories they use:

  1. Media Viewer or Editor
    • Represents the main central panel and implements either ViewerPlugin or ImageViewerPlugin.
    • The factory for this type implements SeriesViewerFactory.
    • For DICOM special modalities, you can use DicomSpecialElementFactory to associate a viewer to a specific DICOM object.
  2. Toolbar Associated with a Viewer
    • Implements the Toolbar or DynamicToolbar interface.
    • The factory for this type implements InsertableFactory
  3. Tool Associated with a Viewer
    • Represents the right panel and implements DockableTool.
    • The factory for this type implements InsertableFactory.
  4. Data Explorer
    • The explorer model implements DataExplorerModel.
    • The explorer view implements DataExplorerView.
    • The factory for this type implements DataExplorerViewFactory.
  5. Import Data into an Explorer
    • Adds a new page into the DICOM Import UI with ImportDicom.
    • The factory for this type implements DicomImportFactory.
  6. Export Data from an Explorer
    • Adds a new page into the DICOM Export UI with ExportDicom
    • The factory for this type implements DicomExportFactory.
  7. Media Codec
    • Implements the Codec interface to decode and encode media files related to a file extension or a mime type.
  8. Preferences
    • Implements PreferencesPageFactory to add a new page in the Preferences dialog.
  9. UI Aggregator
    • Represents the bundle for the application’s main user interface which aggregates various interface components.
    • The Maven artifact for this bundle must be defined in the base.json file (e.g., code:weasis.main.ui value:weasis-base-ui).
Note

The factories are used to create the instances of the plugins and are registered as OSGi services. For performance reasons, the factories are created at startup and the plugins are created only if they are needed.

Tip

For more information about the plugin hierarchy and their relationships, refer to the Weasis Architecture.

Building Plugins Using Maven Archetype

  1. To add the Weasis archetypes to your local Maven repository, go to the Weasis/archetype directory and execute the following command:
       mvn install
  2. Navigate to the target folder, which should be the parent folder of the new plugin project, and execute the following command to create your plugin:
       mvn archetype:generate -DarchetypeCatalog=local
  3. When prompted, enter the number of one of the archetypes. Currently, the following archetypes are available:
    • weasis-plugin-base-viewer-archetype: Example of a toolbar and tool for a non-DICOM viewer.
    • weasis-plugin-dicom-viewer-archetype: Example of a toolbar and tool for a DICOM viewer.
  4. Modify the generated project as needed.
    • In the pom.xml file, ensure the <relativePath> tag corresponds to the location of your Weasis source folder. By default, the value is <relativePath>../Weasis/weasis-parent/pom.xml</relativePath> (In this scenario, the plugin resides in the same parent folder as the Weasis source code).
    • When the relative path is set correctly, <version>${revision}${changelist}</version> in the pom.xml file will automatically be updated to the latest version of the Weasis source.
    • For easier version management in the pom.xml, you can remove <version> at the project level to inherit it from the parent.
  5. Build the plugin by executing the following command in the plugin project directory:
       mvn clean install

Integrating Plugins into Weasis Distributions

Once the plugin is built, it can be integrated into the Weasis distributions either locally or remotely.

Warning

The plugin depends on the Weasis framework, and its version must align with the version of the Weasis distribution being integrated.
If the versions do not match, the plugin may fail to start and produce an error such as org.osgi.framework.BundleException: Unable to resolve myplugin ….

Testing the Plugin

To test the plugin with an installed version of Weasis without making any changes to the installed directory, create a JSON file that extends the configuration specified in base.json.

  1. Create a new json file (e.g., myplugin.json) with the following content:
    {
      "weasisPreferences": [
        {
          "code": "org.osgi.framework.startlevel.beginning",
          "value": "550"
        },
        {
          "code": "felix.auto.start.500",
          "value": "file:///git/myplugin/target/myplugin-4.5.2.jar",
          "description": "Myplugin - a viewer for ..."
        }
      ]
    }
  2. Update the content of myplugin.json as required:
    • Ensure the plugin start level (above 500) is lower than the OSGi beginning level (above 550). Avoid using values below this range to prevent conflicts with other plugins.
    • For easier testing, use an absolute JAR path that matches your local plugin directory. Use a URI format for the path like:
        file:///D:/git/myplugin/target/myplugin-4.5.2.jar
      
        file:///git/myplugin/target/myplugin-4.5.2.jar
      
        file:///git/myplugin/target/myplugin-4.5.2.jar
      
  3. Launch Weasis with your configuration:
    • Use the following parameter to extend the configuration (adapt the path to your local file):
        $weasis:config pro="felix.extended.config.properties file:///D:/git/myplugin/myplugin.json"
      
        $weasis:config pro="felix.extended.config.properties file:///git/myplugin/myplugin.json"
      
        $weasis:config pro="felix.extended.config.properties file:///git/myplugin/myplugin.json"
      
    • Build a valid URI with the above parameter (see How to build an URI) and launch Weasis from the command on a terminal:Construct a valid URI using the parameter mentioned above (refer to How to build a URI)) and launch Weasis from the terminal using a command:
        start weasis://%24weasis%3Aconfig%20pro%3D%22felix.extended.config.properties%20file%3A%2F%2F%2FD%3A%2Fgit%2Fmyplugin%2Fmyplugin.json%22
      
        xdg-open weasis://%24weasis%3Aconfig%20pro%3D%22felix.extended.config.properties%20file%3A%2F%2F%2Fgit%2Fmyplugin%2Fmyplugin.json%22
      
        open weasis://%24weasis%3Aconfig%20pro%3D%22felix.extended.config.properties%20file%3A%2F%2F%2Fgit%2Fmyplugin%2Fmyplugin.json%22
      

Using ViewerHub

This feature will be available soon. It will allow you to manage the plugins and their configurations directly from the ViewerHub web portal.

Build OSGi Services

All the plugin type described in the list above are OSGi services that are registered and aggregated in the GUI. Building the plugin from the Maven archetype will configure the OSGi service automatically. For adding new OSGi services, here is the procedure:

  1. Create a class that implements the Insertable interface and represents a visual component. For example:

    public class MyPrefView extends AbstractItemDialogPage {
    
       public MyPrefView() {
           super("My Preferences", 100); // Provide a name and the page position
           initGUI();
       }
    
       private void initGUI() {
           // Add a basic JLabel to the preference panel for demonstration
           add(new JLabel("Welcome to My Preferences!"));
       }
    
       @Override
       public void closeAdditionalWindow() {
           // Handle any cleanup or saving preferences when closing
       }
    
       @Override
       public void resetToDefaultValues() {
           // Reset preferences to default values
       }
    }

  2. Create a class that implements one of the plugin factories and include the annotations @Component and the @Service parameter. For example:

    @org.osgi.service.component.annotations.Component(service = PreferencesPageFactory.class)
    public class MyViewerPrefFactory implements PreferencesPageFactory {
    
        @Override
        public AbstractItemDialogPage createInstance(Hashtable<String, Object> properties) {
        return new MyPrefView();
        }
        
        @Override
        public boolean isComponentCreatedByThisFactory(Insertable component) {
        return component instanceof MyPrefView;
        }
    }
    Tip

    For more details on annotations, refer to the Apache Felix SCR Annotations documentation.

Weasis Commands

The commands listed below can be applied at start-up or in a telnet session. All the commands starting with “dcmview2d:” allow you to drive Weasis and are not adapted to be used at start-up.

Info

This page matches to Weasis 3.5.1 or higher. The syntax of usage comes from POSIX.

To obtain the list of commands, after starting Weasis, open a local telnet session of the OSGI Console and type lb for getting the list of bundles and their state or type help for getting all the available commands:

telnet localhost 17179

Trying 127.0.0.1...

Connected to localhost.localdomain.

Escape character is '^]'.

____________________________

Welcome to Apache Felix Gogo

g!

List of Weasis commands

dcmview2d:layout

g! dcmview2d:layout
Select a split-screen layout
Usage: dcmview2d:layout ( -n NUMBER | -i ID )
  -n --number=NUMBER  select the best matching number of views
  -i --id=ID          select the layout from its identifier
  -? --help           show help

dcmview2d:mouseLeftAction

g! dcmview2d:mouseLeftAction
Change the mouse left action
Usage: dcmview2d:mouseLeftAction COMMAND
COMMAND is (sequence|winLevel|zoom|pan|rotation|crosshair|measure|draw|contextMenu|none)
  -? --help       show help

dcmview2d:move

g! dcmview2d:move
Pan the selected image
Usage: dcmview2d:move -- X Y
X and Y are Integer. It is mandatory to have '--' (end of options) for negative values
  -? --help       show help

dcmview2d:reset

g! dcmview2d:reset

Reset image display
Usage: dcmview2d:reset (-a | COMMAND...)
COMMAND is (winLevel|zoom|pan|rotation)
  -a --all        reset to original display
  -? --help       show help

dcmview2d:scroll

g! dcmview2d:scroll
Scroll into the images of the selected series
Usage: dcmview2d:scroll ( -s NUMBER | -i NUMBER | -d NUMBER)
  -s --set=NUMBER       set a new value from 1 to series size
  -i --increase=NUMBER  increase of some amount
  -d --decrease=NUMBER  decrease of some amount
  -? --help             show help

dcmview2d:synch

g! dcmview2d:synch
Set a synchronization mode
Usage: dcmview2d:synch VALUE
VALUE is (None|Stack|Tile)
  -? --help       show help

dcmview2d:wl

g! dcmview2d:wl
Change the window/level values of the selected image (increase or decrease into a normalized range of 4096)
Usage: dcmview2d:wl -- WIN LEVEL
WIN and LEVEL are Integer. It is mandatory to have '--' (end of options) for negative values
  -? --help       show help

dcmview2d:zoom

g! dcmview2d:zoom
Change the zoom value of the selected image
Usage: dcmview2d:zoom (set VALUE | increase NUMBER | decrease NUMBER)
  -s --set=VALUE        [decimal value]  set a new value from 0.0 to 12.0 (zoom magnitude, 0.0 => default, -200.0 => best fit, -100.0 => real size)
  -i --increase=NUMBER  increase of some amount
  -d --decrease=NUMBER  decrease of some amount
  -? --help             show help

dicom:get

g! dicom:get
Load DICOM files remotely or locally
Usage: dicom:get ([-l PATH]... [-w URI]... [-r URI]... [-p] [-i DATA]... [-z URI]...)
PATH is either a directory(recursive) or a file
  -l --local=PATH   open DICOMs from local disk
  -r --remote=URI   open DICOMs from an URI
  -w --wado=URI     open DICOMs from an XML manifest
  -z --zip=URI      open DICOM ZIP from an URI
  -p --portable     open DICOMs from configured directories at the same level of the executable
  -i --iwado=DATA   open DICOMs from an XML manifest (GZIP-Base64)
  -? --help         show help

dicom:close

g! dicom:close
Close DICOM files
Usage: dicom:close  (-a | ([-y UID]... [-s UID]...))
  -a --all           close all the patients
  -p --patient=ID    close a patient from its patient ID (since v4.4.1)
  -y --study=UID     close a study, UID is Study Instance UID
  -s --series=UID    close a series, UID is Series Instance UID
  -? --help          show help

dicom:rs

g! dicom:rs
Load DICOM files from DICOMWeb API (QIDO/WADO-RS)
Usage: dicom:rs -u URL -r QUERYPARAMS... [-H HEADER]... [--query-header HEADER]... [--retrieve-header HEADER]... [--query-ext EXT] [--retrieve-ext EXT] [--accept-ext EXT]
  -u --url=URL               URL of the DICOMWeb service
  -r --request=QUERYPARAMS   Query params of the URL, see weasis-pacs-connector
  -H --header=HEADER         Pass custom header(s) to all the requests
  --query-header=HEADER      Pass custom header(s) to the query requests (QIDO)
  --retrieve-header=HEADER   Pass custom header(s) to the retrieve requests (WADO)
  --query-ext=EXT            Additionnal parameters for Query URL (QIDO)
  --retrieve-ext=EXT         Additionnal parameters for Retrieve URL (WADO)
  --accept-ext=EXT           Additionnal parameters for DICOM multipart/related Accept header of the retrieve URL (WADO). Default value is: transfer-syntax=*
  --show-whole-study         when downloading a series, show all the other series (ready for download) from the same study
  -? --help                  show help

image:get

g! image:get
Load images remotely or locally
Usage: image:get ([-f file]... [-u url]...)
  -f --file=FILE     open an image from a file
  -u --url=URL       open an image from an URL
  -? --help          show help

image close

g! image:close
Close images
Usage: dicom:close (-a | ([-g UID]... [-s UID]...))
  -a --all         close all series
  -g --group=UID   close a group from its UID
  -s --series=UID   close an series/image from its UID
  -? --help        show help

weasis:info

g! weasis:info
Show information about Weasis
Usage: weasis:info (-v | -a)
  -v --version    show version
  -a --all        show weasis specifications
  -? --help       show help

weasis:ui

g! weasis:ui
Manage user interface
Usage: weasis:ui (-q | -v)
  -q --quit     shutdown Weasis
  -v --visible  set window on top
  -? --help     show help

acquire:patient

g! acquire:patient
Load Patient Context from the first argument
Usage: acquire:patient (-x | -i | -s | -u) arg
arg is an XML text in UTF8 or an url with the option '--url'
  -x --xml         open Patient Context from an XML data containing all DICOM Tags
  -i --inbound     open Patient Context from an XML data containing all DICOM Tags, decoding syntax is [Base64/GZip]
  -s --iurlsafe    open Patient Context from an XML data containing all DICOM Tags, decoding syntax is [Base64_URL_SAFE/GZip]
  -u --url         open Patient Context from an URL (XML file containing all DICOM TAGs)
  -? --help        show help

weasis:config (only at launch)

This command can be used only at launch, see Modify the launch parameters

Note

For identifying the commands at start-up, the symbol “$” must be added before the command (not required in the OSGI console). See examples below.

Warning

Special characters: A command containing special characters like ‘&’ or space must be within quotes or double quotes. Example:

dicom:get -w "http://localhost/weasis-pacs-connector/manifest?patientID=97026728&modalitiesInStudy=MR"

Depending the command line system, quotes or double quote needs to be escaped with a backslash. Ex. simple quote must be escaped in Eclipse but not in Intellij.

Dicom Conformance

Compatibility of DICOM Transfer Syntax

This table lists the DICOM Transfer Syntaxes supported by Weasis.

Transfer Syntax UID Media Type Description Read Write
1.2.840.10008.1.2 Implicit VR - Little Endian yes No
1.2.840.10008.1.2.1 Explicit VR - Little Endian yes Yes
1.2.840.10008.1.2.1.99 Deflated Explicit VR Little Endian yes No
1.2.840.10008.1.2.2 Explicit VR Big Endian (Retired) yes No
1.2.840.10008.1.2.5 RLE (Run Length Encoding) Lossless yes No
1.2.840.10008.1.2.4.50 image/jpeg JPEG Baseline (Process 1): Default Transfer Syntax for Lossy JPEG 8 Bit Image Compression yes Yes
1.2.840.10008.1.2.4.51 image/jpeg JPEG Extended (Process 2 & 4): Default Transfer Syntax for Lossy JPEG 12 Bit Image Compression (Process 4 only) yes Yes
1.2.840.10008.1.2.4.53 image/jpeg JPEG Spectral Selection, Non-Hierarchical (Process 6 & 8) (Retired) yes No
1.2.840.10008.1.2.4.55 image/jpeg JPEG Full Progression, Non-Hierarchical (Process 10 & 12) (Retired) yes No
1.2.840.10008.1.2.4.57 image/jpeg JPEG Lossless, Non-Hierarchical (Process 14) yes Yes
1.2.840.10008.1.2.4.70 image/jpeg JPEG Lossless, Non-Hierarchical, First-Order Prediction (Process 14 [Selection Value 1]) yes Yes
1.2.840.10008.1.2.4.80 image/jls JPEG-LS Lossless Image Compression yes Yes
1.2.840.10008.1.2.4.81 image/jls JPEG-LS Lossy (Near-Lossless) Image Compression yes Yes
1.2.840.10008.1.2.4.90 image/jp2 JPEG 2000 Image Compression (Lossless Only) yes Yes
1.2.840.10008.1.2.4.91 image/jp2 JPEG 2000 Image Compression yes Yes
1.2.840.10008.1.2.4.92 image/jpx JPEG 2000 Part 2 Multi-component Image Compression (Lossless Only) yes No
1.2.840.10008.1.2.4.93 image/jpx JPEG 2000 Part 2 Multi-component Image Compression yes No
1.2.840.10008.1.2.4.201 image/jphc High-Throughput JPEG 2000 Image Compression (Lossless Only) yes No
1.2.840.10008.1.2.4.202 image/jphc High-Throughput JPEG 2000 with RPCL Options Image Compression (Lossless Only) yes No
1.2.840.10008.1.2.4.203 image/jphc High-Throughput JPEG 2000 Image Compression yes No

Transfer Syntax UID Media Type Description Read Write
1.2.840.10008.1.2.6.1 mime type RFC 2557 MIME Encapsulation yes No
1.2.840.10008.1.2.4.100 video/mpeg MPEG-2 Main Profile Main Level yes No
1.2.840.10008.1.2.4.101 video/mpeg MPEG-2 Main Profile High Level yes No
1.2.840.10008.1.2.4.102 video/mp4 MPEG-4 AVC/H.264 High Profile / Level 4.1 yes No
1.2.840.10008.1.2.4.103 video/mp4 MPEG-4 AVC/H.264 BD-compatible High Profile / Level 4.1 yes No
1.2.840.10008.1.2.4.104 video/mp4 MPEG-4 AVC/H.264 High Profile / Level 4.2 For 2D Video yes No
1.2.840.10008.1.2.4.105 video/mp4 MPEG-4 AVC/H.264 High Profile / Level 4.2 For 3D Video yes No
1.2.840.10008.1.2.4.106 video/mp4 MPEG-4 AVC/H.264 Stereo High Profile / Level 4.2 yes No
1.2.840.10008.1.2.4.107 video/H265 HEVC/H.265 Main Profile / Level 5.1 yes No
1.2.840.10008.1.2.4.108 video/H265 HEVC/H.265 Main 10 Profile / Level 5.1 yes No
Note

The latter groups of TSUIDs are opened by the default system application associated with the MIME type.

Supported “Photometric Interpretation” pixel format

This table lists the Photometric Interpretation supported by Weasis.

Photometric Interpretation Description Supported
MONOCHROME1 grey level image description (high values=dark, low values=bright) yes
MONOCHROME2 grey level image description (high values=bright, low values=dark) yes
PALETTE COLOR pseudo color image description yes
RGB true color image description yes
YBR_FULL true color image description yes
YBR_FULL_422 true color image description yes
YBR_PARTIAL_422 true color image description (Retired) yes
YBR_PARTIAL_420 true color image description yes
YBR_ICT true color image description (JPEG-2000) yes
YBR_RCT true color image description (JPEG-2000) yes

ViewerHub

ViewerHub is the successor to weasis-pacs-connector. This is a server component with an administration interface for managing preferences, plugins and versions of Weasis with DICOM archives.

Essentially, it simplifies the management of Weasis in IT environments and facilitates connections to DICOM archives.

The main features of ViewerHub are:

  • Management of Weasis user preferences
  • Control of launch contexts and profiles by user, group, or host
  • Handling of live minor version updates of Weasis at the client side
  • Management of Weasis translation packages
  • Integration with connectors for DICOM archives
  • Configuration of Keycloak clients and token transmission for DICOMWeb or WADO URI calls

Here is a list of pages related to ViewerHub documentation:

Subsections of ViewerHub

Subsections of User Guide

Package Versioning

Manual Import

A version of Weasis can be manually imported into ViewerHub in the tab “Package”.

manual_import.png manual_import.png

The file to be imported must have a name in this format: “weasis-native xxx.zip”.

location_native_zip_file.png location_native_zip_file.png

This file corresponds to one of the Weasis release versions produced here: https://github.com/nroduit/Weasis/releases/

Import process

The import process of a Weasis version follows these different steps:

  • Retrieval of the “weasis-native xxx.zip” file, decompression and storage of the version’s resources/bundles in minio/S3.
  • Compression of the version’s “resources” folder into a zip file (necessary for Weasis) and storage on S3. resource_zip_compression.png resource_zip_compression.png
  • Update on S3 of the Weasis version compatibility file if the imported version is more recent. minio_mapping-minimal-version.png minio_mapping-minimal-version.png
  • Cache update regarding Weasis version compatibility mapping.
  • Loading of the version’s properties into the database.

Nexus Import

Currently not available, will be implemented later.

Remove Weasis package version

In order to delete a version of Weasis, it is necessary to select the version to delete, then right-click and confirm the deletion.

delete_version_right_click.png delete_version_right_click.png

Deleting a version whose “launch config” is “default” will result in the deletion of all versions linked to this “default”.

delete_default_version_propagation.png delete_default_version_propagation.png

Group-specific versions

It is possible to create a version of Weasis that will only be launched for certain groups of users or hosts.

In the “package” view, click on “Create new group config”.

create_new_package_version_location.png create_new_package_version_location.png

Then select the desired Weasis version (package version + launch config) and the new group to associate then press “Create”.

create_new_package_version.png create_new_package_version.png

The new version will thus be displayed in the list of versions already present.

If the user or host belongs to the group, the previously created configuration will be used to launch Weasis.

Configuring version properties

ViewerHub allows to modify the properties of versions on-the-fly.

To modify a property, it is necessary to open a version and double-click on the property to modify.

For example to modify the name of the viewer for a package/launch config/group:

  • modification of the property “weasis.name”

rename_weasis_name_property.png rename_weasis_name_property.png

  • launching the viewer after modification: the label corresponds to the modified property

result_rename_property.png result_rename_property.png

Internationalization

Import

It is possible to import the translations that will be used by Weasis depending on the version of Weasis launched and the correspondence of this version with the compatibility file.

The name of the file to import must have the format “weasis-i18n-dist-X.X.X-SNAPSHOT.zip”.

The translation zip files to import are present at this address: https://github.com/nroduit/weasis-i18n

In ViewerHub, management of translation packages is located in the “Translation” tab.

manual_import.png manual_import.png

The import will decompress the zip file and load the translation resources into the MinIO S3.

s3_i18n_package.png s3_i18n_package.png

Removal

Deleting a translation version is done by selecting the version and right-clicking on this version and then confirming the deletion.

delete_i18n_package.png delete_i18n_package.png

Package Qualifier

Default values

When calling the ViewerHub, Weasis will send in an Http header the version installed on the client workstation (User-Agent header).

If the corresponding Weasis version has not been installed on ViewerHub and/or when no qualifier has been associated with the user/host/group making the request, a version and/or a qualifier are used by default to retrieve the resources to launch Weasis.

These default values are defined in the config-server in the application-package.yml file.

Qualifier mapping to user/host/group

In order to be able to test specific versions or to be able to launch a version of Weasis different from the default one for a group, it is possible to specify the version to launch for a user/host/group by mapping a particular qualifier.

group_config_creation.png group_config_creation.png

In order to use this feature:

  • the weasis-native.zip file containing the specific version must be loaded into ViewerHub and associated with a group.
  • the “qualifier” property must be defined in the launch_prefered table and must be of type “qualifier”.

launch_preferred_qualifier.png launch_preferred_qualifier.png

  • the mapping of the qualifier to use this version must be done at the launch table level for the target/launch_config/launch_preferred association.
    If this mapping is not done, the default qualifier defined in ViewerHub configuration will be taken into account (see previous paragraph).
    In order to do this mapping, you must define a configuration in the launch table associating the desired group/launch_config, the previous launch_preferred “qualifier” and for the “selection” column specify the qualifier to launch.

launch_qualifier.png launch_qualifier.png

Version Compatibility

Compatibility file

A compatibility file named “version-compatibility.json” is present in each Weasis release
(in the weasis-native.zip file => bin-dist => weasis => conf).

This file contains the mapping between the release version (“release-version”) and the minimum version of Weasis that should be installed on the client workstation (“minimal-version”).

This file also indicates which translation version should be used (“i18n-version”).

version_compatibility_file.png version_compatibility_file.png

Cache

When uploading a new version in ViewerHub or when starting the application (in case the compatibility file is already present in the S3), ViewerHub will construct the different possible combinations from the compatibility file between the versions installed in ViewerHub and the Weasis releases.

These combinations will be stored in a redis cache. This cache is currently refreshed every 24 hours.

So when a client will launch Weasis via ViewerHub, it will directly know which version, i18n, resources to use when launching Weasis on the user computer.

Minio/S3

By importing a new version of Weasis into ViewerHub, if the compatibility file is more recent, ViewerHub will replace the compatibility file present on the S3. This compatibility file will be renamed on S3 “mapping-minimal-version.json”

s3_compatibility_file.png s3_compatibility_file.png

In order to compare if this mapping file is more recent, ViewerHub will compare the version number of the latest release.

Groups

To easily manage your computer network, ViewerHub allows the creation and association of user or host groups.

Creation

Users, hosts, user groups and host groups are represented by ‘targets’.

There are 4 types of target:

  • user
  • host
  • user group
  • host group

To create a target, go to the ‘association’ menu and define the type of target to be created.

target_creation_menu.png target_creation_menu.png

target_creation_popup.png target_creation_popup.png

Group association

To associate a target with a group or a host/user, look for the desired target in the target name section and add the group or host/user in the ‘Belongs to/Member of’ section.

group_association.png group_association.png

It is possible to associate several users with a user group and several hosts with a host group.

group_association_result.png group_association_result.png

It is not possible to mix up the association between a user and a host group or a host in a user group.

Imaging Hub

This page describes how to install the Imaging Hub, a Docker Compose stack for managing dcm4chee PACS, ViewerHub, and related services.

Warning

This stack is designed for development and testing purposes only. It enables debugging ViewerHub and testing integration with dcm4chee PACS. It is not suitable for production use.

Included Services

This stack comprises the following components:

  • dcm4chee: PACS server for storing and retrieving medical images.
  • ViewerHub: Manages resources for different versions of Weasis.
  • MinIO: Object storage server compatible with Amazon S3 APIs.
  • Redis: Cache service storing manifest data for Weasis resources.
  • Postgres: Database backend for ViewerHub and dcm4chee.
  • Keycloak: Manages user authentication and access.
  • Config-server: Manages configuration of all services.
  • Eureka: Provides service discovery for stack components.

Prerequisites

  • Docker
  • Docker Compose CLI

Configurations

This stack supports multiple configurations:

  • Debug (local): Includes all the required stack except ViewerHub and uses local volumes.
  • Unsecure (unsecure): Enables HTTP and uses development-grade settings. dcm4chee and ViewerHub services have no authentication.
  • Secure (secure) [Not yet available]: Enables HTTPS and uses production-grade settings. dcm4chee and ViewerHub services have authentication.

Usage

Run the following commands based on the environment:

  • For debugging ViewerHub:
    ./scripts/start.sh local
    And then run ViewerHub from your IDE

Minio

Minio is an open-source object storage server compatible with Amazon S3 APIs. It is used to store resources required by the different versions of Weasis.

Access the Minio console at: http://localhost:9090

Use the following credentials:

  • User: weasis-manager
  • Password: weasis-manager

Keycloak

Keycloak is an open-source identity and access management server used to authenticate users.

Access the Keycloak console at: http://localhost:8085

Use the following credentials:

  • User: admin
  • Password: admin

Dcm4chee

Dcm4chee is a PACS server that enables storing and retrieving medical images.

Access the dcm4chee console at: http://localhost:8080/dcm4chee-arc/ui2/en/study/study

For secure mode, access the dcm4chee console at: https://localhost:8443/dcm4chee-arc/ui2/en/study/study Use the following credentials:

  • User: admin
  • Password: changeit

ViewerHub

ViewerHub is a web application that manages the resources required by the different versions of Weasis.

Access the ViewerHub console at: http://localhost:8081

Use the following credentials:

  • User: weasis-manager-user
  • Password: weasis-manager-password

Guidelines for development

This page provides guidelines for developing and debugging ViewerHub.

We recommend the use of IntelliJ IDEA because the following instructions are based on it.

Add a Launcher

  • Open Run > Edit Configurations…
  • Aad in VM options the following properties:
  -Duser.timezone=UTC
  -DENVIRONMENT=local
  -DEUREKA_CLIENT_SERVICE_URL_DEFAULT_ZONE=http://localhost:8761/eureka
  -DREGION=local
  -DDATACENTER=local
  -Dserver.port=8081
  -Dmanagement.server.port=19001
  -DBACKEND_URI=http://localhost:8081
  -DDB_HOST=localhost
  -DDB_PORT=45101
  -DDB_NAME=weasis-manager
  -DDB_USER=weasis-manager
  -DDB_PASSWORD=weasis-manager
  -DCONFIGSERVER_URI=http://configdecrypt:987654321@localhost:8888
  -DS3_ACCESS_KEY=access-key
  -DS3_SECRET_KEY=secret-key
  -DS3_ENDPOINT=http://localhost:9080
  -DS3_BUCKET_NAME=weasis-manager-bucket
  -DBACKEND_URI=http://localhost:8081
  • Then clean/install + Run…

ViewerHub

In order to access to ViewerHub:

http://localhost:8081

with

User: weasis-manager-user
Password: weasis-manager-password

Launch Weasis

Once all the steps above completed, launch the below URL to launch Weasis and load the dicom image stored in the dcm4chee pacs:

http://localhost:8081/display/weasis?studyUID=1.3.12.2.1107.5.1.4.54023.30000004093013443132800000021&archive=dcm4chee-local

This URL works with the Imaging Hub stack. If you are using a different setup, you may need to adjust the URL accordingly.

For more information, refer to the Launch APIs documentation.

Connectors

This page outlines the configuration of connectors used by ViewerHub to connect to DICOM archives.

Model

In order to create the Weasis manifest, connectors are configured to enable connections to various PACS or VNA systems.
Three types of connectors are defined in the configuration server: DB, DICOM, and DICOM_WEB.

These connectors are defined according to this model: connector_model.yml

Global connector configuration

The global connector configuration is defined as follows:

connector:
    # If value is present: use the connectors specified, if not present or wrong connector ids: use all the valid connectors defined in the config
    default: # connectorId1, connectorId2
    
    config:
        connector-id:
            type:  # Type of connector used => DB, DICOM, DICOM_WEB
            
            # ------- Search Criteria ----
            search-criteria:
                deactivated: # If a search criteria needs to be deactivated=> SOP_INSTANCE_UID, SERIE_INSTANCE_UID, STUDY_INSTANCE_UID, STUDY_ACCESSION_NUMBER, PATIENT_ID

WADO configuration

WADO configuration is used by Weasis to retrieve images from manifest

WADO:
    authentication:
        # Used to force usage of basic authentication parameters to retrieve images (even if request is authenticated)
        force-basic: # true/false
        
        # If request is authenticated,retrieve the token from the authenticated request and inject it in the manifest for Weasis to get the images
        oauth2:
            url: # Url used to retrieve images by adding authenticated request token in manifest
        
        # Retrieve the images by using this basic authentication parameters
        basic:
            url: # Url used to retrieve images by using basic authentication
            login:  # Basic credential login 
            password: # Basic credential password

Database connector

This connector is used to be able to connect to the PACS database in order to find the studies, series, instances of images for the construction of the manifest.

db-connector:
    user: # Database user
    password: # Encoded password
    uri: # Database uri
    driver: # Database driver
    query:
        select: # SQL query to retrieve patientName, patientId, patientBirthDate, patientSex, studyInstanceUid, studyDate, accessionNumber, studyId, referringPhysicianName, studyDescription, seriesInstanceUid, modality, seriesDescription, seriesNumber, sopInstanceUid, instanceNumber
        accession-number-column: # Accession number column used in the SQL query above
        patient-id-column: # Patient id column used in the SQL query above
        study-instance-uid-column: # Study instance uid column used in the SQL query above
        serie-instance-uid-column: # Serie instance uid column used in the SQL query above
        sop-instance-uid-column: # Sop instance uid column used in the SQL query above

DICOM connector

This connector is used to be able to connect to the pacs in DICOM in order to find the studies, series, instances of images for the construction of the manifest.

dicom-connector:
    calling-aet: # Calling aet
    aet: # Aet
    host: # Host
    port: # Port

DICOM Web connector

Not implemented yet

Launch APIs

Launch Weasis from your own web application

The display service is available at the URL: http://localhost:8081/display/weasis

To launch Weasis from your own web application, you need to build the URL with the following parameters:

  • archive: The archive name to be used to retrieve the study. The list of archives is defined in the config server.
  • patientID: The Patient ID of the study to be displayed. Note to handle a universal patientID, add IssuerOfPatientID like in hl7: patientID=1168514^^^issuerValue
    • Ex: http://localhost:8081/display/weasis?patientID=1168514&archive=dcm4chee-local
    • Ex with multiple patientID: http://localhost:8081/display/weasis?patientID=1168514&patientID=2023231696&archive=dcm4chee-local
    • Ex with URL encoding of separators ^^^ and IssuerOfPatientID value test: http://localhost:8081/display/weasis?patientID=1168514%5E%5E%5Etest&archive=dcm4chee-local
  • studyUID: The Study Instance UID of the study to be displayed.
    • Ex: http://localhost:8081/display/weasis?studyUID=1.3.12.2.1107.5.1.4.54023.30000004093013443132800000021&archive=dcm4chee-local
  • accessionNumber: The Accession Number of the study to be displayed.
    • Ex: http://localhost:8081/display/weasis?accessionNumber=2066852&archive=dcm4chee-local
  • seriesUID: The Series Instance UID of the series to be displayed.
    • Ex: http://localhost:8081/display/weasis?seriesUID=1.3.12.2.1107.5.1.4.54023.30000004093016410718700008612&archive=dcm4chee-local
    • Ex with multiple studies and series: http://localhost:8081/display/weasis?studyUID=1.3.6.1.4.1.5962.1.2.2.20031208063649.855&studyUID=1.3.6.1.4.1.5962.1.2.2.20031208063649.857&seriesUID=1.2.840.113704.1.111.4924.1273631010.17&archive=dcm4chee-local
  • objectUID: The SOP Instance UID of the object to be displayed.
    • Ex: http://localhost:8081/display/weasis?objectUID=1.3.12.2.1107.5.1.4.54023.30000004093016410718700010432&archive=dcm4chee-local

Filters

  • mostRecentResults: The number of the most recent studies to be displayed.
    • Ex: http://localhost:8081/display/weasis?patientID=11685148&mostRecentResults=2
  • modalitiesInStudy: Filter the studies containing the specified modalities.
    • Ex with only CT or XA: http://localhost:8081/display/weasis?patientID=1168514&modalitiesInStudy=CT,XA&archive=dcm4chee-local
  • containsInDescription: Filter the studies containing the specified string in the study description. Note that the search is case-insensitive and diacritic-insensitive.
    • Ex with only coronary or thorax: http://localhost:8081/display/weasis?patientID=1168514&containsInDescription=coronary,thorax&archive=dcm4chee-local
  • lowerDateTime: Filter the studies which are older than the specified date.
    • Ex CT older than 01.01.2010 12:00:00: http://localhost:8081/display/weasis?patientID=1168514&modalitiesInStudy=CT&lowerDateTime=2010-01-01T12:00:00Z&archive=dcm4chee-local
  • upperDateTime: Filter the studies which are more recent than the specified date.
    • Ex CT more recent than 01.01.2010 12:00:00: http://localhost:8081/display/weasis?patientID=1168514&modalitiesInStudy=CT&upperDateTime=2010-01-01T12:00:00Z&archive=dcm4chee-local
Note

You can restrict the types of UIDs (patientID, studyUID, accessionNumber, seriesUID, objectUID) that services can access. Refer to the “request.ids” section in the configuration file to specify which UIDs are permitted. By default, all UIDs are allowed.

Launch Weasis with IHE IID profile

he Invoke Image Display Profile enables an Image Display Invoker, typically a non-image-aware system such as an EHR, PHR, or RIS, to request the display of patient studies, which are then presented by an image-aware system like an Image Display (PACS). The display service is available at the URL: http://localhost:8081/display/IHEInvokeImageDisplay

To launch Weasis with IHE IID profile, you need to build the URL with the following parameters:

  • archive: The archive name to be used to retrieve the study. The list of archives is defined in the config server.
  • requestType: The type of the request (PATIENT, STUDY)
  • patientID: The Patient ID of the study to be displayed. Note to handle a universal patientID, add IssuerOfPatientID like in hl7: patientID=1168514^^^issuerValue
  • studyUID: The Study Instance UID of the study to be displayed.
    • Ex: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=STUDY&studyUID=1.3.12.2.1107.5.1.4.54023.30000004093013443132800000021
  • accessionNumber: The Accession Number of the study to be displayed.
    • Ex: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=STUDY&accessionNumber=2066852

Filters

  • mostRecentResults: The number of the most recent studies to be displayed.
    • Ex: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=PATIENT&patientID=11685148&mostRecentResults=2
  • modalitiesInStudy: Filter the studies containing the specified modalities.
    • Ex studies containing CT or XA: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=PATIENT&patientID=11685148&modalitiesInStudy=CT,XA
  • containsInDescription: Filter the studies containing the specified string in the study description. Note that the search is case-insensitive and diacritic-insensitive.
    • Ex studies containing coronary or thorax: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=PATIENT&patientID=11685148&containsInDescription=coronary,thorax
  • lowerDateTime: Filter the studies which are older than the specified date.
    • Ex studies older than 01.01.2010 12:00:00: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=PATIENT&patientID=11685148&lowerDateTime=2010-01-01T12:00:00
  • upperDateTime: Filter the studies which are more recent than the specified date.
    • Ex studies more recent than 01.01.2010 12:00:00: http://localhost:8081/display/IHEInvokeImageDisplay?requestType=PATIENT&patientID=11685148&lowerDateTime=2010-01-01T12:00:00

Manifest

Manifest

The manifest contains the list of exams, series, and instances to retrieve when loading images by Weasis. It is represented in this format.

The creation of the manifest occurs when a client calls ViewerHub to launch Weasis through the launch URL using the Launch APIs.

Construction

According to the search criteria of the request, ViewerHub constructs the manifest through connectors.

There are 3 types of connectors:

  • DB (database)
  • DICOM (DICOM DIMSE)
  • DICOM_WEB (DICOMWeb connector will be implemented later).

DB queries or DICOM calls are made to retrieve the necessary information to populate the manifest according to the search criteria.

The connectors are defined according to a model in the config server.

Cache Redis

Once the manifest built, it will be stored in a Redis cache for a defined period (TTL currently 3 minutes).

This mechanism allows multiple instances of ViewerHub, as the retrieval of the manifest by Weasis is asynchronous.

It is also useful when the user requests the visualization of the same study within the TTL period: the manifest will be retrieved directly from the Redis cache.

The key for retrieving the manifest corresponds to the hash of the search criteria.

Cryptography

When launching the Weasis viewer with ViewerHub, a URL containing search criteria in “query parameters” is used.

It is possible to encrypt these search parameters when launching the Weasis viewer in order to not transmit certain sensitive data in plain text (e.g. patient identifier).

To enable this feature, the application-cryptography.yml file in the config-server must be modified by setting the “enabled” field below to true.

# - Cryptography
cryptography:
    enabled: false
    password: '{cipher}'
    salt: '{cipher}'

Defining a password and a salt is also necessary to encode/decode the search parameters.

The same encryption algorithm must be used on the client side (encryption) and on the ViewerHub side (decryption).

Tutorials

Weasis provides the tools to visualize and analyze images obtained from medical imaging equipment according to the DICOM standard. This free DICOM viewer is used by healthcare professionals, researchers and patients.

If you are new to Weasis, it is recommended to read this page to understand the main elements of the interface.

The tutorials are organized by topics and can be read independently.

Note

If you find any errors or inaccuracies, just click the Edit button displayed on top right of each page, and make a pull request to submit your changes.

Subsections of Tutorials

GUI Overview

Essential aspects of the interface

The following image shows the main elements of the graphical user interface (GUI). For more detailed documentation on the various elements of the interface, click on the green or blue areas of the image.

1 2

The interface of the default DICOM workspace consists mainly of 2 parts:

  1. The DICOM Explorer on the left (in blue). It allows you to import and export data, as well as select the series to be visualized.
  2. Depending on the data imported, different viewer/player types (represented by a tab) are displayed in the main section (green). Menus , toolbars and tools change according to the type of viewer selected.
    • The selected viewer is the image above is the DICOM 2D viewer which is the viewer opened by default.
    • A tab containing a multi-view layout can display images from only one patient. However, one patient can appear in several tabs.
    • A tab is also docked panel that can be arranged by dragging and dropping it to the desired location. This makes it possible to display 2 tabs side by side.
    • See also DICOM Explorer to understand how to navigate through the Patient/Study/Series/Image.
Note

Select your preferred language and regional settings in the preferences. Adapt the graphical interface to your needs by modifying the theme or the scaling factor for a better user experience on HiDPI screens.

Tip

In the View menu at the top, toolbars and tools related to the selected viewer can be shown or hidden. These display preferences are retained even after a restart. Only Explorer preferences are retained for the duration of the session.

List of other viewers/Players in the DICOM workspace

List of other workspaces

  • Dicomizer
  • Explorer of standard images (based on the non-dicom-explorer.json configuration profile)

DICOM Import

How to import DICOM files

Weasis can open DICOM files from various ways and sources: drag and drop, local device, DICOM ZIP, DICOM CD/DVD, DICOM Query/Retrieve, and from commands locally or remotely.

Note

An popup error message is displayed when DICOM files cannot be read (from v4.3.0) or when a network error occurs. In the latter case a message asking to download again the missing files.

From the system file explorer

Drag and drop

Files or folders selected from the system file explorer can be opened by dragging and dropping into the central area of Weasis.

  • Empty central panel: Any files than ca be open by one of the viewers (e.g. standard images such as TIFF, PNG, JPEG…)
  • DICOM Explorer and DICOM viewers (SR, AU, MPR, 2D and 3D) in the central panel: Only DICOM files. Opens the default viewer according to the files.

File association

Dicom files can be opened by double-clicking them from the system file explorer.

Note

On Windows only the files with the extension “.dcm” are associated with Weasis. With other systems DICOM without extension are associated with Weasis.

From Weasis menu or toolbar

From the main menu, open File > Import > DICOM or from the first import button in the toolbar. Open toolbar Open toolbar

In order to import DICOM CD/DVD go the main menu, open File > Import > DICOM CD or from the second import button in the toolbar.

Local Device

  • Files and/or folders: list of selected items or unique path
  • Search recursively: when this option is activated the import takes into account the subdirectories
  • Open in new tab: behavior to automatically open the images of a patient when loading DICOM files

DICOM ZIP

  • Select: browse a DICOM zip file. When the archive file is encrypted, a password prompt is displayed.
  • Open in new tab: behavior to automatically open the images of a patient when loading DICOM files

DICOMDIR

It may be from a DICOM CD/DVD or a folder containing a DICOMDIR

  • Path: browse a folder containing a DICOMDIR
  • Detect CD-ROM: try to load a DICOM CD/DVD
  • Copy images into the local temporary directory: useful for slow reading device like CD-ROM

DICOM Query/Retrieve

  • On DICOM Source tab: DICOM import archive DICOM import archive
    • Archive: select the archive to query
      • With DICOM nodes: classic DIMSE C-Find with C-Move, C-Get or WADO-URI for retrieving DICOM files
      • With DICOMWeb nodes: QIDO and WADO-RS for retrieving DICOM files (no other options are required)
    • Retrieve (only with DICOM archive): the protocol to retrieve the images
      • C-MOVE: the classic DIMSE protocol (accepts all sop classes, not recommended for WEB)
      • C-GET: transfer syntaxes are negotiated by each sop classes according to a configuration file
      • WADO-URI: required a WADO server (C-Find + WADO retrieve)
    • Calling Node (only with DICOM archive): select the adapted calling DICOM node
    • More options: allows you to open the preferences to configure the DICOM nodes
  • On Search Criteria tab: Thumbnails Thumbnails
    1. Select a pre-registered item (bottom right of the Search Criteria panel) or Fill the search criteria. Criteria can be saved and reuse later, since Version4.1.0 the item selected in the combo box is automatically applied the next time this window is opened (the default value is Empty).
    2. Adjust the limit to the maximum number of exams in the response. Set the limit to 0 to avoid this constraint. For DICOMWeb the limit is the number of elements on a page, and you can go to the next page with the spinner buttons.
    3. Click on Search
    4. Select the exams you want to import
    5. Start importing and close the window
Note

The progression of downloaded images for a series and the ability to pause the download of a series is only possible with DICOMWeb nodes and with the combination (DICOM C-FIND + WADO-URI). Download Manager Download Manager Resuming the download of a series by clicking on the green play button or from the contextual menu.

Tip

When a query is too long, try to click on the Clear button in Search Criteria in order to cancel the request.

With a DICOMWeb node, a login from a web browser can be required (e.g. login to your Google account). If something goes wrong Weasis may freeze for at least 1 minute waiting for the authorization code.

From commands

See this page

DICOMWeb Import

How to configure DICOMWeb node

This page explains how to configure a remote archive in DICOMWeb and then use this DICOMWeb node to retrieve exams remotely. However, it is also possible, without any prior configuration, to launch Weasis from a web context by passing it some parameters to retrieve images in DICOMWeb.

From the main menu, open File > Preferences (Alt + P) and select DICOM node list. DICOMWeb nodes DICOMWeb nodes

Google Cloud Healthcare API

Google provides a Cloud Healthcare API’s implementation of DICOMweb.

  1. Add a new DICOMWeb node and enter a description
  2. Select DICOMWeb service
  3. Enter the URL of a Google repository (must ends with /dicomWeb)
  4. Add an authentication by clicking on the Manager button and then click on Add

Google node Google node

  1. Select the Google Cloud Healthcare template
  2. Click on Fill and optionally edit the name
  3. Enter your Client ID and Client Secret, Click on OK and close the other windows. Then open the DICOM Import dialog and select the node.

Google template Google template

Currently, the DICOMWeb service for getting thumbnails doesn’t work in the Google API.

Orthanc WEB Server

Orthanc is a lightweight DICOM server with DICOMWeb capabilities.

Currently, the DICOMWeb service of Orthanc doesn’t support the thumbnail service.

Create a new DICOMWeb node with the following URL (example with the demo server without authentication):

https://demo.orthanc-server.com/dicom-web

Orthanc node Orthanc node

dcm4chee-arc-light

Kheops

DICOM Export

How to export DICOM files

Exporting the selected view

From the toolbar icon or from the main menu File > Export > Exporting view export the selected view either to the clipboard or to image file (PNG, TIF, JPG, JPEG2000).

Current view

Export the view as it is (size and overlay).

Anonymize: It allows you to remove identifying information in overlay.

Original Image

Export the view according to the original image with some options.

Export view Export view

  • Size: Change the image size in percent
  • Preserve 16-bit per channel: Option to preserve the pixel depth (e.g. 16-bit in PNG/JPEG 2000/TIFF, double values in TIFF). When this option is applied, the pixel values will match with the Modality LUT values (e.g. Hounsfield values). Exporting in JPEG Lossy is only possible when unchecked for 8-bit image.
  • DICOM Pixel Padding: Apply the DICOM pixel padding when checked
  • DICOM Shutter: Apply the DICOM shutters when checked
  • DICOM Overlay: Apply the DICOM overlays when checked

DICOM Export

In order to open the DICOM export window click on toolbar icon or from the main menu File > Export > DICOM

Local Device

Export DICOM Export DICOM

  1. Select Local Device item
  2. Choose the exporting options Export options Export options
    • Transcoding: It allows you to change the DICOM transfer syntax. Use this option only if you understand well what you are doing.
    • Generate new unique identifiers: Create new UIDs for some attributes. Within an export, the consistency between all the UIDs and their references is preserved.
    • Include DICOMDIR: Create DICOMDIR file
    • DICOM CD folders: Add a directory to be compliant with DICOM CD
    • Keep directory names: Preserve the name in the directory hierarchy (not compliant with DICOMDIR)
  3. Select the patient/study/series/instance to export. Note: series created by Weasis have a flag “NEW”
  4. Export the selection and close the Window
Tip

When opening the Export DICOM window, the checkbox of the study selected in the viewer (surrounded by an orange line) is automatically checked and open series have a full-line selection.

In order to help with series selection, place the cursor on a series line, and you’ll see a tooltip displaying its thumbnail.

Note

When DICOM data is exported in a native image format (JPG, PNG, JPEG 2000 or TIFF), only the images are transformed (see original image options) and the encapsulated files (video, audio and PDF) are extracted.

Multiframe images are exported by adding a number to the end of the file name.

DICOM Send

  1. Select DICOM Send item
  2. Select the destination node (either a DICOM node or a DICOMWeb node)
  3. Select the patient/study/series/instance to export. Note: series created by Weasis have a flag “NEW”
  4. Send the selection to the destination and close the Window

CD/DVD Image

Export DICOM Export DICOM

  1. Select the CD/DVD Image item
  2. Choose the exporting options
    • Transcoding: It allows you to change the DICOM transfer syntax. Use this option only if you understand well what you are doing.
    • Generate new unique identifiers: Create new UIDs for some attributes. For an export, the consistency between UIDs and their references is preserved.
  3. Add JPEG images allows extracting the images and the encapsulated files (video, audio and PDF) into a JPEG folder
  4. Add Weasis allows embedding the viewer into the iso image. This option is only possible on Windows x86-64 (for exporting and running). Running the viewer directly on a CD/DVD ca be quite slow. To avoid that you can install the ISO on a USB stick or read the CD with a locally installed viewer as described in README.html.
  5. Select the patient/study/series/instance to export
  6. Export the selection and close the Window

DICOM Explorer

Structure and display of Patients/Studies/Series

DICOM Explorer

The DICOM Explorer is the panel on the left that displays the Patient/Study/Series representation defined in the DICOM standard.

The data displayed in the DICOM Explorer can be imported form different ways.

DICOM EXplorer DICOM EXplorer

Tip

You can navigate through the Patient/Study/Series/Image structure using only keyboard shortcuts. For example:

  • Open an image and, if necessary, select the view to focus on. If the layout has more than one view, you can move across the views with Tab and Shift + Tab. The view surrounded by an orange line is the focused view.
  • Navigate through images within a series with Up and Down
  • Navigate through series within a study with Left and Right
  • Navigate through studies within a patient with Ctrl + Left and Ctrl + Right
  • Navigate through patients with Ctrl + Up and Ctrl + Down (follow the order in the patient’s combo box and select the last tab if a patient has several tabs already open). To navigate open tabs, use Ctrl + Tab and Ctrl + Shift + Tab.

Patient Level

  • Weasis allows multi-patient display. By default, when images are imported a tab with the patient’s name opens in the main area.
  • A tab containing a multi-view layout can only display images from a single patient.
  • Changing patients can be done either through the first combobox in the DICOM Explorer (see image above) or by selecting a tab in the main area.
  • In the combobox the patients are sorted in alphabetical order regardless of case and according to the regional setting.
  • Studies and Series are displayed within the same patient when the metadata Patient Name and Patient ID are the same. Otherwise, new patients are displayed.

Study Level

  • A study contains one or more series (thumbnails) belonging to a patient. A line representing the study surrounds its series (see image above).
  • By default, the studies are sorted by reverse chronology order (since Version4.1.0Study data sorting” can be changed in the menu “File > Preferences > DICOM > DICOM Explorer”). If there is no study date then the studies are sorted alphabetically according to the Study Description.
  • By default, all the studies are displayed, however you can choose to display only one of them from the study combobox.

Series Level

Thumbnails Thumbnails

  • A series is represented by a thumbnail that contains a certain number of images (number displayed at the bottom left).
  • According to predefined rules, some series are separated into sub-series also represented by a thumbnail with a number preceded by ‘#’ in the upper right corner. Series splitting is necessary for the consistency of some tools such as the MPR, cross-lines and synchronization of series. However, sometimes separation is not desired, and sub-series can be re-merged using the context menu.
  • The sorting of the series is done by the serial number and if this last one is not present then in a chronological way by the date of the series or other dates.
  • To open new series:
    • Drag and drop a thumbnail in the main area (if the series is dropped in a view of the same patient then the series is replaced otherwise a new tab is created).
    • Double click or navigate with the up/down arrow key and press return on a selected thumbnail (if a view of the same patient exists then the series in the view surrounded by an orange line is replaced)
    • Select one or more thumbnails and choose an action from the “2D DICOM Viewer” context menu:
      • Open: Opens the series in the most appropriate layout (replaces the series if the patient’s tab already exists)
      • Open in new tab: Opens the series in the most appropriate layout in a new tab.
      • Open in screen: Opens the series in the most appropriate layout in a specific screen.
      • Add: Adds the series to the current patient’s layout if exists.

Preferences

From the main menu “File > Preferences > DICOM > DICOM Explorer”:

  • Thumbnail size: defines the width of the thumbnails and adjusts the panel accordingly (Default: 144). It is recommended to restart the application after this change.
  • Study data sorting: allows sorting the studies by chronological order or inversely chronological (Default: reverse chronology order). Since Version4.1.0.
  • Open in new tab: behavior to automatically open the images of a patient when using WADO or WADO-RS (Default: All the patients)
  • Download all series immediately: allows starting the download of the series immediately when using WADO or WADO-RS (Default: true). If unchecked then you must click on the play button on each series or globally at the bottom of the thumbnail list.

DICOM 2D Viewer

Displaying DICOM images

The 2D viewer is the default viewer when opening a DICOM series containing images.

Open the 2D viewer

The 2D view can be opened with in the toolbar or by right-clicking on the thumbnail in the DICOM explorer.

DICOM 2DViewer DICOM 2DViewer

The rulers K show a real size when it can be calculated from the DICOM file. When a text M above the calibration is displayed, it gives information about the calibration type. Here are some examples:

  • At detector: The calibration of the projection radiographic image is done at the detector level
  • Magnified: The calibration of the projection radiographic image is corrected using the magnification factor (e.g. mammography, see the image above)
  • Used fiducials: The calibration is based on fiducials (e.g. manual calibration with a ruler in the image)
  • At scanner: The calibration comes from a media which has been digitized (e.g. film digitizer)

Toolbars A

Viewer Main Bar

Main Toolbar Main Toolbar

Select the preferred actions for the three mouse buttons and the mouse wheel:

  • Mouse left button: The default value is Window/Level. Action can also be changed from the context menu F and the key shortcuts.
  • Mouse right button: The default value is Context Menu
  • Mouse wheel: The default value is Series Scroll
  • Mouse middle button: The default value is Pan

Where the possible actions are:

  • Pan: Move the image position. T key to select the action. Alt + Arrows keys to pan when another action is selected.
  • Window/Level: Change the contrast of the image. W key to select the action.
  • Series Scroll: Scroll through the images of the current series. S key to select the action.
  • Zoom: Zoom in/out the image. Z key to select the action.
  • Rotation: Rotate the image with a free angle. R key to select the action.
  • Measure: Draw a graphic for measuring something. M key to select the action.
  • Draw: Draw a graphic for annotating. G key to select the action.
  • Context Menu: Display the context menu. Q key to select the action.
  • Crosshair: 3D cursor. H key to select the action. Ctrl + click or Ctrl + Shift + click allows changing Window/Level.
  • No Action: Do nothing. N key to select the action.
Tip

When dragging, accelerate the action by pressing the Ctrl key and Ctrl + Shift to accelerate more.

  • Default layout: Change the layout of the view. DICOM Information and Histogram are specific layouts where information is automatically updated when scrolling through the series.
  • Synchronize: The synchronization feature lets you apply the same settings to other images.
    • None: No synchronization is applied between series.
    • Default Stack: When selected, the layout is synchronized (window/level, scrolling, zoom) only with the series sharing the same Frame of Reference UID (0020,0052). This is the default behavior.
    • Default Tile: When selected, the layout is applied in tiled mode (image mosaic of the current series) and is synchronized (window/level, scrolling, zoom) with the image of the same series.
  • Reset: Reset the image rendering (see below). Escape key to select the action.

Toolbars available in the DICOM 2D viewer

Tip

Toolbars can be shown or hidden from the View top menu.

Viewer’s tools

Here is a list of the tools which are associated to the DICOM 2D viewer.

The mini-tool is always visible and the other tools are displayed by clicking on the vertical button. The normalize button allows you to insert the panel into the main layout. Otherwise, the panel is displayed as a popup window with the pin option (which is not recommended, as it hides other panels).

Mini-tool B

Allows you by default to scroll through the images of the selected series (surrounded by an orange line). From the combobox at the top, the mini-tool can also be configured to change the zoom or the rotation of the image.

Display C

It lets you control the display of the image and the graphic objects.

The Apply to all views option allows you to apply the same display settings to all the views within the selected tab. If unchecked, the display settings are only applied to the selected view (surrounded by an orange line).

Image

Display options for the image. Unchecking the Image option will hide the image and display only the annotations and the graphic objects. The other options are related to DICOM specifications:

Dicom Annotations

Display transformation properties and DICOM information on the image.

  • Annotations: Display DICOM information on the image corners:
    • G The top left: Patient information
    • H The top right: Study information
    • I The bottom right: Series information (related to the modality type)
    • J The bottom left: Image information and its position in the series
  • Minimal Annotations: Reduce the number of annotations. Use space or i key to toggle between the 3 states (minimal, none, all).
  • Anonymize: Hide identifying information only in the views not in other places of the GUI like the tab title. Must be used with the screenshot tool when exporting image.
  • Scale: Display the rulers on the left and the bottom of the image K
  • Lookup Table: Display the LUT on the image L
  • Orientation: Display the orientation of the image N
  • Window/Level: Display the window and level values J
  • Zoom: Display the zoom value J
  • Rotation: Display the rotation value J
  • Frame Value: Display the frame number J
  • Pixel (Value/Position): Display the pixel value and the position of the cursor J
Drawings

Check/uncheck to show/hide the graphic objects (see Draw & Measure).

Image Tools D

Image Tools contains all the tools to modify the image rendering.

Windowing and Rendering
Transform

Allows you to zoom, rotate and flip the image. Zoom and rotation can also be configured with the mini-tool or the mouse actions.

Cine

The Cine start button lets you scroll through the images in a series at a certain speed (frame per second). The speed values comes from the DICOM file if exists. The cine options can also be changed from the context menu.

  • Click on Cine stop button to end the animation.
  • Click on Loop Sweep toggle button to change the cine mode: looping vs sweeping.
Note

When the cine is active, the series which are synchronized are also animated. The cine is also applied to other series when they are selected until the Cine stop button is clicked.

When a series have a variable frame rate. The speed is changed automatically. So the speed value entered manually is not preserved.

Tip

A Cine toolbar is also available. It is not visible by default, but can be displayed from the View menu.

Reset

It allows you to return to the default image rendering for all or specific parameters. Also available from the toolbar button or from the context menu.

Draw & Measure E

Other specific tools

  • DICOM RT tools (for radiotherapy studies)
  • DICOM Segmentation tools (not yet available)

Preferences

From the menu “File > Preferences > Viewer > “2D Viewer”:

Mouse Action Sensitivity

The sensitivity of the mouse drag can be changed according to your preferences for the following actions: Window, Level, Zoom, Rotation and Series Scroll.

Zoom

Zoom interpolation is the process of creating new pixels between existing pixels in an image when it is zoomed in or out.

  • The Nearest neighbor interpolation is the simplest method. Basically, it extends the pixel value.
  • The Bilinear method averages the values of the four nearest existing pixels to the new pixel. This produces slightly sharper results than nearest-neighbor interpolation, but it is also slightly slower.
  • The Bicubic method is similar to bilinear interpolation, but it uses a 16-point kernel instead of a 4-point kernel. This produces even sharper results than bilinear interpolation, but it is also the slowest method.
  • The Lanczos method uses a sinc kernel to resample the image producing the sharpest results. It is moderately fast, between bilinear and bicubic.

The default value is Bilinear. The Nearest neighbor interpolation is faster but produces aliasing artifacts.

Other

  • Apply Window/Level on color images: When checked, the window/level is applied on the RGB channels of the image. Otherwise, the window/level has no effect when unchecked.
  • Inverse level direction: When checked, the level direction with mouse actions is inverted (dragging down will increase the brightness) according to the Basic Image Review profile. Otherwise, dragging down will decrease the brightness when unchecked.
  • Apply by default the most recent Presentation State: When checked, the most recent Presentation State Object is applied on the related image. Otherwise, it is required to select it from .
  • Overlay color: change the color and the opacity of DICOM overlay. The default color is white. The opacity can be changed from the transparency or alpha slider of the different color models in the color picker.

MPR Viewer and 3D cursor

MPR Viewer and 3D cursor (crosshair)

Orthogonal multiplanar reconstruction (MPR)

The orthogonal multiplanar reconstruction (MPR) allows you to create, from the original plane (usually axial), images in the two other planes of the Euclidean space. Only planes along the 3 axes (x,y,z) can be displayed, an oblique plane cannot be obtained with this tool.

The MPR view inherits most of the DICOM 2D viewer properties. It can be opened with in the toolbar or by right-clicking on the thumbnail in the DICOM explorer.

Note

The menu and the button are only active if the series contains at least 5 images.

When the tab containing the MPR views is selected, the crosshair tool is automatically applied on the left mouse button. Note that it is possible to change the window/level with the ctrl key while keeping crosshair selected.

By default, zoom and window/level are synchronized between the 3 views. The MRR views can be displayed in different layouts .

Tip

Once the 2 new plans are created, they also appear in the DICOM explorer and can be exported.

QuMPR QuMPR

Try to load a volume dataset and open the MPR viewer. Launch

Info

For more information on the elements related to the orientation of multiplanar views see MPR orientation.

3D cursor (crosshair)

The 3D cursor allows you to synchronize the position of several views sharing the same 3D coordinate system.

In order to know which series sharing the same coordinate system, you can select more than one series from the DICOM explorer by right-clicking on a series and selecting “Select related Series”. Then open the series selection by right-clicking again and selecting “2D Viewer > Open

The crosshair tool can be selected in the mouse buttons on the toolbar or by right-clicking on a view.

3D Cursor 3D Cursor

Try to load several series and select the 3D cursor. Launch

Preferences

From the main menu “File > Preferences > Viewer > MPR” (Since Version4.1.0):

  • Auto center axes: Allows you to choose a behavior to recenter the cursor in the different views. The position can be returned to the center systematically with the “Always” option (see the image above) or with the 2nd option only when the position is almost no longer visible (the default value).
  • Crosshair gap at the center: Defines the size of the empty space in the center of the crosshair
  • Default layout: The preferred layout used when opening the MPR viewer
Info

The preferences apply to both the MPR and the 3D cursor.

MIP Viewer

Maximum Intensity Projection (MIP)

The MIP viewer is a simple 3D viewer that allows to display the maximum intensity projection of a volume defined by a number of slice of the image stack.

The MIP viewer is also available in the 3D viewer with more advanced options of the volume rendering, but some minimal hardware requirements is necessary.

Open the MIP viewer

The MIP viewer can be opened with in the Basic 3D toolbar of the DICOM 2D viewer.

Note

If the button is grayed out, it means that the current series has less than 5 images which the minimal number of images for using the MIP viewer.

The MIP Options

This dialog is a modal window that allows you to change the MIP settings and build a new MIP series.

Try to load a volume dataset and open the MIP viewer. Launch

MIP Options MIP Options

Note

In MIP mode, the volume is displayed as a 2D projection of the maximum intensity along the perpendicular axis of the image plane. This change in geometry means that overlay graphics are no longer displayed.

Projection type

The projection type defines the way the MIP is calculated. The options are:

  • Min: Minimum Intensity Projection
  • Mean: Mean Intensity Projection
  • Max: Maximum Intensity Projection (the default value)

Windowing and Rendering

The Windowing and Rendering contains some of the tools found in Image Tools to change the windowing or to select a preset, since Version4.4.0.

Slice position

The slice position is used to move around the series to apply the projection and display the result. The Image value represents the position in the series stack.

Slice thickness

The Image Extension value represents the number of slices to use for the MIP calculation. If the images are calibrated and contains the 3D position, the thickness is also displayed in millimeters.

Rebuild Series

It allows you to build a new MIP series according to the MIP options. In this new series the slice position and thickness are modified. If the windowing is custom, then it is added to the presets of the new series.

The new MIP series is added to the DICOM explorer and can be exported.

DICOM 3D Viewer

Displaying volume data

Since Weasis Version4.1.0 the 3D viewer allows displaying volumetric renderings with different options for adjusting the pseudo colors, the transparency, the shadows and the lighting according to the type of exam.

The volume rendering uses a ray casting algorithm and the OpenGL Shading Language (GLSL). Shader programming is used to create the necessary algorithms and data structures required for the ray casting computations to be executed efficiently on the graphics card. Therefore, minimal graphic resources are required.

Requirements

Some requirements related to the specifications of your graphic card are mandatory. They can be displayed in “OpenGL Support” from the menu “File > Preferences > Viewer > 3D Viewer”:

  • Driver version: The OpenGL version must be at least 4.3 to support the Compute Shader (not supported currently on macOS)
  • Max 3D texture dimension length: The limit of any dimension (X,Y,Z) of the volume data
  • If you have other information in red, it means that the configuration is not optimal but in most cases can work (see how to limit the size of 3D textures)
Note

If the graphic card displayed in Weasis is not the right one, you must solve this problem on the side of the graphic drivers or the operating system.

OpenGL does not include specific functionality for selecting a particular graphics card. Instead, this is handled by the graphics card driver and operating system, which provide a way for users to configure which graphics card should be used by an application.

Open the 3D viewer

The 3D view can be opened with in the toolbar or by right-clicking on the thumbnail in the DICOM explorer.

Try to load a volume dataset (Medical Demos from data.kitware.com) Launch

3D View 3D View

Toolbar A

Actions in the toolbar are:

  • Allows you to fully reload the volume
  • The orthographic projection maintains parallel lines unlike the perspective projection that provides a perception of depth. The default mode is the perspective projection.
  • Opens the 3D preferences

For other buttons see below.

3D Rendering Tools

This tab contains all the tools to modify the volume rendering. If you want to return to the original settings, just click on the toolbar button or from the context menu.

Windowing and Rendering B

Some of the options described below are also available in the toolbar and in the contextual menus.

  • Window: The width of a range of voxels values mapped to a specific range of display values.
  • Level: The center of the range defined by Window.
  • Preset: Specific values of Window and level. Auto Level [Image] is the default value when changing a LUT and provides the best visual appearance of a Volume LUT.
  • LUT Shape: The mapping (transfer function) between the input values and the display values can be linear, sigmoid and logarithmic. Default value is linear.
  • LUT (Volume LUT): A Volume Lookup Table (LUT) is a 3D LUT used to map the grayscale values of a volume dataset to color, opacity and lighting values for visualization. Choosing a LUT from the toolbar or the contextual menu is easier because the LUTs are displayed in an order according to the modality and with a preview.
  • allows you to invert the LUT.

Volume Rendering C

This panel contains options for the rendering type and its quality, transparency, lighting, and shading settings.

  • Type: Composite is the classic type of volume rendering. The Maximum Intensity Projection (MIP) is the highest intensity voxels (3D pixels) along a ray path are projected onto a 2D plane. Iso surface is a technique to create a 3D representation on a specific intensity threshold.
  • Z-axis sampling: The sampling should be large enough to accurately capture the details of the volume data, but small enough to avoid excessive computation time. The default value is calculated according to the size of the volume.
  • Opacity: The opacity factor of the voxels. Can be set to more than 100% to modify initial values (lower than 100%) transmitted by the Volume LUTs.
  • Shading: Allows to activate the shading. Default value is defined in LUT. The additional options allow you to override the default lighting settings (comes from Volume LUT).

Transform D

Allows you to zoom and rotate along a specific axis

Preferences

From the menu “File > Preferences > Viewer > 3D Viewer”:

OpenGL Support

Information about the graphics card and OpenGL capabilities, see Requirements.

3D Viewer

  • Default layout: The preferred layout used when opening the 3D viewer
  • Max 3D texture size: The maximum size of the volume according to X/Y (width and height of images) and according to Z (number of images in the stack composing the volume)
Note

The maximum values of the default 3D textures come from the graphics card. However, it may be wise to decrease these values (e.g. 512) in order to allow a more efficient display of volumetric renderings for which the hardware resources are not sufficient.

Volume Rendering

  • Dynamic quality: Allows you to make the render more fluid by reducing its quality (according to the z-axis) when it is rotating or being modified. When the slider is at maximum then there is no more quality reduction.
  • Default orientation: The preferred orientation used when opening a volume rendering view. Default is Anterior position by turning 15 degrees to the right and 15 degrees downwards.
  • Background color: Defines the background color of the rendering
  • Light color: Defines the color of the light during the illumination of the rendering

Video tutorials

  • Display an MR scan with an angiography-specific protocol by creating a volume rendering. Then either use the MIP type or choose a 3D LUT and adjust the win/level values.

DICOM ECG Viewer

Displaying electrocardiography data

The ECG viewer is used to display and analyze electrocardiogram (ECG) data in DICOM format obtained from different modalities, such as resting ECGs, ambulatory ECGs, and stress tests.

The viewer can also provide tools for measuring ECG intervals and amplitudes in various formats, such as 12-lead ECGs, 3-lead ECGs, and rhythm strips.

Try to open an ECG sample Launch

ECG Viewer ECG Viewer

Toolbar A

Actions in the toolbar are:

  • Allows you to print the ECG as it is displayed with some basic information (patient/study)
  • Show the DICOM metadata of the ECG
  • Delete all the measurements (yellow areas in the image above), see Markers

Zoom and Display Format B

The zoom is on several graphic components. The first combo box represents the time, the second represents the voltage, and the slider allows you to zoom in both directions while preserving the aspect ratio.

  • Time (X-axis): The number of millimeters per second (by default is “auto mm/s”)
  • Voltage (Y-axis): The number of millimeters per milli-volt (by default is “auto mm/mV”)

The Display Format allows you to show the leads in different layouts.

Lead and Cursor information C

Moving the cursor over the ECG displays the following information:

  • Lead label: show the minimum and maximum voltage values of a lead
  • Cursor: show the current time and voltage values under the cursor

Markers D

The markers are the result of the measurements made on the ECG (yellow areas in the image above). A measurement is done by defining a starting and ending point:

  • Start Time: The time in seconds according to the position of the first point
  • Start Value: The voltage in milli-volt according to the position of the first point
  • Stop Time: The time in seconds according to the position of the second point
  • Stop Value: The voltage in milli-volt according to the position of the second point
  • Duration: The time elapsed between the 2 points
  • Difference: The difference in milli-volt between the start value and the end value
  • Amplitude: The maximum variation in milli-volts from the start value to the end value

The actions for making measurements are:

  • Action to add a starting point: click
  • Action to add an ending point: ctrl+click or right-click

Deleting the measurement in a lead can be done by a middle-click or shift+click. Deleting all bars can be done with the button in the toolbar.

Note

Only one measurement is possible by lead.

Annotations E

The annotations come from 2 groups of DICOM metadata:

  • Acquisition context and Annotations: Attributes which describes the conditions present during data acquisition.
  • Annotations: may represent a measurement or categorization based on the waveform data, identification of regions of interest or particular features of the waveform, or events during the data collection that may affect diagnostic interpretation (e.g., the time at which the subject coughed).

DICOM SR Viewer

Displaying DICOM Structured Report

The DICOM Structured Report (SR) viewer is used to display and analyze DICOM SR data. The SR object is a structured collection of content items that represent a report of a diagnostic or therapeutic procedure. The content items are organized in a tree structure, and each item has a relationship with other items.

The viewer displays the content of the SR object in a structured way, allowing the user to navigate through the tree and visualize the content of each item.

Try to open sample SR files Launch

SR Viewer SR Viewer

Toolbar A

Actions in the toolbar are:

  • Allows you to print the rendering of the SR
  • Show the DICOM metadata of the SR

Display SR Header B

The header of the SR object is displayed in a table format with 3 columns containing information about the patient, the study, and the report status.

DICOM SR Tree C

The content of the SR object is displayed in a tree structure. Each node in the tree represents a content item with hierarchical numbering, and the tree structure reflects the relationships between the items.

Some items can have a link to other content items, and the viewer provides a way to navigate through the tree by clicking on the links.

This link can also open a related image which can contain measurements defined in the SR object (e.g. in the image above, clicking on POLYLINE will open the image and display the polyline).

DICOM Audio Player

Playing DICOM AU data

This player is used to play audio data defined by the DICOM AU standard.

Try to open DICOM AU Launch

Audio Player Audio Player

Toolbar A

Actions in the toolbar are:

  • Show the DICOM metadata of the DICOM AU

Play B

The Play button allows you to play and pause. The slicer allows you to navigate through the audio file and display the position in seconds.

Volume C

This slider allows you to adjust the volume of the audio file.

Export Audio File D

The Export Audio File button allows you to save the audio file in the format AU or WAVE.

Draw & Measure

How to draw and measure on images

This panel allows you to draw and measure on DICOM and standard images. The results can be exported:

  • For DICOM, in a DICOM Presentation State object.
  • For standard images, in an XML File in the same directory of the image (when exporting the images in non dicom file format). The XML file is automatically loaded when the image is displayed in the standard 2D Viewer.

Draw & Measure Draw & Measure

Draw & Measure Panel

When clicking on of the vertical button , the panel is displayed on the right side of the viewer. This panel is divided into 4 parts.

Measurement tools A

Select a measurement tool by clicking on one of the buttons and then draw on the image. Note that the previous action will select automatically the drawing action in the mouse left button.

The first button is the selection tool that allows you to select, resize and move the graphic objects.

By selecting one or several graphic objects, you can change properties (e.g. color, line width) or copy/paste with the contextual menu. You can also delete the selection with the delete key or . See other shortcuts for graphics.

Note

You can draw a segment in two ways:

  1. Click + Drag: Click, drag to draw, then release.
  2. Click > Release > Drag: Click to start, release, drag to draw, and release again.

In order to continue drawing with the same tool, you can uncheck the Draw only once option (see below).

Tip

For a polyline or polygon, double-click to complete editing. You can also delete a point or add new ones by right-clicking on a specific point.

Rectangles and ellipses can be drawn in any direction. External control points can be used to rotate and resize the shape. With the single control point on the opposite side, you can only resize the shape.

Drawings B

The drawing buttons allow you to add text and graphic as annotations. These graphics objects do not display measurement values and do not appear in Selected Measurement D.

Graphic Options C

  • Line color: The default line color when drawing new graphic object. The default value is yellow. The opacity can be changed from the transparency or alpha slider of the different color models in the color picker.
  • Line width: The default line width.
  • Draw only once: After drawing a graphic object, the tool is automatically set to the selection mode. If unchecked, the tool remains active for drawing a new graphic.
  • Pixel statistics: Show statistics of the pixel values within the shape. Only for graphic objects with a closed shape (e.g. rectangle, ellipse, polygon).
  • Unit: The unit of the image spatial calibration. If no calibration is defined, the unit is pixel. See also How to change the spatial calibration.
  • More options: The preferences to change more display options (see preferences).
Tip

Show/hide all the graphic objects from the Display panel by checking/unchecking the Drawings option.

Selected Measurement D

The selected graphic E created with a measurement tool is displayed in the table. The table shows the shape properties according to the measurement type (and its units in square brackets if exists, see also the calibration type located at M).

Note

For polygon, the length, the width and the orientation are calculated with OMBB (Offset Minimum Bounding Box) method which provides a more accurate approximation of the actual length and width based on the bounding box of the polygon.

When Pixel statistics is checked, some statistics are displayed in the table only for graphics with a closed shape (e.g. rectangle, ellipse, polygon). The statistics are calculated from the pixels inside the graphic shape:

  • Pixels: The number of pixels inside the graphic shape
  • Min: The minimum modality value
  • Max: The maximum modality value
  • Median: The median modality value
  • Mean: The mean modality value
  • StDev: The standard deviation is a measure of the dispersion of the values
  • Skewness: The skewness is a measure of the asymmetry of value distribution
  • Kurtosis: The kurtosis is a measure of the “tailedness” of value distribution
Note

SUV (Standardized Uptake Value) measurements are added to the table only for PET images containing the required metadata (patient weight,Decay Correction, radio pharmaceutical dose and time…).
The SUVs (the minimum, maximum, and average values) are calculated using the body weight (SUVbw) vendor-neutral method.

Tip

The table can be exported by copy/paste. Note that the maximum precision values are copied and not the rounded values displayed in the table.

Preferences

From the menu “File > Preferences > Draw & Measure”:

Drawings

It lets you change the graphic properties when drawing new graphics, since Version4.3.0.

  • Line color: The default line color. The default value is yellow. The opacity can be changed from the transparency or alpha slider of the different color models in the color picker.
  • Line width: The default line width.
  • Fill shape: When checked, the shape is filled with the line color.
  • Fill opacity: The opacity of the interior of the shape, relative to the opacity of the line color. The default value is 100%. For example, if the line color has an opacity of 80% and the fill opacity is 20%, then the perceived opacity will be 16% (0.8 * 0.2).

Labels on image

It lets you change the display options for labels attached to measurement graphics.

  • Font type: The default font size of the labels on the image. The default value is Small semibold. Note that the font size is not absolute and is automatically adjusted according to the scale factor.
  • Geometric measurement: the measurement types displayed on the image according the graphic type.
  • Pixel statistics: the statistics types displayed on the image for graphic objects with a closed shape (e.g. rectangle, ellipse, polygon).

DICOM RT Tools

Displaying radiotherapy information

The RT Tool appears on the right panel when a CT exam (when linked with DICOM STRUCT, PLAN and DOSE) is displayed. Since Version4.1.0 a specific configuration in config.properties is no longer required.

How to display structure and iso-dose

In order to display the structures in overlay on the image, apply the following points (see in the image below):

  1. InfoOptional When selected, it allows you to force the DVH calculations. Otherwise, it is calculated only if some information is not available in the DICOM files.
  2. Click on “Load RT” button to load DICOM STRUCT, PLAN and DOSE associated the CT images. Once loaded, the button becomes inactive.
  3. InfoOptional Select a structure if there is more than one.
  4. InfoOptional Select a plan if there is more than one.

Try to open an RT sample Launch

DICOM STRUCT DICOM STRUCT

Note

The “Structures” tree has the same options as DICOM SEG regions, see DICOM Segmentation.

See also the use of DICOM RT as artificial intelligence output.

For displaying the iso-doses, apply the following points (see in the image below):

  1. Select the Isodoses tab
  2. Check the Isodoses root node which is not activated by default
  3. InfoOptional Adjust the graphic opacity

DICOM DOSE DICOM DOSE

Tip

The “Structures” and “Isodoses” root node can be used to show or hide all graphics while the child nodes can be used independently for showing specific items.

How to display DVH

  • Select one or several structures. Note: the Structures root node must be selected.
  • Click on the button “Display DVH chart
  • Right-click on the chart to print or save as a PNG image or vector files such as SVG or EPS.

DICOM DVH DICOM DVH

DICOM Attributes

How to display DICOM attributes

The DICOM attributes can be displayed either by:

  • selecting the “Dicom Information” layout from the layout dropdown button A
  • clicking on the “Dicom Information” button in the toolbar to open a detached window B

Tags Tags

Note

Using the view in the layout (A) allows updating dynamically the DICOM attributes to the current image (e.g. scrolling into the series). The DICOM attributes won’t change when opening the detached window (B).

When Weasis opens particular DICOM files (e.g. PDF and video) with an external viewer, the DICOM attributes can be viewed from the thumbnail context menu (see image below). Open DICOM PDF tags Open DICOM PDF tags

How to find a specific DICOM attribute or value

The Dicom Information window contains two tabs:

  • Limited DICOM attributes: List of the main attributes assembled in several groups.
  • All DICOM attributes: List of all the attributes where each data element is displayed within four columns (Tag ID, VR, Tag Name and Value)
Note

When the data element contains several values, each value is separated by ‘\’.

Data element with a value representation (VR) OB, OD, OL, OF, OW and UN shows “binary data” as value.

Search DICOM tags Search DICOM tags
In the image above, we are looking for the word “date”. Here are the steps:

  1. Select All DICOM attributes tab for having all the attributes.
  2. Enter the word you are looking for.
  3. Use the arrows to navigate into the highlighted results. The button on the far right allows you to limit the results to positive ones.
  4. The navigation shows the current result in highlight mode.

Using in the toolbar allows you to filter the results. This can be useful to keep the focus on certain elements when scrolling through a stack of images (only possible with layout A).

Note

Some attributes can be into a sequence element (5). Note: the left arrow shows the depth level as a sequence can contain another sequence.

Tip

If there isn’t enough space to display the entire value, simply resize the column from the header (only persistent if the image doesn’t change) or use tooltips by positioning the cursor over the elements (since v4.3.0).

Tip

The DICOM attributes can be copied into the clipboard with the copy shortcut of your system.

Lookup Tables (LUT)

How to handle Color and DICOM LUTs

A DICOM file can contain one or more LUTs. The DICOM pipeline for rendering images contains a number of stages where the LUTs are applied. There are 4 types of Lookup Tables (LUTs) in DICOM:

  1. The Modality LUT is used to transform the pixel values into the values of the modality (e.g. Hounsfield for CT).
  2. The Values of Interest (VOI) LUT is used to transform the modality values into a visible range that enhances specific anatomical structures or pathological conditions.
  3. The Presentation LUT is used to transform the intensity values into P-Values (presentation values are device-independent values related to human perception).
  4. The Palette Color LUT is used to transform the intensity gray values into color values with a pseudo color LUT.
Note

The Modality LUT and the Palette Color LUT are applied automatically when they exist. There are no options in the User Interface to modify them.

Windowing and Rendering

The Windowing and Rendering is a panel in the Image Tools of the DICOM 2D viewer. Some of the options described below are also available in the Lookup Table toolbar, in the main menu and in contextual menus.

  • Window: The range of pixel intensity values. The value can be changed when Window/Level is selected in mouse actions or by using the slider.
  • Level: The center of the range defined by Window. The value can be changed when Window/Level is selected in mouse actions or by using the slider.
  • Preset: The possible items ordered according to the following list:
    • Empty item when the Window and level values are changed manually from slider or mouse actions.
    • Window and level values or VOI LUT data from the DICOM file (ending with [DICOM]). The default value is the first [DICOM] item if exists, otherwise Auto Level [Image].
    • Auto Level [Image] (always visible) which is the Window and level related to the full range of the pixel values
    • Specific values of Window and level for a modality type (e.g. Lung for CT)
  • LUT Shape: The mapping (transfer function) between the input values and the display values can be linear, sigmoid and logarithmic. Default value is linear.
  • LUT: A pseudo color LUT used to map the grayscale values to color. Default (image) is the original image color model. Choosing a LUT from the toolbar or the menus is easier because the LUTs are displayed with a preview.
  • allows you to invert the LUT.
  • Filter: The 2D filter is applied to the image before the LUT. The filter can be used to enhance the image quality or to highlight specific structures. The default value is None.
Tip

In order to display the LUT on the image, select it from the Display panel on the right. The LUT color are associated to values that correspond to the Modality LUT values (e.g. Hounsfield values for CT) or to the pixel values for some imaging types.

Another way to see the windowing transformation is to display the histogram.

Build DICOM KO and PR

How to build and export DICOM KO and PR

Key Object Selection (KO)

  • In order to display KO Toolbar, select in the main menu: View > Toolbars > Key Object Selection Toolbar

  • When a DICOM KO is loaded then it appears in the explorer menu (1) or it can be selected from the icon on the right of the view (6).

  • Click on the star icon (3) to add the key image or press ‘k’ to create in a new KO. Build KO Build KO

  • Other actions:

    • Apply a KO (2)
    • Filter to obtain only the key images defined in the selected KO (4). This means only key images will be visible when scrolling into a series.
    • Create a new KO (or based on another one) or delete KO (only the ones created by Weasis) (5)

Presentation State (PR or GSPS)

  • Apply PR loaded from a DICOM file (1) : Since Version2.6.0 PRs are not applied to the image by default (requires to select the right icon (2) over the image). In order to apply the most recent PR by default, change it from the main menu File > Preferences (Alt + P) and check “Apply by default the most recent Presentation State”, or in the default preferences.
  • Create a new PR: Any type of annotations (Drawings and Measurements) can be exported in a DICOM Presentation State. Image presentation actions (zoom, calibration, W/L, LUT…) are not yet possible to export into PR. Build PR Build PR

Exporting Key Object Selection or Presentation State

  • In order to export KO or PR, select the DICOM Export icon or from the main menu File > Export > DICOM Export KO locally Export KO locally
  1. Select the export type (locally or remotely)
  2. Choose the exporting options (series created by Weasis have the flag “NEW”)
  3. Select the patient/study/series/instance to export
  4. Export the selection and close the Window

DICOM SEG

Displaying DICOM Segmentation

Since Weasis Version4.3.0, this panel lets you display the contents of a DICOM SEG file superimposed on the image. It also lets you modify the transparency of specific regions (label defined by a color).

DICOM SEG can be generated by AI frameworks to represent the results of segmentation algorithms applied to medical images.

How to display DICOM SEG

In order to display the DICOM SEG regions in overlay on the image, follow these steps (see in the image below):

  1. Open the DICOM series with a link to a DICOM SEG object. This link is visible by the segmentation icon in the lower right-hand corner of the thumbnail.
  2. Once the image is displayed, you can click on of the vertical button to show the Segmentation panel on the right side of the viewer.
  3. A DICOM SEG file is represented by a selected item in the combo box and its list of regions below. By default, all DICOM SEG files linked to an image are displayed.
  4. Select one or several regions to display for the selected DICOM SEG (3). Several regions are grouped together when they share the same first name. Note: the parent node must be selected to display the child regions.
  5. Adjust global graphic opacity (border and interior)

Try to open an SEG sample Launch

DICOM SEG DICOM SEG

Note

The regions tree has context menus that allow you to:

  • Fill opacity (all nodes): The opacity of the interior of the shape, relative to the opacity of the line color (Graphic Opacity). The default value is 20%. For example, if the line color has an opacity of 80% and the fill opacity is 20%, then the perceived opacity will be 16% (0.8 * 0.2).
  • Select/Unselect all the child nodes (only for parent nodes)
  • Show ih the images view (only for leaf nodes): The region with the highest surface area is displayed in the image overview.
  • Pixel statistics from the selected view (only for leaf nodes): Show statistics of the pixel values within the region shape. For the definition of the statistics parameters, see graphic Pixel Statistics.
Tip

The regions tree has tooltips on leaf elements that show the region description and the region volume.

AI DICOM Objects

DICOM objects generated by artificial intelligence

Artificial intelligence (AI) frameworks can produce various DICOM objects for different purposes. Here are some common DICOM object types produced by AI frameworks and how they are handled in Weasis (see Info window).

DICOM Secondary Capture (SC)

This type of object represents secondary images where the AI has embedded information in the image pixels. These images may include annotations, measurements, or other enhancements to the original image data.

Info

DICOM Secondary Capture can be displayed by Weasis like any other image data, see DICOM 2D Viewer.

DICOM Segmentation (SEG)

These objects represent the results of segmentation algorithms applied to medical images. Segmentation involves partitioning an image into multiple segments to simplify its representation for analysis or display. AI frameworks can produce SEG objects containing segmentations of anatomical structures, lesions, or other regions of interest.

Info

See DICOM SEG for displaying DICOM SEG objects in Weasis.

DICOM RTSTRUCT

This type of DICOM object is originally used to represent structures delineated on CT images for radiotherapy treatment planning. Some AI frameworks may produce DICOM RTSTRUCT objects (geometric shapes) instead of DICOM Segmentation (pixel-based).

Info

See DICOM RT for displaying DICOM RTSTRUCT objects in Weasis.

TotalSegmentator automatically segments over a hundred anatomical zones on CT images. When the result is saved in DICOM RTSTRUCT (since version 2), the segmentation result can be displayed directly in Weasis:

DICOM Structured Report (SR)

AI frameworks can generate structured report containing the results of their analysis. These reports typically include structured information about findings, measurements, observations, and interpretations derived from medical images or other data.

Info

DICOM Encapsulated Documents

AI frameworks may produce DICOM objects containing encapsulated documents such as PDF reports, text documents, or other non-image data related to medical imaging studies.

Info

This type of object can be displayed by the default system application associated with the document mime type. The DICOM attributes can be viewed from the thumbnail context menu (see image below).

Open DICOM PDF tags Open DICOM PDF tags

DICOM Presentation States

Presentation states define how images should be displayed, including display parameters such as window width, window center, and image orientation. A Grayscale Softcopy Presentation State (GSPS) object is used to display annotations and graphics that overlay on a displayed image. AI frameworks might generate presentation states to specify how images should be displayed based on their analysis results or to display graphics overlays on images.

Info

See DICOM PR for displaying DICOM Presentation States in Weasis.

DICOM Enhanced Objects

Enhanced DICOM objects contain additional information. AI frameworks might produce enhanced DICOM objects to include additional annotations or other enhancements to the image data.

Info

DICOM Enhanced (e.g. reduce noise or improve visualization of anatomical structures) can be displayed by Weasis like any other image data. Some other additional information (overlay, shutter and pixel padding) can be added to the image rendering, see 2D Viewer Display.

Zoom

Zoom tool

The zoom tool can be associated with one of three mouse actions . In the image below the zoom tool is associated with the middle mouse button. See also zoom preferences.

The zoom factor can be modified from different locations:

  • By dragging the cursor over the image with the configured mouse button
  • By scrolling the mouse wheel when configured
  • By selecting an item in the zoom dropdown button in the toolbar
  • From the context menu: right-click on the image > Zoom
  • Form the slider in the image tool panel
  • Using Keyboard Shortcuts (Ctrl + Plus (+), Ctrl + Minus (-) and Ctrl + Enter) on the selected view

The context menu and the toolbar button allows you to select different zoom factor:

  • Actual pixel size : display the image at a 1:1 ratio, where each pixel in the image corresponds to one pixel on the screen
  • Real world (see below)
  • Resize to best fit : scaling the image to make it fit the view area as closely as possible
Note

The zoom function always zooms in/out to the center of the screen regardless of where the cursor is. This mode provides greater positional accuracy in particular situations.

Since “Resize to best fit” is the default mode for a view, the image will be centered when scrolling to the next image. You need to change the mode or the zoom factor to keep the image off center when scrolling.

Zoom tool Zoom tool

Tip

For selecting directly the zoom action of the mouse left button, enter “z” as a shortcut.

Real-world zoom

The real-world zoom allows displaying the content of the image at the same size of the real objects.

The feature requires calibrating the screen where the image is displayed. From the main menu, open File > Preferences (Alt + P) > Monitors and click on Spatial calibration. Then enter a value that matches to the line length or the diagonal length of the screen.

Note

Several screens can be calibrated. Each one has its own spatial calibration factor.

Magnifying lens

The magnifying lens can be activated from the toggle button of the zoom toolbar (see the image below). It has several parameters accessible from the context menu.

This lens can be used in many situations, for instance:

  • to magnify a specific area
  • to compare two images from the same series (select Freeze image)
  • to display a specific area without the drawings (Unselect Show Drawings)
  • to compare different values of Window/Level (select Freeze parameters - see image below)
Note

Using the mouse wheel on the lens changes the zoom factor. Double-clicking on the lens adjusts the zoom factor of the lens to the one of the main image.

Lens Lens
Parameters of the context menu:

  • Synchronize to parent zoom: When this option is activated, the zoom factor of the lens is permanently adjusted to the zoom factor of the main image (meaningful when using freeze parameters).
  • Show Drawings: Displays in the lens the visible drawings.
  • Magnify: Allows to select a zoom magnitude.
  • Image: Freeze parameters allows you to keep the current image processing (c.f. Window/level, LUT or filter) and Freeze image allows you to keep the current image and its parameters.

Lens freeze Lens freeze

Histogram

Displaying Histogram

Displaying the histogram allows you to view the distribution of the modality values.

Note

Displaying the histogram allow you to better understand the effect on the pixel distribution wen changing all the LUT parameters from the Image Tool right panel.

To open the histogram, select the “Histogram” layout from the Layouts dropdown button (see the image below).

General histogram parameters:

  • Channel: With gray images only the Luminance channel is available. With color images, you can choose one of the following color models: RGB, HSV and HLS.
  • Bins: The bins are the intervals values of pixels. By default, this number is calculated by the max value minus the min value and cannot exceed 512. The value entered must be between 64 and 4096.
  • Statistics: Show the statistics of the histogram which allow you to analyze and to compare images or image regions in a quantitative way. For the definition of the statistics parameters, see graphic Pixel Statistics.
Note

The values on the x-axis represent the modality values (e.g. Hounsfield for CT) or the pixel values for some imaging types. If the unit of the pixel value of the modality exists, it is visible at the end of the histogram title.

Open Histogram Open Histogram

Display histogram parameters:

  • -/+: shrink/strech the y-axis scale (the number of occurrences)
  • Accumulate: Display a cumulative histogram
  • Logarithmic: Show the number of occurrences in a logarithmic scale (y-axis).
  • Show intensity color: Show the bin with the LUT colors, otherwise in black.
  • Reset: Set the default parameters
Note

It is possible to display the histogram of a region with the measurement tools. Simply select the region to display its histogram (see the image below).

Histogram parameters Histogram parameters

Tip

Clicking on the histogram bin allows displaying the number of occurrences and the modality range values of the selected bin.

Print

Build the image selection to print

The image selection to print must be prepared before calling the print function. If you need to print more than one image per page, choose a layout from the dropdown button in the toolbar (1).

Note

The layout list is built dynamically according to the window size. So changing the window size ratio will provide other layouts. For instance, with a panoramic screen, you can choose a horizontal layout and then print with a landscape orientation.

Print Layout Print Layout

To fill the layout with images you can change the synchronized mode of series (2):

  • with Default Tile selected, all the views will be filled with the same series. Each view has a new image of the series stack (n + 1).
  • with Default Stack selected, drag and drop a series into each view and select independently which image you want to display.

Select a print mode

Standard Printer

From the main menu, open File > Print > Print 2D viewer layout (P).

standard standard

The meaning of the standard print parameters:

  • Image position: the position of the image in the print area.
  • Image DPI: the print resolution in dot per inch (Default value is 150). Higher DPI means higher resolution.
  • Print image with annotations: Allows to print the annotations defined in the Display panel.
  • Print only the selected view: When this option is checked, only the selected view is printed (view with an orange border). Otherwise, all the views of the layout are printed.

DICOM Print

From the main menu, open File > Print > DICOM Print.

In the DICOM Print dialog, you can manage several configurations. For the options meaning, you can refer to the above parameters and the DICOM print pages.

DICOM DICOM

Note

The DICOM printer configurations can be distributed at the server side for all the clients, see preferences.

Image orientation

Interpretation of the orientation

The orientation of the DICOM images is displayed by one or more uppercase letters in the middle on the top and left of the view.

If Anatomical Orientation Type (0010,2210) attribute is absent or has a value of BIPED, anatomical direction is:

  • A: anterior
  • P: posterior
  • R: right
  • L: left
  • H: head
  • F: foot

If Anatomical Orientation Type (0010,2210) attribute has a value of QUADRUPED (since Version4.1.0), anatomical direction is designated by:

  • LE: Left
  • RT: Right
  • D: Dorsal
  • V: Ventral
  • CR: Cranial
  • CD: Caudal
  • R: Rostral
  • M: Medial
  • L: Lateral
  • PR: Proximal
  • DI: Distal
  • PA: Palmar
  • PL: Plantar Quadruped orientation Quadruped orientation
Info

If the orientation is not perfectly aligned according to the 3 axes of the referential then there can be a secondary and tertiary orientation (in subscript) separated by “-”.

Info

For some modalities such as CR or DX, the orientation comes from the Patient Orientation (0020,0020) attribute and is not displayed when using the rotation tools because it cannot be recalculated dynamically.

For other modalities such as CT and MRI, the orientation is always displayed because it is dynamically calculated.

Tip

To display or hide the orientation on the image, select it from the Display panel on the right (DICOM Annotations > Orientation).

Orientation in 2D multiplanar reconstruction (MPR)

The image below shows the 3 views of the orthogonal MPR. The uppercase letter at the left or at the top designates the orientation of each multiplanar view whose type (axial, coronal, sagittal) is defined at the bottom.

MPR orientation MPR orientation

Info

The color of the axes used comes from the one defined in DICOM Patient Orientation based on the anatomical direction. Blue corresponds to the left-right axis, the red axis to anterior-posterior, and the green axis to foot-head.

The colored square in the MPR view above corresponds to the plane that is perpendicular to one of the axes.

Third-party Launcher

Third-party application launchers allow you to run another application by transmitting information to it in the startup parameters.

In the graphical user interface, launchers appear in the File > Launcher menu and optionally in the toolbar.

Launcher Launcher
In the example above, we add a button to launch the Horos software on the Mac, importing the directory containing the DICOM files downloaded by Weasis.

How to create the third-party launcher

  1. From the main menu, open File > Preferences (Alt + P) and select the Launcher item.
  2. Click on the Add New button to create a new DICOM launcher.
  3. In DICOM launcher dialog, fill in the fields:
    • Name: the name of the launcher
    • Icon path: the icon to display in the menu and toolbar. The path can be absolute or relative to the Weasis resources folder. When the icon is not found, the default icon is displayed.
    • Enable: to display the launcher in the menu and toolbar
    • Button: to display the launcher in the toolbar
  4. In DICOM Launcher dialog, click on Configure to specify the launch context.
  5. In Launcher Type, select the launcher type:
    • URI: add a URI to open a web page or a file. The URI can contain dynamic variables described below.
    • Application: run an application with parameters. The application Parameters and Environment Variables can contain dynamic variables described below.
      • Binary Path: the command to run the application.
      • Working Directory: the working directory of the application (optional).
      • Parameters: the parameters to pass to the application. Each line is a parameter.
      • Environment Variables: the environment variables to pass to the application. Each line is an environment variable.
      • Compatibility: the compatibility of the launcher with the current platform. This feature is useful when the launcher configuration is coming from the server side.
  6. In Launcher Type, click on Save to save the launcher parameters.
  7. In DICOM Launcher, click on Save to save the launcher general information.

List of dynamic variables in URI, Parameters and Environment Variables:

  • {dicom:wado.folder} the temporary folder for images downloaded from the WADO and DICOMWeb protocols.
  • {dicom:last.folder} the last open folder of Local Device in Import DICOM.
  • {dicom:selection.folder} it will display a selection dialog (such as Export DICOM) and copy the result to this folder, which will be deleted when Weasis is closed.
  • {tag::<key>} any DICOM attribute value from the selected image, e.g. {tag:AccessionNumber}
  • {pref:<key>} any preferences, e.g. {pref:weasis.user}.
Note

The Other Launcher is a special launcher that allows you to display a button on any viewers. For this type, only {pref:<key>} can be used as a dynamic variable.

How to run the third-party launcher

  • From the main menu, open File > Launcher and select the desired launcher
  • From the toolbar click on the launcher button
Note

The launcher must be enabled in the preferences to be displayed in the menu and toolbar.

Spatial Calibration

How to change the spatial calibration

When the image does not contain a default spatial calibration and it contains a ruler (or other element allowing to determine a known distance) then you can apply a calibration manually:

  1. Select a line in the Measurement Tool
  2. Draw a line on an object with a known distance
  3. Right-click on the selected line and enter the distance on the Manual Calibration window

Calibration Calibration
Apply Calibration Apply Calibration

Note

The calibration can be applied only to the current image or to all the images belonging to the series.

Info

Once calibrated, all measuring tools will produce results according to the calibration and the real-world zoom will display the images at the same size of the real objects. Currently, the calibration is not saved in the DICOM file.

Changing spacial calibration with Weasis 1.1.3

Styles and themes

Change the appearance of the user interface

How to apply another theme

From the main menu, open File > Preferences (Alt + P) and select the desired theme and click on “show” to see a partial preview (1).

Preferences Preferences

How to scale the user interface

It is recommended to adapt the scale factor to the one of the system (2). In this way, Weasis will scale on HiDPI displays as the operating system. On Windows it is the Display Scaling preference and on Linux it is either the display scaling factor or the text scaling factor.

However, the scaling factor can be increased (or even decreased) independently of the system. That means all the elements of the graphical interface will be adapted (fonts, icons, graphic components…).

Note

The last option (3) allows you to force the integration of the main menu in the window bar (not activated by default). This option appears only on Linux because there is a wide variety of window managers.

On Windows and Mac this option does not appear because it is always supported.

Changing the default theme or scale factor

See preferences

Translation

How to change the language and regional settings

Switching from the user interface

From the main menu, open File > Preferences (Alt + P) and select the desired language and the regional format. The languages available in the list can be partially translated. In this case you can participate in the translation directly from a web portal.

Preferences Preferences

Note

Anywhere in the user interface, date and number should be displayed with the selected regional format.

Changing the default locale settings

If you need to change the default settings, please see the preferences.

Logging

Configure and view log files

The log folder that can be opened from the menu “Help > Open the logging folder” (since Version4.1.0) contains two types of log:

  1. A boot log file (boot.log) is always written since Version3.5.0
  2. Rolling log files (default.log) that need to be activated in the preferences dialog (see below How to configure the rolling log files)
Tip

In order to determine the path of <user.home>/.weasis/log for versions prior to v4.1.0, go to the “Help > About Weasis” menu and find the property weasis.path in the “System Information” tab.

Once the file has reached its maximum size, it is compressed into a zip archive, since Version4.4.0.

Boot log files

The boot log file is used to trace the startup configuration to ensure that the application starts with the correct input parameters and configuration. This type of logs is interesting if the application doesn’t start, crash at startup, or if there is a problem with the startup preferences.

How to configure the rolling log files

Preferences Preferences

  • From the main menu “File > Preferences > General” enable “Rolling log” to activate writing to files
  • Enter the maximum of File numbers for rolling log (by default 20)
  • Enter the maximum size of each rolling file (by default 10 MB)
  • Select a log level which defines the verbosity of the traces (by default INFO)
  • Select a stacktrace limit which represents the number of lines (by default 3). No value is recommended for investigating problems (it means unlimited stacktrace lines)
Info

The default logging configuration comes from base.json, see Weasis Preferences. Some default values has changed since Version4.4.0.

Proxy server

How to configure a proxy server

Manual configuration from the user interface

From the main menu, open File > Preferences (Alt + P) and select Proxy Server.

The default configuration is Direct connection (no proxy) and by clicking on Manual proxy configuration you can define a custom proxy server (in the image below, a local proxy like Squid).

In order to fill in the fields, you must refer to the Java documentation.

Proxy configuration Proxy configuration

Tip

In some cases it is necessary to restart Weasis.

Configuration at launch

For setting JVM properties at launch, the selection in user interface must be Direct connection (no proxy) or configuration at launch.

Tip

The Java options can be manually set in the section “[JavaOptions]” of Weasis.cfg (in the installed path).

Examples of configuration:

  • Set the default system proxy
    -Djava.net.useSystemProxies=true
  • Set a local proxy like Squid
    -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128
  • Set a proxy in specific domain
    -Dhttps.proxyHost="proxy.mydomain.com" -Dhttps.proxyPort="8080" -Dhttp.proxyHost="proxy.mydomain.com" -Dhttp.proxyPort="8080" -Dhttp.nonProxyHosts="\*.mydomain.com|localhost" -Dhttp.proxyUser="user" -Dhttp.proxyPassword="password"
Note

The Java options can also be passed in the parameters of the URL (e.g. http://localhost:8080/weasis-pacs-connector/weasis?patientID=9702672&pro=“https.proxyHost%20127.0.0.1”&pro=“https.proxyPort%203128”).

Dicomizer

How to convert images into DICOM files

The Dicomizer tool allows you to convert standard images into DICOM files. This will facilitate the integration of these images into a DICOM archive.

Dicomizer will help you to manage the DICOM tags at the patient, study, and image levels in order to have more consistent data, easily searchable in the archive system, and compliant with DICOM viewers.

Dicomizer Dicomizer

How to Launch Dicomizer

As a Standalone Application

When installing Weasis, Dicomizer is available as a standalone application with this shortcut (only on Windows and Linux).

On macOS, you need to run the Dicomizer command from the terminal:

/Applications/Weasis.app/Contents/MacOS/Dicomizer

If you plan to use it frequently, with the Automator application you can create a new application Dicomizer.app with the Run Shell Script action containing the command.

From a WEB Context

The Dicomizer can be launched from a web context with the weasis:// protocol.

An example for launching Weasis Dicomizer Launch with the following parameters:

$weasis:config pro="felix.extended.config.properties file:conf/dicomizer.json" pro="gosh.port 17181"

Import Images

  1. Using the left panel, navigate through the file system to locate the images you want to convert. Click the button next to the combo box on the right to choose the folder containing the media files eligible for DICOM conversion.

  2. Drag and drop images into the central panel. By default, the images are grouped into a single series. Alternatively, you can split the images into different series by selecting the thumbnails and clicking the Import button. The dialog offers three options:

    • Do not group: All images are imported into a single series (same as drag-and-drop).
    • Group by date: Images are split into different series based on the acquisition date. You can specify the maximum time difference between two images to include them in the same series.
    • Group by name: All images are imported into a single series with a custom name.
Tip

The combo box contains the list of the last folders used. Connecting a USB device will automatically add the device path to the list.

Edit DICOM Tags

The Album panel allows you to manage the DICOM tags at the patient, study, and instance levels.

  • The left panel shows the group list representing DICOM series.
  • The main panel displays the thumbnails of the imported media files and allows you to select the images to edit the DICOM tags or by double click to open the image in the Photo Editor.
  • The bottom panel shows the DICOM tags of the selected images. Note that the image level tags are displayed only when a single image is selected.

The bottom panel organizes DICOM tags into categorized tree structures:

  • Global tags: Applicable to the patient and study levels.
  • Series level: Applicable to the series level.
  • Image level: Applicable to the image level.
Note

Tags can be configured in the preferences (items starting by weasis.acquire.meta).

Warning

If an item’s dashed outline in the table is red, it indicates that the value is mandatory and must be filled in.

If you don’t want to fill in the Global tags manually, they can be populated:

  • From a work list (configuration by the items starting by weasis.acquire.wkl). Here is an example to modify the configuration at launch:

    $weasis:config pro="felix.extended.config.properties file:conf/ext-dicomizer.properties" pro="gosh.port 17181" pro="weasis.acquire.wkl.host localhost" pro="weasis.acquire.wkl.aet DCM4CHEE" pro="weasis.acquire.wkl.port 11112" pro="weasis.acquire.wkl.station.aet WEASIS-MWL"

  • By the acquire:patient command containing an XML encoded as a DICOM XML file, e.g.:

    <?xml version="1.0" encoding="UTF-8"?>
    <tags>
    	<PatientID>97032168</PatientID>
    	<PatientName>TEST^TEST</PatientName>
    	<PatientBirthDate>19580703</PatientBirthDate>
    	<PatientSex>M</PatientSex>
    	<OperatorsName>RODUIT^NICOLAS</OperatorsName>
    	<AccessionNumber>000000003712</AccessionNumber>
    	<IssuerOfAccessionNumberSequence>
    		<LocalNamespaceEntityID>411713364</LocalNamespaceEntityID>
    	</IssuerOfAccessionNumberSequence>
    	<StudyID>411713364</StudyID>
    </tags>

Warning

Person name fields (PatientName, OperatorsName, etc.) should be formatted as Last^First^Middle^Prefix^Suffix according to the DICOM standard. This rule must also be applied when editing manually the DICOM tags.

Tip

Various actions are accessible from the contextual menu of a thumbnail:

  • Edit: Opens the Photo Editor to crop, rotate, or adjust the image. Double-clicking on the thumbnail has the same effect.
  • Remove: Deletes the image from the series without affecting the original file.
  • Move to…: Moves the image to a different series.

Edit the Images

The Photo Editor provides tools to crop, rotate, and adjust the image contrast. You can also add annotations to highlight specific areas and use measurement tools to indicate distances, angles, or areas. Additionally, the image can be calibrated using a known distance for obtaining real-world measurements.

Publish DICOM Files

Click the Publish button to send the DICOM files to a remote DICOM archive. The Publication panel allows you to:

  • Select the images to be published (all by default).
  • Handle the resolution of the images.
  • Specify the destination of the DICOM files from the list of DICOM remote nodes.
Note

The destination can be a specific remote node or a list of remote nodes available from the main menu, open File > Preferences (Alt + P) and select DICOM node list and edit ar add a new DICOM node.

When the Dicomizer destination is specified in the preferences, the list is not selectable in the publication panel. The preference items are the ones starting with weasis.acquire.dest.

Tip

A green checked icon on the thumbnail indicates that the image has been successfully published.

Stories

Weasis, the latest medical imaging software developed at the University Hospital of Geneva (HUG), serves as the clinical viewer for the hospital’s in-house Electronic Medical Records system. Since becoming open source in 2010, Weasis has earned its place as a reference DICOM viewer for medical professionals worldwide.

The University Hospital of Geneva has a remarkable legacy in developing medical imaging software. In 1990, HUG introduced Osiris, the first radiological imaging viewer to be freely distributed globally. Building on its success, OsiriX was launched in 2003 as the Mac-based successor to Osiris, further cementing HUG’s leadership in medical imaging innovation.

banner banner

List of Weasis Success Stories: Articles and Case Studies

2024

  • Weasis in the Ask Noah Show
    Listen: Podcast
    Weasis was featured in the Ask Noah Show, a podcast that discusses open-source software and technology. The episode highlighted Weasis as a free, open-source DICOM viewer that is easy to use and suitable for various medical imaging applications.

  • Evaluating Open-Source DICOM Viewers for Resource-Constrained Hospitals
    Read: Evaluating Open-Source DICOM Viewers for Resource-Constrained Hospitals
    A case study evaluating open-source DICOM viewers for resource-constrained hospitals. The study concluded that Weasis is the most suitable software due to its advanced tools for multiple modalities, user-friendliness, and detailed documentation.

2021

2018

2016

2015

2014

2009

Subsections of Stories

Weasis Multi-Touch

Master Thesis of Gérôme Pasquier