Updating the docs in dev/ for branch: main, commit c22be4b [skip ci]

pydicom · Dec 22, 2024 · 8dd6626 · 8dd6626
1 parent 6ec9ba1
commit 8dd6626
Show file tree

Hide file tree

Showing 456 changed files with 874 additions and 726 deletions.
diff --git a/dev/_sources/changelog/v3.0.0.rst.txt b/dev/_sources/changelog/v3.0.0.rst.txt
@@ -0,0 +1,10 @@
+.. _v3.0.0:
+
+3.0.0
+=====
+
+The major breaking changes with the version 3.0 release are:
+
+  * Support for pydicom v3
+  * Changed ``StoragePresentationContexts`` to match DCMTK implementation
+     * Some presentation contexts were replaced
diff --git a/dev/_sources/examples/storage.rst.txt b/dev/_sources/examples/storage.rst.txt
@@ -57,7 +57,7 @@ single CT dataset.
 Of course it's rarely the case that someone wants to store just CT images,
 so you can also use the inbuilt
 :attr:`~pynetdicom.presentation.StoragePresentationContexts` which contains
-presentation contexts for the first 128 storage SOP Classes when setting
+presentation contexts for the first 120 storage SOP Classes when setting
 the requested contexts, or just add as many contexts as you need.
 
 .. code-block:: python

diff --git a/dev/_sources/user/ae.rst.txt b/dev/_sources/user/ae.rst.txt
@@ -88,8 +88,8 @@ Adding presentation contexts all at once:
     >>> ae.requested_contexts = StoragePresentationContexts
 
 Here :attr:`~pynetdicom.presentation.StoragePresentationContexts` is a
-prebuilt list of presentation contexts containing (almost) all the Storage
-Service Class' :dcm:`supported SOP Classes <part04/sect_B.5.html>`,
+prebuilt list of presentation contexts containing 120 of the most commonly used Storage
+Service Classes' :dcm:`supported SOP Classes <part04/sect_B.5.html>`,
 and there's a :ref:`similar list<api_presentation_prebuilt>` for all
 the supported service classes.
 Alternatively you can build your own list of presentation contexts, either
@@ -115,12 +115,13 @@ Combining the all-at-once and one-by-one approaches:
     >>> from pynetdicom import AE, StoragePresentationContexts
     >>> from pynetdicom.sop_class import Verification
     >>> ae = AE()
-    >>> ae.requested_contexts = StoragePresentationContexts[:127]
+    >>> ae.requested_contexts = StoragePresentationContexts
     >>> ae.add_requested_context(Verification)
 
 As the association *Requestor* you're limited to a total of 128 requested
 presentation contexts, so attempting to add more than 128 contexts will raise
-a :class:`ValueError` exception.
+a :class:`ValueError` exception.  :attr:`~pynetdicom.presentation.StoragePresentationContexts` consists of 120 of most commonly used Storage
+Service Classes, therefore you are able to add 8 additional presentation contexts without rasing a :class:`ValueError` exception.
 
 When you add presentation contexts as shown above, the following transfer
 syntaxes are used by default for each context:
@@ -285,8 +286,8 @@ Adding presentation contexts all at once:
     >>> ae.supported_contexts = StoragePresentationContexts
 
 Here :attr:`~pynetdicom.presentation.StoragePresentationContexts` is a prebuilt
-:class:`list` of presentation contexts containing (almost) all the Storage
-Service Class' :dcm:`supported SOP Classes<part04/sect_B.5.html>`,
+:class:`list` of presentation contexts containing 120 of the most commonly used Storage
+Service Classes' :dcm:`supported SOP Classes<part04/sect_B.5.html>`,
 and there's a :ref:`similar list<api_presentation_prebuilt>` for
 all the supported service classes. Alternatively you can build your own list
 of presentation contexts, either through creating new

diff --git a/dev/_sources/user/association.rst.txt b/dev/_sources/user/association.rst.txt
@@ -95,15 +95,16 @@ also acting as a Storage SCP), plus a *User Identity Negotiation* item:
 
     ae = AE()
     # Contexts supported as a Storage SCP - requires Role Selection
-    #   Note that we are limited to a maximum of 128 contexts so we
-    #   only include 127 to make room for the QR Get context
-    ae.requested_contexts = StoragePresentationContexts[:127]
+    #   Note that we are limited to a maximum of 128 contexts.
+    #   StoragePresentationContexts includes 120, it is therefore 
+    #   possible to add 8 additional presentation contexts if needed.
+    ae.requested_contexts = StoragePresentationContexts
     # Contexts proposed as a QR SCU
     ae.add_requested_context = PatientRootQueryRetrieveInformationModelGet
 
     # Add role selection items for the contexts we will be supporting as an SCP
     negotiation_items = []
-    for context in StoragePresentationContexts[:127]:
+    for context in StoragePresentationContexts:
         role = build_role(context.abstract_syntax, scp_role=True)
         negotiation_items.append(role)
 

