Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 25, 2024
1 parent 01b963d commit c3cf61b
Show file tree
Hide file tree
Showing 115 changed files with 1,190 additions and 1,139 deletions.
2 changes: 1 addition & 1 deletion assets/css/atom.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/css/rss.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/css/styles_feeling_responsive.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion nightly/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f74772cbaa6b3cc3e8c0d180d3358651
config: e3ec9a94ff7555bc4642f5eac12b7e47
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
Binary file modified nightly/.doctrees/demos/00_CIL_geometry.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/environment.pickle
View file
Binary file not shown.
114 changes: 57 additions & 57 deletions nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"execution_count": 1,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:22.088145Z",
"iopub.status.busy": "2024-09-18T14:36:22.087912Z",
"iopub.status.idle": "2024-09-18T14:36:22.091032Z",
"shell.execute_reply": "2024-09-18T14:36:22.090649Z"
"iopub.execute_input": "2024-09-25T11:49:42.135111Z",
"iopub.status.busy": "2024-09-25T11:49:42.134918Z",
"iopub.status.idle": "2024-09-25T11:49:42.137851Z",
"shell.execute_reply": "2024-09-25T11:49:42.137486Z"
}
},
"outputs": [],
Expand Down Expand Up @@ -142,10 +142,10 @@
"execution_count": 2,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:22.092879Z",
"iopub.status.busy": "2024-09-18T14:36:22.092518Z",
"iopub.status.idle": "2024-09-18T14:36:22.924606Z",
"shell.execute_reply": "2024-09-18T14:36:22.924006Z"
"iopub.execute_input": "2024-09-25T11:49:42.139549Z",
"iopub.status.busy": "2024-09-25T11:49:42.139241Z",
"iopub.status.idle": "2024-09-25T11:49:43.705701Z",
"shell.execute_reply": "2024-09-25T11:49:43.705195Z"
}
},
"outputs": [
Expand Down Expand Up @@ -209,10 +209,10 @@
"execution_count": 3,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:22.953806Z",
"iopub.status.busy": "2024-09-18T14:36:22.953341Z",
"iopub.status.idle": "2024-09-18T14:36:23.194056Z",
"shell.execute_reply": "2024-09-18T14:36:23.193497Z"
"iopub.execute_input": "2024-09-25T11:49:43.735363Z",
"iopub.status.busy": "2024-09-25T11:49:43.734787Z",
"iopub.status.idle": "2024-09-25T11:49:43.966471Z",
"shell.execute_reply": "2024-09-25T11:49:43.965892Z"
}
},
"outputs": [
Expand All @@ -229,7 +229,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed5c7a7e60>"
"<cil.utilities.display.show_geometry at 0x7f82cc56e9f0>"
]
},
"execution_count": 3,
Expand Down Expand Up @@ -271,10 +271,10 @@
"execution_count": 4,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:23.195876Z",
"iopub.status.busy": "2024-09-18T14:36:23.195471Z",
"iopub.status.idle": "2024-09-18T14:36:23.401668Z",
"shell.execute_reply": "2024-09-18T14:36:23.401188Z"
"iopub.execute_input": "2024-09-25T11:49:43.968222Z",
"iopub.status.busy": "2024-09-25T11:49:43.967787Z",
"iopub.status.idle": "2024-09-25T11:49:44.166781Z",
"shell.execute_reply": "2024-09-25T11:49:44.166317Z"
}
},
"outputs": [
Expand All @@ -291,7 +291,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed5c263f80>"
"<cil.utilities.display.show_geometry at 0x7f82cc3116a0>"
]
},
"execution_count": 4,
Expand Down Expand Up @@ -333,10 +333,10 @@
"execution_count": 5,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:23.403236Z",
"iopub.status.busy": "2024-09-18T14:36:23.403069Z",
"iopub.status.idle": "2024-09-18T14:36:23.628435Z",
"shell.execute_reply": "2024-09-18T14:36:23.627872Z"
"iopub.execute_input": "2024-09-25T11:49:44.168495Z",
"iopub.status.busy": "2024-09-25T11:49:44.168176Z",
"iopub.status.idle": "2024-09-25T11:49:44.404237Z",
"shell.execute_reply": "2024-09-25T11:49:44.403620Z"
}
},
"outputs": [
Expand All @@ -353,7 +353,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed5c2954f0>"
"<cil.utilities.display.show_geometry at 0x7f82cc22c0e0>"
]
},
"execution_count": 5,
Expand Down Expand Up @@ -394,10 +394,10 @@
"execution_count": 6,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:23.630217Z",
"iopub.status.busy": "2024-09-18T14:36:23.630024Z",
"iopub.status.idle": "2024-09-18T14:36:23.831547Z",
"shell.execute_reply": "2024-09-18T14:36:23.831082Z"
"iopub.execute_input": "2024-09-25T11:49:44.406236Z",
"iopub.status.busy": "2024-09-25T11:49:44.405718Z",
"iopub.status.idle": "2024-09-25T11:49:44.604486Z",
"shell.execute_reply": "2024-09-25T11:49:44.603985Z"
}
},
"outputs": [
Expand All @@ -414,7 +414,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed5c1780b0>"
"<cil.utilities.display.show_geometry at 0x7f82cc547f50>"
]
},
"execution_count": 6,
Expand Down Expand Up @@ -447,10 +447,10 @@
"execution_count": 7,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:23.833349Z",
"iopub.status.busy": "2024-09-18T14:36:23.832998Z",
"iopub.status.idle": "2024-09-18T14:36:24.096082Z",
"shell.execute_reply": "2024-09-18T14:36:24.095538Z"
"iopub.execute_input": "2024-09-25T11:49:44.606116Z",
"iopub.status.busy": "2024-09-25T11:49:44.605918Z",
"iopub.status.idle": "2024-09-25T11:49:44.838720Z",
"shell.execute_reply": "2024-09-25T11:49:44.838225Z"
}
},
"outputs": [
Expand All @@ -467,7 +467,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed3cbb1730>"
"<cil.utilities.display.show_geometry at 0x7f82cc10dc10>"
]
},
"execution_count": 7,
Expand Down Expand Up @@ -499,10 +499,10 @@
"execution_count": 8,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:24.097952Z",
"iopub.status.busy": "2024-09-18T14:36:24.097598Z",
"iopub.status.idle": "2024-09-18T14:36:24.325179Z",
"shell.execute_reply": "2024-09-18T14:36:24.324599Z"
"iopub.execute_input": "2024-09-25T11:49:44.840489Z",
"iopub.status.busy": "2024-09-25T11:49:44.840162Z",
"iopub.status.idle": "2024-09-25T11:49:45.060983Z",
"shell.execute_reply": "2024-09-25T11:49:45.060421Z"
}
},
"outputs": [
Expand All @@ -519,7 +519,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed3ca47890>"
"<cil.utilities.display.show_geometry at 0x7f82cc276d20>"
]
},
"execution_count": 8,
Expand Down Expand Up @@ -549,10 +549,10 @@
"execution_count": 9,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:24.326875Z",
"iopub.status.busy": "2024-09-18T14:36:24.326560Z",
"iopub.status.idle": "2024-09-18T14:36:24.562377Z",
"shell.execute_reply": "2024-09-18T14:36:24.561837Z"
"iopub.execute_input": "2024-09-25T11:49:45.062484Z",
"iopub.status.busy": "2024-09-25T11:49:45.062317Z",
"iopub.status.idle": "2024-09-25T11:49:45.279933Z",
"shell.execute_reply": "2024-09-25T11:49:45.279465Z"
}
},
"outputs": [
Expand All @@ -569,7 +569,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed3cb5bf80>"
"<cil.utilities.display.show_geometry at 0x7f82cc09e030>"
]
},
"execution_count": 9,
Expand Down Expand Up @@ -638,10 +638,10 @@
"execution_count": 10,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:24.564029Z",
"iopub.status.busy": "2024-09-18T14:36:24.563853Z",
"iopub.status.idle": "2024-09-18T14:36:24.568749Z",
"shell.execute_reply": "2024-09-18T14:36:24.568318Z"
"iopub.execute_input": "2024-09-25T11:49:45.281694Z",
"iopub.status.busy": "2024-09-25T11:49:45.281363Z",
"iopub.status.idle": "2024-09-25T11:49:45.286437Z",
"shell.execute_reply": "2024-09-25T11:49:45.285951Z"
}
},
"outputs": [
Expand Down Expand Up @@ -711,10 +711,10 @@
"execution_count": 11,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:24.570276Z",
"iopub.status.busy": "2024-09-18T14:36:24.570109Z",
"iopub.status.idle": "2024-09-18T14:36:25.245901Z",
"shell.execute_reply": "2024-09-18T14:36:25.245421Z"
"iopub.execute_input": "2024-09-25T11:49:45.288035Z",
"iopub.status.busy": "2024-09-25T11:49:45.287847Z",
"iopub.status.idle": "2024-09-25T11:49:45.956252Z",
"shell.execute_reply": "2024-09-25T11:49:45.955765Z"
}
},
"outputs": [
Expand Down Expand Up @@ -772,7 +772,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7fed3ca794f0>"
"<cil.utilities.display.show_geometry at 0x7f82c3eb1a90>"
]
},
"execution_count": 11,
Expand Down Expand Up @@ -815,10 +815,10 @@
"execution_count": 12,
"metadata": {
"execution": {
"iopub.execute_input": "2024-09-18T14:36:25.247666Z",
"iopub.status.busy": "2024-09-18T14:36:25.247312Z",
"iopub.status.idle": "2024-09-18T14:36:25.249970Z",
"shell.execute_reply": "2024-09-18T14:36:25.249573Z"
"iopub.execute_input": "2024-09-25T11:49:45.957841Z",
"iopub.status.busy": "2024-09-25T11:49:45.957680Z",
"iopub.status.idle": "2024-09-25T11:49:45.960312Z",
"shell.execute_reply": "2024-09-25T11:49:45.959914Z"
}
},
"outputs": [],
Expand All @@ -845,7 +845,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.5"
"version": "3.12.6"
},
"vscode": {
"interpreter": {
Expand Down
45 changes: 35 additions & 10 deletions nightly/_modules/cil/framework/acquisition_data/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cil.framework.acquisition_data &#8212; CIL 24.1.1.dev111+ga181c35d documentation</title>
<title>cil.framework.acquisition_data &#8212; CIL 24.1.1.dev112+g0d6b067e documentation</title>



Expand All @@ -26,18 +26,18 @@
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="../../../../_static/styles/theme.css?digest=b3e6caa8caadad3c1dbb" rel="stylesheet" />
<link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=b3e6caa8caadad3c1dbb" rel="stylesheet" />
<link href="../../../../_static/styles/theme.css?digest=40aaa67283c71ff6e56f" rel="stylesheet" />
<link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=40aaa67283c71ff6e56f" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../../../_static/sg_gallery.css?v=d2d258e8" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=b3e6caa8caadad3c1dbb" />
<link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=b3e6caa8caadad3c1dbb" />
<link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=40aaa67283c71ff6e56f" />
<link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=40aaa67283c71ff6e56f" />

<script src="../../../../_static/documentation_options.js?v=40b8a3c2"></script>
<script src="../../../../_static/documentation_options.js?v=56c13d8c"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -47,7 +47,7 @@
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.15.4dev0';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/CIL/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev111+ga181c35d';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev112+g0d6b067e';
DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
</script>
<link rel="index" title="Index" href="../../../../genindex/" />
Expand Down Expand Up @@ -537,6 +537,31 @@ <h1>Source code for cil.framework.acquisition_data</h1><div class="highlight"><p

<span class="nb">super</span><span class="p">(</span><span class="n">AcquisitionData</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">deep_copy</span><span class="p">,</span> <span class="n">geometry</span><span class="o">=</span><span class="n">geometry</span><span class="p">,</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>

<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Check if two AcquisitionData objects are equal. This is done by checking if the geometry, data and dtype are equal.</span>
<span class="sd"> Also, if the other object is a numpy.ndarray, it will check if the data and dtype are equal.</span>
<span class="sd"> </span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> other: AcquisitionData or numpy.ndarray</span>
<span class="sd"> The object to compare with.</span>
<span class="sd"> </span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> bool</span>
<span class="sd"> True if the two objects are equal, False otherwise.</span>
<span class="sd"> &#39;&#39;&#39;</span>

<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">AcquisitionData</span><span class="p">):</span>
<span class="k">if</span> <span class="n">numpy</span><span class="o">.</span><span class="n">array_equal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">as_array</span><span class="p">(),</span> <span class="n">other</span><span class="o">.</span><span class="n">as_array</span><span class="p">())</span> \
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">geometry</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">geometry</span> \
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">dtype</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">elif</span> <span class="n">numpy</span><span class="o">.</span><span class="n">array_equal</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">as_array</span><span class="p">(),</span> <span class="n">other</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">dtype</span><span class="o">==</span><span class="n">other</span><span class="o">.</span><span class="n">dtype</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>

<div class="viewcode-block" id="AcquisitionData.get_slice">
<a class="viewcode-back" href="../../../../framework/#cil.framework.AcquisitionData.get_slice">[docs]</a>
Expand Down Expand Up @@ -618,9 +643,9 @@ <h1>Source code for cil.framework.acquisition_data</h1><div class="highlight"><p
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../../../_static/scripts/fontawesome.js?digest=b3e6caa8caadad3c1dbb"></script>
<script defer src="../../../../_static/scripts/bootstrap.js?digest=b3e6caa8caadad3c1dbb"></script>
<script defer src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=b3e6caa8caadad3c1dbb"></script>
<script defer src="../../../../_static/scripts/fontawesome.js?digest=40aaa67283c71ff6e56f"></script>
<script defer src="../../../../_static/scripts/bootstrap.js?digest=40aaa67283c71ff6e56f"></script>
<script defer src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=40aaa67283c71ff6e56f"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down
Loading

0 comments on commit c3cf61b

Please sign in to comment.