Professional Documents
Culture Documents
903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 1
Authors : Wenhong.Shen
Doc. No. : 903-002-05
Date : 2014-08-29
Version : V3.0.0.10
Status : Release
Project : N/A
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 2
Approver YIMIN.HUANG
Review Record
Department Participant Department Participant
R&D Haifeng.Zhang R&D Ran.Yuan
R&D Zhiqiang.Fang
Delivery Department
Revision History
Fig.1
iDemo the main window as shown above:
Function description of regions and buttons within the main window as follows:
1 Start----------------Load NIC device driver 13 Offset--------Load Offset correction mode
2 Stop----------------Unload NIC device driver 14 Gain----------Load Gain correction mode
3 PREP---------------Clear lags of the panel 15 Defect-------Load Defect correction mode
4 Abort Exp----------Cancel Exposure 16 Create-------Create correction files
5 Acquire------------Acquire one frame of image 17 Software Version Number
6 PREP Acquire----Clear and acquire one frame 18 Status of the SDK
of image
7 Config-------------Detector Settings 19 WiFi signal and battery capacity indication
8 SEQU------------Sequence acquisition of images 20 Image acquisition instruction box
9 STOP---------------Stop Sequence acquisition 21 Pixel X/Y coordinate
10 Save----------------Save image (dcm) 22 Gray Scale Value of Pixel(14 bit)
Double-click the left mouse button, the image display in center and with
maximum size
Double-click the right mouse button, restore the window level and width for
WL:8191/WW:16383
Drag the left mouse button to drag the image display
Lateral-drag the right mouse button to adjust the window width, and
vertical-drag the right mouse button to adjust the window level
F3 Key: Quickly locate the image window width and window level
(Connection Mode 1)
External AP Mode
AP
(Connection Mode 2)
(Connection Mode 3)
Detector AP Mode
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 5
AP
(Connection Mode 4)
2. Build connection
Click “Start” button and input IP address and port number (the IP address should
be the same as the IP address of the network card connected with detector. The
port should use the default value of 28000), click “Connect” to enter the main
window.
Notice:
1) Once change connection from different network card, such as switch
connection mode 1 to connection mode 4, operator must re-connect
detector by using different IP address.
2) Connecting with external AP, such as connection mode 2 and connection
mode 3, switching between wired and wireless connection mode does not
need any extra operation on software.
3) The working IP address of detector is 192.168.8.8(default). Once the detector
connecting with Ethernet cable, the working IP address is force to wired
Ethernet interface. Unless removing Ethernet cable, the working IP address
automatic switch to wireless interface.
Fig.2
New Feature 4) The rule of Multi-Share control is based on IP address examine:
a. Detector restricts access to 2nd software which uses different IP address,
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 6
3. Image acquisition
Confirm all connection is normal, click “PREP Acquire” to wait and acquire a dark
image(check whether the image is ok).
If the product type is Mars1417V,when receiving the image data, there will be
message about receiving progress and replenish time on the panel feedback
message bar(as Fig.1:23)
(1) Progress number: n/10: Progress number means the first time receiving the
image data. n means the receiving progress, value from 1 to 10.
(2) Replenish progress number: n/10 (times: m): Replenish progress number
means that the image data is not received complete in the first time, and
replenishing the lost data. n means the replenishing progress. m represents
the time of replenishing.
(3) When all the data is received or after 3 times of replenishing, software will
show the image in the region of image display(Fig.1:18), and the message
“got image” will be displayed on the Panel Feedback Message bar(Fig.1:23)
Fig.3
Trigger Mode Support:
Inner——In config window, select “Trigger” as “Inner”, click on “Write”
button. After setting, click on “PREP” button and wait until “Exposure prohibit” in
feedback message window becoming “Exposure enable”, then exposure and wait
to acquire the image;
Software —— In config window, select “Trigger” as “Software”, click “Write”.
First click “PREP” and wait until “Exposure prohibit” in feedback message window
becoming “Exposure enable”, then exposing. After exposure, click “Acquire” button,
the image would be acquired to iDemo window (the indicator box of status bar
flashed with red color).
5. Preview Image
In post offset mode, including hardware post offset and SDK post offset mode, SDK
provide one preview of original light exposure image. The indicator of preview image
on the Panel Feedback Message bar(Fig.1:23) is ‘Prev Image’
In config.ini file, modify the parameter of PREVIEW_FOR_POST_OFFSET_EN can
enable/disable ‘preview image’ display on screen.
In hardware post offset mode, preview image size is 1/4.
7. Configuration description:
Name Description Modify
Basic Configuration:
acquisition.
Acquire Delay delay time before the image acquisition. NO
Integrate The integration time for the photodiode
NO
during the TFT is turned on period.
Clear Time To set the time needed for detector
preparing. Note that currently this time is NO
fixed and not configurable.
Trigger Detector has three trigger mode YES
SDK Auto Clear Set the detector in auto clear mode YES
SDK Auto Clear Period Auto clear period set in software YES
8. WiFi configuration
Notice:
1) In cable connection mode, the new WiFi setting will take effect immediately
as soon as writing configuration to detector.
2) In wireless connection mode, the new setting will be saved in detector, but
not to take effect unless detector restarts.
Click “WiFi Setting…” button(in the middle of “Config” dialog) to enter the WiFi
Configuration dialog.
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 11
Fig.4
Mars1417V support AP mode and Client mode. In Client mode user can saved
at most 10 sets of wireless AP setting(include SSID & password). See fig4 red
box.
1 SSID: Type in or select the available SSID of AP 10 AP Mode------Enable detector AP mode
New Feature 2 Scan from FPD-----Send command to detector 11 SSID: Type in the SSID for AP mode
AP list
5 Add----------Create new record in list 14 Frequency: 2.4GHz/5GHz select
A Read Local REG Setting-----Read AP setting for D Read Config from FPD-------Send command
Cable Registration used in config.ini file to detector for reading wireless setting
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 12
B Write Local REG Setting----- Save AP setting E Write Config from FPD-------Send
for Cable Registration used in config.ini file. command to detector for wireless module
setting
C Read WiFi Status------Send command to
detector for reading wireless module working
status
9. Cable Registration
Fig.5
In the first time trying to build connection to a detector, SDK will start the
Notice:
1) To realize this function, detector should firstly connect with Ethernet cable
then power on the detector.
2) To forbidden the function, please modify the parameter of WIRELESS_EN (see
segment [REGISTRATION_INFO]) in config.ini file
Notice:
New Feature Implementation of the *.img file transmission must rely on the FTP server. At
the same time the *.img file must exist in FTP sharing folder and the directory path
must be same as the setting in config.ini file.
[FILE_UPDATE]
SRV_PORT=21000
USR=UptUser
PWD=12345
UPDATE_FILE_PATH=.\update\
2. Then generate gain template file, click “Create”, pop-up the correction dialog
then enter “Correction Wizard” window, do gain correction in the form of “Gain”
Preparations before Gain correction:
Adjust X-ray center line and auxiliary center line to ensure the consistency of
the light field center line. It is important to confirm the center of beam
diaphragm is at the same line with X-ray center, in order to ensure quickly
locate panel with aligning the center line of beam diaphragm (see
appendix).
The distance between beam diaphragm and panel requires >120cm. If the
condition does not allow, the Gain correction effect is generally less than
ideal, need to communicate in advance with the customer about the impact
on image quality.
For DR application, In order to meet the clinical demands and simulate the
human body medium with radiation, when doing correction it requires to
place attenuation device conformed with RQA5 standard under beam
diaphragm. It is recommended to use the standard purity>99.9% 21mm Al
plates under the X-ray tube voltage 70-75kV condition, to standardize
hardness and quality of X-ray.
At inner trigger, it needs to click “PREP” to wait until the detector is ready before
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 15
Fig.1
2. Select “1” from Current combo box, and then click “Start creating” button,
the message dialog will pop-up, as in Fig.2
Fig.2
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 17
Fig.3
Fig.4
Fig.5
3. According to the expect gray scale shown in the pop-up dialog box Figure 2,
adjust the dose of the high-voltage generator(the dose in the dialog is a
Reference value with EMD high-voltage generator, maybe not suit the other
generator), click “ok”, when the message “Exposure Enable” shows in the UI,
then Trigger the high-voltage generator to exposure. When the Panel
Feedback Message item shows that “Light calibration frame complete”, it
means that one step is finished, you should select the next item from the
Current combo-box, and Repeat this process, (there will be a exposure dose
tip window pops up in 1 to 4 steps (as the Fig2, 3, 4, 5), please set the next
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 18
Image1 1000 70 20 20
Image2 1000 40 50 50
shown in the “Correction Wizard” dialog box, please wait for a moment, until the
message “The most gain was created successfully!” appears.
Do Offset、Gain、Defect calibration:
After all correction finished, select “Offset” as “POST”, select “Gain” as “CURR”,
select “Defect” as “CURR”, do normal exposure to acquire the perfect image.
1. Click “Open” button which is on the tool bar, you can select
a defect file from the hard disk and open it, and then the button will change into
side of the tool bar, you can modify the opened defect file in this dialog, add bad
points or lines, or delete them.
2. You should click “Save” to save the modifications which you have done.
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 20
Note: If iDemo has not connected to the detector, it can open any size defect files, if
iDemo has connected to the detector, it just can open the images which have the
same resolution as the current detector
1 2
Detector state timing diagram
The timing status of the SDK in the two kinds of trigger modes as below: <1>、<2>、
<3>、<4>、<5>.
“User Idle” status. If user exposure and “post-offset” is not selected, the image
acquisition process, SDK will return to “User Busy” status. SDK will return to “User
Idle” status after the image has received completely.
<5>: In software mode, if the user sends Clear command to the FPD, SDK will
enter “User Busy” status. If detector finished the Clear state, SDK will return to “User
Idle” status. If user exposes and the “post-offset” is selected, the image acquisition
process (including light image and post-offset dark image), SDK will return to “User
Busy” status. SDK will return to “User Idle” status after the image has received
completely.
14. G-Sensor
On the bottom of config dialog, there are four buttons for operating G-Sensor.
The user interface as below:
Read Shock Log: Read out the history shock log from detector.
Clear Shock Log: Erase the history shock log, which is saved in detector.
Shock Threshold: Input the threshold value.
R: Read out the G-Sensor threshold value.
W: Setting the new G-Sensor threshold value.
The TFP Server Port setting should be same as config.ini file contains.
[FILE_UPLOAD]
SRV_PORT=21000
USR=FtpUser
PWD=12345
IMG_SAVE_PATH=.\upload\
Click “Image-Open” button in IDemo tool bar to open load Image dialog.
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 24
Get File List Get the local storage file list from detector
Start Upload Multi select the items in list, specify the files to be uploaded, and
click “Start Upload” to begin transfer. The software will send a
message of uploading result for each file in Upload Status
column.
In IDemo select Config UI and click “Correction Method Sel…” button to enter
dialog. Template status as below:
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 25
Update Status button use to get template file list and correction function setting按
from FPD.
Notice:
This tool need extra USB IrDA device.
The low power warning information will send with FPD heartbeat package, and will
be displayed in IDemo status bar.
Doc N0. 903-002-05
iRay Technology (Shanghai) Ltd. Version V3.0.0.10
Date 2014-08-29
SDK Manual Interface
Page 27
DETECTOR_MODE=Detector
DETECTOR_NAME_1=A
DETECTOR_NAME_2=
FPD_REGISTER=1
// A
SOURCE_IP_1=192.168.8.188
SOURCE_PORT_1=28000
DEST_IP_1=192.168.8.8
DEST_PORT_1=27888
DETECTOR_SN_1=
// B
SOURCE_IP_2=192.168.8.188
SOURCE_PORT_2=28001
DEST_IP_2=192.168.8.9
DEST_PORT_2=27888
DETECTOR_SN_2=
POST_OFFSET_TIME=300
SET_LOG_INFO=0
SET_NET_CONN_STATUS=1
CHECK_ADAPTER_CONNECTION_NET=1
CHECK_ADAPTER_SLEEP_TIME=3000
CHECK_ADAPTER_RESET_TIME=4000
CHECK_ADAPTER_FPD_READY_TIME=17000
CHECK_ADAPTER_TOTAL_RESET_NUMBER=5
LOW_GAIN_FILE_NUMBER=3
HIGH_GAIN_FILE_NUMBER=16
APPLY_CORRECTION_MODE=0
APPLY_GAIN_CORRECTION=0
APPLY_DEFECT_CORRECTION=0
TCP_RECONNECT_TIMES=3
REPLENISH_TIMES=3
WAIT_COMPLETE_IMAGE=1
ACQUIRE_IMAGE_TIMEOUT_TIME=30000
SET_SAVE_LIGHT_DATA=0
SET_SAVE_POST_OFFSET_DATA=0
SET_SAVE_LIGHT_POST_OFFSET_DATA=0
SET_SAVE_LIGHT_POST_OFFSET_GAIN_DATA=0
SET_SAVE_LIGHT_POST_OFFSET_GAIN_DEFECT_DATA=0
TEMP_STANDARD_VALUE=45
DLL_FPDLIB=3.0.0.10
DLL_FPDCALIBRATION=3.0.0.10
DLL_FPDCALIBRATIONPROC=3.0.0.10
DLL_FPDCOMMONFUNC=3.0.0.10
DLL_FPDCORRECTION=3.0.0.10
DLL_FPDDEFECT=3.0.0.10
DLL_FPDDETECTOR=3.0.0.10
DLL_FPDDETECTORE3=3.0.0.10
DLL_FPDIMAGEPROCESS=3.0.0.10
DLL_FPDUDP=3.0.0.10
DLL_FPDSYNCBOX=2.0.1.0
DLL_IDICOM=1.0.0.2
GRID_LINE_REMOVAL=0
SET_SCALE_TIME=0
SCALE_TIME=6000
SDK_BUSY_TIMEOUT_TIME=20000
USE_SYNCBOX=0
SAVE_EXP_MODE_IMG=1
SAVE_MULT_CORR_FOLDER=0
FPD_OFFLINE_TIMEOUT_TIME=10000
PREVIEW_FOR_POST_OFFSET_EN=1
[CONFIG_CORRECTION]
OFFSET_NUMBER=5
PRE_OFFSET_TIME=500,5000
[WIRELESS_INFO]
SSID=CISCO_AP_2.4G
KEY=1122334455
[REGISTRATION_INFO]
STATION_NAME=IrayDR
WIRELESS_EN=1
WIRELESS_PRIORITY=0
[FILE_UPLOAD]
SRV_PORT=21000
USR=FtpUser
PWD=12345
IMG_SAVE_PATH=.\upload\
[FILE_UPDATE]
SRV_PORT=21000
USR=UptUser
PWD=12345
UPDATE_FILE_PATH=.\update\