Skip to content

Commit 815537a

Browse files
scaramallionscaramallion
committed
DOC new release 3.0 [skip-ci]
1 parent 47fcf1f commit 815537a

1,288 files changed

Lines changed: 782421 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎3.0/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 7001d7b741f067f2b63aa0d3268b92a4
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎3.0/.nojekyll‎

Whitespace-only changes.

‎3.0/_sources/apps/echoscp.rst.txt‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
=======
2+
echoscp
3+
=======
4+
5+
.. code-block:: text
6+
7+
$ python -m pynetdicom echoscp [options] port
8+
9+
Description
10+
===========
11+
The ``echoscp`` application implements a Service Class Provider (SCP) for the
12+
:dcm:`Verification<part04/chapter_A.html>` service class. It listens for
13+
incoming association requests on the specified *port*, and once an association
14+
is established, responds to incoming C-ECHO requests. The application can be
15+
used to verify basic DICOM connectivity.
16+
17+
The source code for the application can be found :gh:`here
18+
<pynetdicom/tree/main/pynetdicom/apps/echoscp>`
19+
20+
Usage
21+
=====
22+
23+
The following example shows what happens when it's started and receives
24+
a C-ECHO request from a peer:
25+
26+
.. code-block:: text
27+
28+
$ python -m pynetdicom echoscp 11112
29+
30+
31+
More information is available when running with the ``-v`` option:
32+
33+
.. code-block:: text
34+
35+
$ python -m pynetdicom echoscp 11112 -v
36+
I: Accepting Association
37+
I: Received Echo Request (MsgID 1)
38+
I: Association Released
39+
40+
When a peer AE attempts to send non C-ECHO message:
41+
42+
.. code-block:: text
43+
44+
$ python -m pynetdicom echoscp 11112 -v
45+
I: Accepting Association
46+
I: Association Aborted
47+
48+
Much more information is available when running with the ``-d`` option:
49+
50+
.. code-block:: text
51+
52+
$ python -m pynetdicom echoscp 11112 -d
53+
D: echoscp.py v0.7.0
54+
D:
55+
D: Request Parameters:
56+
D: ======================= INCOMING A-ASSOCIATE-RQ PDU ========================
57+
D: Their Implementation Class UID: 1.2.276.0.7230010.3.0.3.6.2
58+
...
59+
I: Received Echo Request (MsgID 1)
60+
D: ========================== INCOMING DIMSE MESSAGE ==========================
61+
D: Message Type : C-ECHO RQ
62+
D: Presentation Context ID : 1
63+
D: Message ID : 1
64+
D: Data Set : None
65+
D: ============================ END DIMSE MESSAGE =============================
66+
I: Association Released
67+
68+
69+
Options
70+
=======
71+
General Options
72+
---------------
73+
``-q --quiet``
74+
quiet mode, prints no warnings or errors
75+
``-v --verbose``
76+
verbose mode, prints processing details
77+
``-d --debug``
78+
debug mode, prints debugging information
79+
``-ll --log-level [l]evel (str)``
80+
One of [``'critical'``, ``'error'``, ``'warning'``, ``'info'``,
81+
``'debug'``], prints logging messages with corresponding level
82+
or lower
83+
84+
Network Options
85+
---------------
86+
``-aet --ae-title [a]etitle (str)``
87+
set the local AE title (default: ``ECHOSCP``)
88+
``-ta --acse-timeout [s]econds (float)``
89+
timeout for ACSE messages (default: ``30``)
90+
``-td --dimse-timeout [s]econds (float)``
91+
timeout for DIMSE messages (default: ``30``)
92+
``-tn --network-timeout [s]econds (float)``
93+
timeout for the network (default: ``30``)
94+
``-pdu --max-pdu [n]umber of bytes (int)``
95+
set maximum receive PDU bytes to n bytes (default: ``16382``)
96+
97+
Preferred Transfer Syntaxes
98+
---------------------------
99+
``-x= --prefer-uncompr``
100+
prefer explicit VR local byte order
101+
``-xe --prefer-little``
102+
prefer explicit VR little endian transfer syntax
103+
``-xb --prefer-big``
104+
prefer explicit VR big endian transfer syntax
105+
``-xi --implicit``
106+
accept implicit VR little endian transfer syntax only
107+
108+
DICOM Conformance
109+
=================
110+
The ``echoscp`` application supports the Verification service as an SCP. The
111+
following SOP classes are supported:
112+
113+
Verification Service
114+
--------------------
115+
116+
SOP Classes
117+
...........
118+
119+
+------------------+------------------------+
120+
| UID | SOP Class |
121+
+==================+========================+
122+
|1.2.840.10008.1.1 | Verification SOP Class |
123+
+------------------+------------------------+
124+
125+
Transfer Syntaxes
126+
.................
127+
128+
+------------------------+----------------------------------------------------+
129+
| UID | Transfer Syntax |
130+
+========================+====================================================+
131+
| 1.2.840.10008.1.2 | Implicit VR Little Endian |
132+
+------------------------+----------------------------------------------------+
133+
| 1.2.840.10008.1.2.1 | Explicit VR Little Endian |
134+
+------------------------+----------------------------------------------------+
135+
| 1.2.840.10008.1.2.1.99 | Deflated Explicit VR Little Endian |
136+
+------------------------+----------------------------------------------------+
137+
| 1.2.840.10008.1.2.2 | Explicit VR Big Endian |
138+
+------------------------+----------------------------------------------------+
139+
| 1.2.840.10008.1.2.4.50 | JPEG Baseline (Process 1) |
140+
+------------------------+----------------------------------------------------+
141+
| 1.2.840.10008.1.2.4.51 | JPEG Extended (Process 2 and 4) |
142+
+------------------------+----------------------------------------------------+
143+
| 1.2.840.10008.1.2.4.57 | JPEG Lossless, Non-Hierarchical (Process 14) |
144+
+------------------------+----------------------------------------------------+
145+
| 1.2.840.10008.1.2.4.70 | JPEG Lossless, Non-Hierarchical, First-Order |
146+
| | Prediction (Process 14 [Selection Value 1]) |
147+
+------------------------+----------------------------------------------------+
148+
| 1.2.840.10008.1.2.4.80 | JPEG-LS Lossless Image Compression |
149+
+------------------------+----------------------------------------------------+
150+
| 1.2.840.10008.1.2.4.81 | JPEG-LS Lossy (Near-Lossless) Image Compression |
151+
+------------------------+----------------------------------------------------+
152+
| 1.2.840.10008.1.2.4.90 | JPEG 2000 Image Compression (Lossless Only) |
153+
+------------------------+----------------------------------------------------+
154+
| 1.2.840.10008.1.2.4.91 | JPEG 2000 Image Compression |
155+
+------------------------+----------------------------------------------------+
156+
| 1.2.840.10008.1.2.4.92 | JPEG 2000 Part 2 Multi-component Image Compression |
157+
| | (Lossless Only) |
158+
+------------------------+----------------------------------------------------+
159+
| 1.2.840.10008.1.2.4.93 | JPEG 2000 Part 2 Multi-component Image Compression |
160+
+------------------------+----------------------------------------------------+
161+
| 1.2.840.10008.1.2.5 | RLE Lossless |
162+
+------------------------+----------------------------------------------------+

