Commands at start-up and commands for driving Weasis from a socket
All Currently only the following commands must commands "dicom:get" and "dicom:close" can be used at start-up, in the OSGI console, in . 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:
| Code Block |
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | OSGI Console |
|---|
|
telnet localhost 17179
Trying 127.0.0.1...
Connected to localhost.localdomain.
Escape character is '^]'.
____________________________
Welcome to Apache Felix Gogo
g!
|
...
Type "help" for getting all the available commands.
| Info |
|---|
| title | Modifying the default port number |
|---|
|
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:
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:layout |
|---|
|
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 select the layout from its identifier
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:mouseLeftAction |
|---|
|
g! dcmview2d:mouseLeftAction
Change the mouse left action
Usage: dcmview2d:mouseLeftAction [action String value]
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:move |
|---|
|
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
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:reset |
|---|
|
g! dcmview2d:reset
Reset a tool or all the tools
Usage: dcmview2d:reset [action String value | all]
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:scroll |
|---|
|
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
|
| Code Block |
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:synch |
|---|
|
g! dcmview2d:synch
Set a synchronization mode {None Stack Tile }
Usage: dcmview2d:synch [VALUE]
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:wl |
|---|
|
g! dcmview2d:wl
Change the window/level values of the selected image
Usage: dcmview2d:wl -- [window integer value] [level integer value] (it is mandatory to have '--' for negative values)
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dcmview2d:zoom |
|---|
|
g! dcmview2d:zoom
Change the zoom value of the selected image (0.0 is the best fit value in the window
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
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dicom:close |
|---|
|
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
|
| Code Block |
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | dicom:get |
|---|
|
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
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | weasis:info |
|---|
|
g! weasis:info
Show information about Weasis
Usage: weasis:info [Options]
-v --version show version
-? --help show help
|
| Code Block |
|---|
|
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | weasis:ui |
|---|
|
g! weasis:ui
Manage user interface
Usage: weasis:ui [Options]
-q --quit shutdown Weasis
-v --visible set window on top
-? --help show help
|
| Info |
|---|
| title | Commands at start-up |
|---|
|
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
| Code Block |
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | Linux and Mac, |
|---|
|
...
| commands must be in between quotes |
|
...
|
./weasis-linux.sh '$dicom:get -l /home/Images/' |
...
...
./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"' |
...
| Code Block |
|---|
| language | text |
|---|
| theme | DJango |
|---|
| title | Windows commands |
|---|
|
weasis-win32.exe $dicom:get -l "E:\\DICOM\\Overlay" "E:\\DICOM\\Shutter" |
...
weasis-win32.exe $dicom:get -l "E:/DICOM/Overlay" "E:/DICOM/Shutter" |
...