Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Currently only the commands "dicom:get" and "dicom:close" can be used The commands listed below can be applied at start-up or in a telnet session. All the other commands starting by "dcmview2d:" allow to drive Weasis from a telnet session or from a socket.Weasis and are not adapted to be used at start-up.

Warning
titleCommands status

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


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

...

Code Block
languagetext
themeDJango
titledcmview2d:layout
g! dcmview2d:layout
Select a split-screen layout
Usage: dcmview2d:layout [number ( -n NUMBER | id] [VALUE]
  -i ID )
  -n --number [integer value]  select=NUMBER  select the best matching number of views
   -i --id		=ID          select the layout from its identifier
   -? --help	           show help


Code Block
languagetext
themeDJango
titledcmview2d:mouseLeftAction
g! dcmview2d:mouseLeftAction
Change the mouse left action
Usage: dcmview2d:mouseLeftAction COMMAND
[actionCOMMAND String value]is (sequence|winLevel|zoom|pan|rotation|crosshair|measure|draw|contextMenu|none)
  -? --help		       show help


Code Block
languagetext
themeDJango
titledcmview2d:move
g! dcmview2d:move
Change the pan value ofPan the selected image
Usage: dcmview2d:move -- X [xY
integerX value]and [yY integerare value] (itInteger. It is mandatory to have '--' (end of options) for negative values)
  -? --help		       show help


Code Block
languagetext
themeDJango
titledcmview2d:reset
g! dcmview2d:reset

Reset a tool or all the toolsimage display
Usage: dcmview2d:reset [action String value | all] (-a | COMMAND...)
COMMAND is (winLevel|zoom|pan|rotation)
  -a --all        reset to original display
  -? --help		       show help


Code Block
languagetext
themeDJango
titledcmview2d:scroll
g! dcmview2d:scroll
Scroll into the images of the selected series
Usage: dcmview2d:scroll [set ( -s NUMBER | -i increaseNUMBER | decrease] [VALUE]-d NUMBER)
  -s --set [integer value]		=NUMBER       set a new value from 01 to series size less one
  -i --increase=NUMBER [integer value]	increase of some amount
  -d --decrease=NUMBER [integer value]	decrease of some amount
  -? --help						             show help


Code Block
languagetext
themeDJango
titledcmview2d:synch
g! dcmview2d:synch
Set a synchronization mode
{None Stack Tile }
Usage: dcmview2d:synch VALUE
[VALUE]VALUE is (None|Stack|Tile)
  -? --help		       show help


Code Block
languagetext
themeDJango
titledcmview2d: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 [windowLEVEL
integerWIN value]and [levelLEVEL integerare value] (itInteger. It is mandatory to have '--' (end of options) for negative values)
  -? --help       show help


Code Block
languagetext
themeDJango
titledcmview2d:zoom
g! dcmview2d:zoom
Change the zoom value of the selected image
Usage: dcmview2d:zoom [(set VALUE | increase NUMBER | decrease] [VALUE]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 [integer value]	increase of some amount
  -d --decrease=NUMBER [integer value]	decrease of some amount
  -? --help						             show help


Code Block
languagetext
themeDJango
titledicom:get
g! dicom:get
Load DICOM files remotely or locally
Usage: dicom:get ([Options] SOURCE
  -l --local        Open-l PATH]... [-r URI]... [-p] [-i DATA]... [-w URI]...)
PATH is either a directory(recursive) or a file
  -l --local=PATH   open DICOMs from local disk
  -r --remote=URI    open   Open DICOMs from an URLURI
  -p --portable       Openopen DICOMs from defaultconfigured directories at the same level of the executable
  -i --iwado=DATA        Openopen DICOMs from an XML manifest (GZIP, -Base64)
file containing UIDs   -w --wado=URI       open Open DICOMs from an XML (URL) file containing UIDsmanifest
  -? --help         show help


Code Block
languagetext
themeDJango
titledicom:close
g! dicom:close
RemoveClose DICOM files in Dicom Explorer
Usage: dicom:close  [patient(-a | study | series] [ARGS]([-y UID]... [-s UID]...))
  -a --all				Close all patients   -p --patient <args>	Close patient, [arg] is patientUIDclose (PatientIDall +the Patient Birthpatients
Date, by default)
  -y --study <args>		Close=UID     close a study, [arg]UID is Study Instance UID
  -s --series <args>	Close=UID    close a series, [arg]UID is Series Instance UID
  -? --help				          show help


Code Block
languagetext
themeDJango
titleimage:get
g! image:get
Load an imageimages remotely or locally
Usage: image:get ([Options] SOURCE-f file]... [-u url]...)
  -f --file=FILE     Openopen an image from a file
  -u --url=URL      Open open an image from an URL
  -? --help          show help


Code Block
languagetext
themeDJango
titleimage : close
g! image:close
Close imgage seriesimages
Usage: dicom:close (-a | ([series]-g UID]... [ARGS]-s UID]...)) 
  -a --all Close         close all series
  -g --group=UID   close a group from its UID
  -s --series=UID <args>  close an Close series, [arg] is Series/image from its UID
  -? --help        show help


Code Block
languagetext
themeDJango
titleweasis:info
g! weasis:info
Show information about Weasis
Usage: weasis:info [Options](-v | -a)
  -v --version	    show version
  -a --all        show weasis specifications
  -? --help		       show help


Code Block
languagetext
themeDJango
titleweasis:ui
g! weasis:ui
Manage user interface
Usage: weasis:ui [Options](-q | -v)
  -q --quit		shutdown Weasis
  -v --visible	set window on top
  -? --help		show help


Code Block
languagetext
themeDJango
titleacquire: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


Info
titleCommands at start-up

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

...

Code Block
languagetext
themeDJango
titleLinux and Mac, commands must be in between quotes
./weasisviewer-linux.sh '$dicom:get -l /home/Images/'


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


Local directorydirectories with(recursive) aor URI formatfiles:
./weasisviewer-linux.sh '$dicom:get -l "file:/DICOM/Overlay" -l "/DICOM/test/file.dcm"'

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

...

Code Block
languagetext
themeDJango
titleWindows commands
weasisviewer-win32.exe $dicom:get -l "E:\\DICOM\\Overlay" -l "E:\\DICOM\\Shutter"
 
weasisviewer-win32.exe $dicom:get -l "E:/DICOM/Overlay" -l "E:/DICOM/Shutter"


Warning
titleSpecial characters

The command interpreter has changed from weasis 2.6.0. Command containing special characters like '&' must be within quotes or double quotes. Example: 
dicom:get -w "http://launcher-weasis.rhcloud.com/weasis-pacs-connector/manifest?studyUID=2.16.756.5.5.100.397184556.14391.1373576413.1508&studyUID=1.3.6.1.4.1.5962.1.1.0.0.0.1168612284.20369.0.1&studyUID=1.3.6.1.4.1.21367.0.1.13.1021"

It also depends of the command line system. For instance, in Eclipse the launcher parameters needs to escape get an escaped '&', so the command is:
$dicom:get -w "http://launcher-weasis.rhcloud.com/weasis-pacs-connector/manifest?studyUID=2.16.756.5.5.100.397184556.14391.1373576413.1508\&studyUID=1.3.6.1.4.1.5962.1.1.0.0.0.1168612284.20369.0.1\&studyUID=1.3.6.1.4.1.21367.0.1.13.1021"