‎3.0/_sources/apps/echoscu.rst.txt‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
=======
2+
echoscu
3+
=======
4+
5+
.. code-block:: text
6+
7+
$ python -m pynetdicom echoscu [options] addr port
8+
9+
Description
10+
===========
11+
The ``echoscu`` application implements a Service Class User (SCU) for the
12+
:dcm:`Verification<part04/chapter_A.html>` service class. It establishes an
13+
association with a peer Application Entity (AE), sends a
14+
:dcm:`C-ECHO<part07/sect_9.3.5.html#sect_9.3.5.1>` request and waits for a
15+
response. The application can be used to verify basic DICOM connectivity.
16+
17+
The source code for the application can be found :gh:`here
18+
<pynetdicom/tree/main/pynetdicom/apps/echoscu>`
19+
20+
Usage
21+
=====
22+
23+
The following example shows what happens when it is successfully run on
24+
an SCP at IP ``127.0.0.1`` and listen port ``11112`` that supports the
25+
Verification service:
26+
27+
.. code-block:: text
28+
29+
$ python -m pynetdicom echoscu 127.0.0.1 11112
30+
31+
When attempting to send a C-ECHO request to an SCP that doesn't support the
32+
Verification service:
33+
34+
.. code-block:: text
35+
36+
$ python -m pynetdicom echoscu 127.0.0.1 11112
37+
E: No accepted presentation contexts
38+
39+
When the association request is rejected by the SCP (in this case because the
40+
called AE title wasn't recognised):
41+
42+
.. code-block:: text
43+
44+
$ python -m pynetdicom echoscu 127.0.0.1 11112
45+
E: Association Rejected
46+
E: Result: Rejected Permanent, Source: Service User
47+
E: Reason: Called AE title not recognised
48+
49+
When attempting to associate with a non-DICOM peer:
50+
51+
.. code-block:: text
52+
53+
$ python -m pynetdicom echoscu 127.0.0.1 11112
54+
E: Association request failed: unable to connect to remote
55+
E: TCP Initialisation Error: Connection refused
56+
57+
More information is available with the ``-d`` flag:
58+
59+
.. code-block:: text
60+
61+
$ python -m pynetdicom echoscu 127.0.0.1 11112 -d
62+
D: echoscu.py v0.7.0
63+
D:
64+
I: Requesting Association
65+
D: Request Parameters:
66+
D: ======================= OUTGOING A-ASSOCIATE-RQ PDU ========================
67+
...
68+
D: ========================== END A-ASSOCIATE-AC PDU ==========================
69+
I: Association Accepted
70+
I: Sending Echo Request: MsgID 1
71+
D: pydicom.read_dataset() TransferSyntax="Little Endian Implicit"
72+
I: Received Echo Response (Status: Success)
73+
I: Releasing Association
74+
75+
Parameters
76+
==========
77+
``addr``
78+
TCP/IP address or hostname of DICOM peer
79+
``port``
80+
TCP/IP port number of peer
81+
82+
Options
83+
=======
84+
General Options
85+
---------------
86+
``-q --quiet``
87+
quiet mode, prints no warnings or errors
88+
``-v --verbose``
89+
verbose mode, prints processing details
90+
``-d --debug``
91+
debug mode, prints debugging information
92+
``-ll --log-level [l]evel (str)``
93+
One of [``'critical'``, ``'error'``, ``'warning'``, ``'info'``,
94+
``'debug'``], prints logging messages with corresponding level
95+
or lower
96+
97+
Network Options
98+
---------------
99+
``-aet --calling-aet [a]etitle (str)``
100+
set the local AE title (default: ``ECHOSCU``)
101+
``-aec --called-aet [a]etitle (str)``
102+
set the called AE title for the peer AE (default: ``ANY-SCP``)
103+
``-ta --acse-timeout [s]econds (float)``
104+
timeout for ACSE messages (default: ``30``)
105+
``-td --dimse-timeout [s]econds (float)``
106+
timeout for DIMSE messages (default: ``30``)
107+
``-tn --network-timeout [s]econds (float)``
108+
timeout for the network (default: ``30``)
109+
``-pdu --max-pdu [n]umber of bytes (int)``
110+
set maximum receive PDU bytes to n bytes (default: ``16382``)
111+
112+
Transfer Syntax Options
113+
-----------------------
114+
``-xe --request-little``
115+
request explicit VR little endian TS only
116+
``-xb --request-big``
117+
request explicit VR big endian TS only
118+
``-xi --request-implicit``
119+
request implicit VR little endian TS only
120+
121+
Miscellaneous Options
122+
---------------------
123+
``--repeat [n]umber (int)``
124+
repeat echo request ``n`` times
125+
``--abort``
126+
abort association instead of releasing it
127+
128+
129+
DICOM Conformance
130+
=================
131+
The ``echoscu`` application supports the Verification service as an SCU. The
132+
following SOP classes are supported:
133+
134+
Verification Service
135+
--------------------
136+
137+
SOP Classes
138+
...........
139+
140+
+------------------+------------------------+
141+
| UID | SOP Class |
142+
+==================+========================+
143+
|1.2.840.10008.1.1 | Verification SOP Class |
144+
+------------------+------------------------+
145+
146+
Transfer Syntaxes
147+
.................
148+
149+
+------------------------+----------------------------------------------------+
150+
| UID | Transfer Syntax |
151+
+========================+====================================================+
152+
| 1.2.840.10008.1.2 | Implicit VR Little Endian |
153+
+------------------------+----------------------------------------------------+
154+
| 1.2.840.10008.1.2.1 | Explicit VR Little Endian |
155+
+------------------------+----------------------------------------------------+
156+
| 1.2.840.10008.1.2.1.99 | Deflated Explicit VR Little Endian |
157+
+------------------------+----------------------------------------------------+
158+
| 1.2.840.10008.1.2.2 | Explicit VR Big Endian |
159+
+------------------------+----------------------------------------------------+

0 commit comments

Comments
 (0)