Skip to content

Commit 4f62a09

Browse files
author
mantid-builder
committed
Update documentation
1 parent fc0a8f2 commit 4f62a09

File tree

6 files changed

+118
-164
lines changed

6 files changed

+118
-164
lines changed

_modules/mantidimaging/core/data/dataset.html

Lines changed: 56 additions & 72 deletions
Large diffs are not rendered by default.

api/mantidimaging.core.data.dataset.html

Lines changed: 48 additions & 66 deletions
Large diffs are not rendered by default.

api/mantidimaging.core.data.html

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -523,22 +523,18 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
523523
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.delete_recons"><code class="docutils literal notranslate"><span class="pre">BaseDataset.delete_recons()</span></code></a></li>
524524
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.delete_stack"><code class="docutils literal notranslate"><span class="pre">BaseDataset.delete_stack()</span></code></a></li>
525525
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.id"><code class="docutils literal notranslate"><span class="pre">BaseDataset.id</span></code></a></li>
526+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.image_keys"><code class="docutils literal notranslate"><span class="pre">BaseDataset.image_keys</span></code></a></li>
527+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.is_processed"><code class="docutils literal notranslate"><span class="pre">BaseDataset.is_processed</span></code></a></li>
528+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.nexus_arrays"><code class="docutils literal notranslate"><span class="pre">BaseDataset.nexus_arrays</span></code></a></li>
529+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.nexus_rotation_angles"><code class="docutils literal notranslate"><span class="pre">BaseDataset.nexus_rotation_angles</span></code></a></li>
530+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.proj180deg"><code class="docutils literal notranslate"><span class="pre">BaseDataset.proj180deg</span></code></a></li>
526531
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.recons"><code class="docutils literal notranslate"><span class="pre">BaseDataset.recons</span></code></a></li>
532+
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.set_stack"><code class="docutils literal notranslate"><span class="pre">BaseDataset.set_stack()</span></code></a></li>
527533
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.sinograms"><code class="docutils literal notranslate"><span class="pre">BaseDataset.sinograms</span></code></a></li>
528534
</ul>
529535
</li>
530536
<li class="toctree-l2"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.MixedDataset"><code class="docutils literal notranslate"><span class="pre">MixedDataset</span></code></a></li>
531-
<li class="toctree-l2"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset"><code class="docutils literal notranslate"><span class="pre">StrictDataset</span></code></a><ul>
532-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.all"><code class="docutils literal notranslate"><span class="pre">StrictDataset.all</span></code></a></li>
533-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.delete_stack"><code class="docutils literal notranslate"><span class="pre">StrictDataset.delete_stack()</span></code></a></li>
534-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.image_keys"><code class="docutils literal notranslate"><span class="pre">StrictDataset.image_keys</span></code></a></li>
535-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.is_processed"><code class="docutils literal notranslate"><span class="pre">StrictDataset.is_processed</span></code></a></li>
536-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.nexus_arrays"><code class="docutils literal notranslate"><span class="pre">StrictDataset.nexus_arrays</span></code></a></li>
537-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.nexus_rotation_angles"><code class="docutils literal notranslate"><span class="pre">StrictDataset.nexus_rotation_angles</span></code></a></li>
538-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.proj180deg"><code class="docutils literal notranslate"><span class="pre">StrictDataset.proj180deg</span></code></a></li>
539-
<li class="toctree-l3"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.set_stack"><code class="docutils literal notranslate"><span class="pre">StrictDataset.set_stack()</span></code></a></li>
540-
</ul>
541-
</li>
537+
<li class="toctree-l2"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset"><code class="docutils literal notranslate"><span class="pre">StrictDataset</span></code></a></li>
542538
<li class="toctree-l2"><a class="reference internal" href="mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.remove_nones"><code class="docutils literal notranslate"><span class="pre">remove_nones()</span></code></a></li>
543539
</ul>
544540
</li>

