Commands at start-up and commands for driving Weasis from a socket

Currently only the commands "dicom:get" and "dicom:close" can be used at start-up. All the other commands allow to drive Weasis from a telnet session or from a socket.

For getting the list of commands, after starting Weasis, open a local telnet session:

telnet localhost 17179

Trying 127.0.0.1...

Connected to localhost.localdomain.

Escape character is '^]'.

____________________________

Welcome to Apache Felix Gogo

g!

Type "lb" for getting the list of bundles and their state.

Type "help" for getting all the available commands.

This value can be changed in the configuration of the launcher (by overriding the property or with a new jnlp template)

Here are the list of Weasis specific commands:

g! dcmview2d:layout
Select a split-screen layout
Usage: dcmview2d:layout [number | id] [VALUE]
  -n --number [integer value]  select the best matching number of views
  -i --id		select the layout from its identifier
  -? --help	show help

g! dcmview2d:mouseLeftAction
Change the mouse left action
Usage: dcmview2d:mouseLeftAction [action String value]
  -? --help		show help

g! dcmview2d:move
Change the pan value of the selected image
Usage: dcmview2d:move -- [x integer value] [y integer value] (it is mandatory to have '--' for negative values)
  -? --help		show help

g! dcmview2d:reset
Reset a tool or all the tools
Usage: dcmview2d:reset [action String value | all]
  -? --help		show help

g! dcmview2d:scroll
Scroll into the images of the selected series
Usage: dcmview2d:scroll [set | increase | decrease] [VALUE]
  -s --set [integer value]		set a new value from 0 to series size less one
  -i --increase [integer value]	increase of some amount
  -d --decrease [integer value]	decrease of some amount
  -? --help						show help

g! dcmview2d:synch
Set a synchronization mode {None Stack Tile }
Usage: dcmview2d:synch [VALUE]
  -? --help		show help

g! dcmview2d:wl
Change the window/level values of the selected image (increase or decrease into a normalized range of 4096)
Usage: dcmview2d:wl -- [window integer value] [level integer value] (it is mandatory to have '--' for negative values)
  -? --help       show help

g! dcmview2d:zoom
Change the zoom value of the selected image
Usage: dcmview2d:zoom [set | increase | decrease] [VALUE]
  -s --set [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 [integer value]	increase of some amount
  -d --decrease [integer value]	decrease of some amount
  -? --help						show help

g! dicom:get
Load DICOM files remotely or locally
Usage: dicom:get [Options] SOURCE
  -l --local        Open DICOMs from local disk
  -r --remote       Open DICOMs from an URL
  -p --portable       Open DICOMs from default directories at the same level of the executable
  -i --iwado        Open DICOMs from an XML (GZIP, Base64) file containing UIDs
  -w --wado        Open DICOMs from an XML (URL) file containing UIDs
  -? --help        show help

g! dicom:close
Remove DICOM files in Dicom Explorer
Usage: dicom:close [patient | study | series] [ARGS]
  -a --all				Close all patients
  -p --patient <args>	Close patient, [arg] is patientUID (PatientID + Patient Birth Date, by default)
  -y --study <args>		Close study, [arg] is Study Instance UID
  -s --series <args>	Close series, [arg] is Series Instance UID
  -? --help				show help


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

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

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

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

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

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

Weasis Portable distribution

There are two ways to open local images with the portable distribution.

Load images automatically from configured directory

Set images into a “dicom” or “images” directory at the same level of the binary launcher (c.f. weasis-win32.exe). The default directories can be changed in weasis/conf/config.properties, see the property "weasis.portable.dicom.directory" and "weasis.portable.dicom.cache".

Launch Weasis by double clicking on the executable file or in command-line (c.f. on Linux: ./weasis-linux.sh '$dicom:get --portable')

Launch arguments

./weasis-linux.sh '$dicom:get -l /home/Images/'


Multiple commands:
./weasis-linux.sh '$dicom:get -l "/DICOM/Overlay"' '$dicom:get -l "/DICOM/test"'


Local directory with a URI format:
./weasis-linux.sh '$dicom:get -l "file:/DICOM/Overlay"'

Open non DICOM images (Local and URL):
./weasis-linux.sh '$image:get -f "/home/Images/test.png" -u https://dcm4che.atlassian.net/wiki/download/attachments/3670024/weasis-mpr.png'

weasis-win32.exe $dicom:get -l "E:\\DICOM\\Overlay" "E:\\DICOM\\Shutter"
 
weasis-win32.exe $dicom:get -l "E:/DICOM/Overlay" "E:/DICOM/Shutter"