diff --git a/dev/changelog/v3.0.0.html b/dev/changelog/v3.0.0.html
@@ -0,0 +1,134 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>3.0.0 &mdash; pynetdicom 2.1.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/pynetdicom.css?v=b0f7bde4" />
+      <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/pynetdicom.css?v=b0f7bde4" />
+
+
+    <link rel="shortcut icon" href="../_static/favicon.ico"/>
+      <script src="../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../_static/documentation_options.js?v=20623aea"></script>
+      <script src="../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+      <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
+      <script src="../_static/copybutton.js?v=ccdb6887"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            pynetdicom
+              <img src="../_static/pydicom_flat_black.svg" class="logo" alt="Logo"/>
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../service_classes/index.html">Supported Service Classes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">API Reference</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../examples/index.html">Code Examples</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Additional Information</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../apps/index.html">Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="index.html">Release Notes</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">pynetdicom</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">3.0.0</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="v3-0-0">
+<span id="id1"></span><h1>3.0.0<a class="headerlink" href="#v3-0-0" title="Link to this heading">¶</a></h1>
+<p>The major breaking changes with the version 3.0 release are:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>Support for pydicom v3</p></li>
+<li><dl class="simple">
+<dt>Changed <code class="docutils literal notranslate"><span class="pre">StoragePresentationContexts</span></code> to match DCMTK implementation</dt><dd><ul>
+<li><p>Some presentation contexts were replaced</p></li>
+</ul>
+</dd>
+</dl>
+</li>
+</ul>
+</div></blockquote>
+</section>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2018-2024, pynetdicom contributors.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/dev/examples/storage.html b/dev/examples/storage.html
@@ -158,7 +158,7 @@ <h2>Storage SCU<a class="headerlink" href="#storage-scu" title="Link to this hea
 <p>Of course it’s rarely the case that someone wants to store just CT images,
 so you can also use the inbuilt
 <a class="reference internal" href="../reference/generated/pynetdicom.presentation.StoragePresentationContexts.html#pynetdicom.presentation.StoragePresentationContexts" title="pynetdicom.presentation.StoragePresentationContexts"><code class="xref py py-attr docutils literal notranslate"><span class="pre">StoragePresentationContexts</span></code></a> which contains
-presentation contexts for the first 128 storage SOP Classes when setting
+presentation contexts for the first 120 storage SOP Classes when setting
 the requested contexts, or just add as many contexts as you need.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pynetdicom</span> <span class="kn">import</span> <span class="n">AE</span><span class="p">,</span> <span class="n">StoragePresentationContexts</span>
 

diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/reference/generated/pynetdicom.PYNETDICOM_IMPLEMENTATION_UID.html b/dev/reference/generated/pynetdicom.PYNETDICOM_IMPLEMENTATION_UID.html
@@ -123,7 +123,7 @@
 <h1>pynetdicom.PYNETDICOM_IMPLEMENTATION_UID<a class="headerlink" href="#pynetdicom-pynetdicom-implementation-uid" title="Link to this heading">¶</a></h1>
 <dl class="py data">
 <dt class="sig sig-object py" id="pynetdicom.PYNETDICOM_IMPLEMENTATION_UID">
-<span class="sig-prename descclassname"><span class="pre">pynetdicom.</span></span><span class="sig-name descname"><span class="pre">PYNETDICOM_IMPLEMENTATION_UID</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://pydicom.github.io/pydicom/stable/reference/generated/pydicom.uid.UID.html#pydicom.uid.UID" title="(in pydicom v3.0.1)"><span class="pre">UID</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'1.2.826.0.1.3680043.9.3811.2.1.0'</span></em><a class="reference external" href="https://github.com/pydicom/pynetdicom/blob/503a75f8f/pynetdicom/../venv/lib/python3.10/site-packages/pydicom/uid.py#L"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynetdicom.PYNETDICOM_IMPLEMENTATION_UID" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pynetdicom.</span></span><span class="sig-name descname"><span class="pre">PYNETDICOM_IMPLEMENTATION_UID</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://pydicom.github.io/pydicom/stable/reference/generated/pydicom.uid.UID.html#pydicom.uid.UID" title="(in pydicom v3.0.1)"><span class="pre">UID</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'1.2.826.0.1.3680043.9.3811.2.1.0'</span></em><a class="reference external" href="https://github.com/pydicom/pynetdicom/blob/c22be4b79/pynetdicom/../venv/lib/python3.10/site-packages/pydicom/uid.py#L"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynetdicom.PYNETDICOM_IMPLEMENTATION_UID" title="Link to this definition">¶</a></dt>
 <dd><p>The (0002,0012) <em>Implementation Class UID</em> used by <em>pynetdicom</em></p>
 </dd></dl>
 

diff --git a/dev/reference/generated/pynetdicom._handlers.doc_handle_acse.html b/dev/reference/generated/pynetdicom._handlers.doc_handle_acse.html
@@ -130,7 +130,7 @@
 <h1>pynetdicom._handlers.doc_handle_acse<a class="headerlink" href="#pynetdicom-handlers-doc-handle-acse" title="Link to this heading">¶</a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="pynetdicom._handlers.doc_handle_acse">
-<span class="sig-prename descclassname"><span class="pre">pynetdicom._handlers.</span></span><span class="sig-name descname"><span class="pre">doc_handle_acse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pynetdicom.events.Event.html#pynetdicom.events.Event" title="pynetdicom.events.Event"><span class="pre">Event</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference external" href="https://github.com/pydicom/pynetdicom/blob/503a75f8f/pynetdicom/_handlers.py#L4037"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynetdicom._handlers.doc_handle_acse" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pynetdicom._handlers.</span></span><span class="sig-name descname"><span class="pre">doc_handle_acse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pynetdicom.events.Event.html#pynetdicom.events.Event" title="pynetdicom.events.Event"><span class="pre">Event</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference external" href="https://github.com/pydicom/pynetdicom/blob/c22be4b79/pynetdicom/_handlers.py#L4037"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pynetdicom._handlers.doc_handle_acse" title="Link to this definition">¶</a></dt>
 <dd><p>Documentation for handlers bound to <code class="docutils literal notranslate"><span class="pre">evt.EVT_ACSE_RECV</span></code> or
 <code class="docutils literal notranslate"><span class="pre">evt.EVT_ACSE_SENT</span></code>.</p>
 <dl class="field-list simple">