genindex.html

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -661,11 +661,7 @@ <h2 id="A">A</h2>
661661
<li><a href="api/mantidimaging.gui.windows.recon.view.html#mantidimaging.gui.windows.recon.view.ReconstructWindowView.algorithmName">algorithmName (mantidimaging.gui.windows.recon.view.ReconstructWindowView attribute)</a>
662662
</li>
663663
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.all">all (mantidimaging.core.data.dataset.BaseDataset property)</a>
664-
665-
<ul>
666-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.all">(mantidimaging.core.data.dataset.StrictDataset property)</a>
667664
</li>
668-
</ul></li>
669665
<li><a href="api/mantidimaging.gui.windows.main.presenter.html#mantidimaging.gui.windows.main.presenter.MainWindowPresenter.all_dataset_ids">all_dataset_ids (mantidimaging.gui.windows.main.presenter.MainWindowPresenter property)</a>
670666
</li>
671667
<li><a href="api/mantidimaging.core.io.filenames.html#mantidimaging.core.io.filenames.FilenameGroup.all_files">all_files() (mantidimaging.core.io.filenames.FilenameGroup method)</a>
@@ -1371,11 +1367,7 @@ <h2 id="D">D</h2>
13711367
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.delete_recons">delete_recons() (mantidimaging.core.data.dataset.BaseDataset method)</a>
13721368
</li>
13731369
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.delete_stack">delete_stack() (mantidimaging.core.data.dataset.BaseDataset method)</a>
1374-
1375-
<ul>
1376-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.delete_stack">(mantidimaging.core.data.dataset.StrictDataset method)</a>
13771370
</li>
1378-
</ul></li>
13791371
<li><a href="api/mantidimaging.core.io.instrument_log_implmentations.html#mantidimaging.core.io.instrument_log_implmentations.LegacyShutterCountLogParser.delimiter">delimiter (mantidimaging.core.io.instrument_log_implmentations.LegacyShutterCountLogParser attribute)</a>
13801372

13811373
<ul>
@@ -2436,7 +2428,7 @@ <h2 id="I">I</h2>
24362428
<li><a href="api/mantidimaging.gui.widgets.mi_mini_image_view.view.html#mantidimaging.gui.widgets.mi_mini_image_view.view.MIMiniImageView.image_item">(mantidimaging.gui.widgets.mi_mini_image_view.view.MIMiniImageView property)</a>
24372429
</li>
24382430
</ul></li>
2439-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.image_keys">image_keys (mantidimaging.core.data.dataset.StrictDataset property)</a>
2431+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.image_keys">image_keys (mantidimaging.core.data.dataset.BaseDataset property)</a>
24402432
</li>
24412433
<li><a href="api/mantidimaging.gui.windows.main.view.html#mantidimaging.gui.windows.main.view.MainWindowView.image_load_dialog">image_load_dialog (mantidimaging.gui.windows.main.view.MainWindowView attribute)</a>
24422434
</li>
@@ -2580,7 +2572,7 @@ <h2 id="I">I</h2>
25802572
</ul></li>
25812573
<li><a href="api/mantidimaging.core.utility.version_check.html#mantidimaging.core.utility.version_check.CheckVersion.is_prerelease">is_prerelease() (mantidimaging.core.utility.version_check.CheckVersion method)</a>
25822574
</li>
2583-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.is_processed">is_processed (mantidimaging.core.data.dataset.StrictDataset property)</a>
2575+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.is_processed">is_processed (mantidimaging.core.data.dataset.BaseDataset property)</a>
25842576

25852577
<ul>
25862578
<li><a href="api/mantidimaging.core.data.imagestack.html#mantidimaging.core.data.imagestack.ImageStack.is_processed">(mantidimaging.core.data.imagestack.ImageStack property)</a>
@@ -5065,15 +5057,15 @@ <h2 id="N">N</h2>
50655057
</li>
50665058
<li><a href="api/mantidimaging.gui.windows.stack_choice.view.html#mantidimaging.gui.windows.stack_choice.view.StackChoiceView.newDataButton">newDataButton (mantidimaging.gui.windows.stack_choice.view.StackChoiceView attribute)</a>
50675059
</li>
5068-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.nexus_arrays">nexus_arrays (mantidimaging.core.data.dataset.StrictDataset property)</a>
5060+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.nexus_arrays">nexus_arrays (mantidimaging.core.data.dataset.BaseDataset property)</a>
50695061
</li>
50705062
<li><a href="api/mantidimaging.gui.windows.nexus_load_dialog.presenter.html#mantidimaging.gui.windows.nexus_load_dialog.presenter.Notification.NEXUS_FILE_SELECTED">NEXUS_FILE_SELECTED (mantidimaging.gui.windows.nexus_load_dialog.presenter.Notification attribute)</a>
50715063
</li>
50725064
<li><a href="api/mantidimaging.gui.windows.main.presenter.html#mantidimaging.gui.windows.main.presenter.Notification.NEXUS_LOAD">NEXUS_LOAD (mantidimaging.gui.windows.main.presenter.Notification attribute)</a>
50735065
</li>
50745066
<li><a href="api/mantidimaging.gui.windows.main.view.html#mantidimaging.gui.windows.main.view.MainWindowView.nexus_load_dialog">nexus_load_dialog (mantidimaging.gui.windows.main.view.MainWindowView attribute)</a>
50755067
</li>
5076-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.nexus_rotation_angles">nexus_rotation_angles (mantidimaging.core.data.dataset.StrictDataset property)</a>
5068+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.nexus_rotation_angles">nexus_rotation_angles (mantidimaging.core.data.dataset.BaseDataset property)</a>
50775069
</li>
50785070
<li><a href="api/mantidimaging.gui.windows.main.presenter.html#mantidimaging.gui.windows.main.presenter.Notification.NEXUS_SAVE">NEXUS_SAVE (mantidimaging.gui.windows.main.presenter.Notification attribute)</a>
50795071
</li>
@@ -5505,7 +5497,7 @@ <h2 id="P">P</h2>
55055497
</li>
55065498
<li><a href="api/mantidimaging.core.utility.progress_reporting.progress.html#mantidimaging.core.utility.progress_reporting.progress.ProgressHistory">ProgressHistory (class in mantidimaging.core.utility.progress_reporting.progress)</a>
55075499
</li>
5508-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.proj180deg">proj180deg (mantidimaging.core.data.dataset.StrictDataset property)</a>
5500+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.proj180deg">proj180deg (mantidimaging.core.data.dataset.BaseDataset property)</a>
55095501

55105502
<ul>
55115503
<li><a href="api/mantidimaging.core.data.imagestack.html#mantidimaging.core.data.imagestack.ImageStack.proj180deg">(mantidimaging.core.data.imagestack.ImageStack property)</a>
@@ -6191,7 +6183,7 @@ <h2 id="S">S</h2>
61916183
</li>
61926184
<li><a href="api/mantidimaging.gui.windows.spectrum_viewer.view.html#mantidimaging.gui.windows.spectrum_viewer.view.SpectrumViewerWindowView.set_spectum_roi_color">set_spectum_roi_color() (mantidimaging.gui.windows.spectrum_viewer.view.SpectrumViewerWindowView method)</a>
61936185
</li>
6194-
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.StrictDataset.set_stack">set_stack() (mantidimaging.core.data.dataset.StrictDataset method)</a>
6186+
<li><a href="api/mantidimaging.core.data.dataset.html#mantidimaging.core.data.dataset.BaseDataset.set_stack">set_stack() (mantidimaging.core.data.dataset.BaseDataset method)</a>
61956187

61966188
<ul>
61976189
<li><a href="api/mantidimaging.gui.windows.operations.presenter.html#mantidimaging.gui.windows.operations.presenter.FiltersWindowPresenter.set_stack">(mantidimaging.gui.windows.operations.presenter.FiltersWindowPresenter method)</a>

objects.inv

-10 Bytes
Binary file not shown.

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)