Skip to content

Commit 646eee9

Browse files
author
mantid-builder
committed
Update documentation
1 parent ad11c7c commit 646eee9

File tree

9 files changed

+53
-13
lines changed

9 files changed

+53
-13
lines changed

_modules/mantidimaging/core/data/geometry.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,6 @@ <h1>Source code for mantidimaging.core.data.geometry</h1><div class="highlight">
498498
<span class="kn">from</span><span class="w"> </span><span class="nn">math</span><span class="w"> </span><span class="kn">import</span> <span class="n">tan</span><span class="p">,</span> <span class="n">radians</span><span class="p">,</span> <span class="n">degrees</span>
499499

500500
<span class="kn">from</span><span class="w"> </span><span class="nn">cil.framework</span><span class="w"> </span><span class="kn">import</span> <span class="n">AcquisitionGeometry</span>
501-
502501
<span class="kn">from</span><span class="w"> </span><span class="nn">mantidimaging.core.utility.data_containers</span><span class="w"> </span><span class="kn">import</span> <span class="n">ScalarCoR</span>
503502

504503

_modules/mantidimaging/core/data/imagestack.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -914,8 +914,10 @@ <h1>Source code for mantidimaging.core.data.imagestack</h1><div class="highlight
914914
<span class="sd"> &quot;&quot;&quot;</span>
915915
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_projection_angles</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
916916
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_projection_angles</span>
917+
917918
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_log_file</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_log_file</span><span class="o">.</span><span class="n">has_projection_angles</span><span class="p">():</span>
918919
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_log_file</span><span class="o">.</span><span class="n">projection_angles</span><span class="p">()</span>
920+
919921
<span class="k">return</span> <span class="kc">None</span></div>
920922

921923

_modules/mantidimaging/gui/windows/main/presenter.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,13 @@ <h1>Source code for mantidimaging.gui.windows.main.presenter</h1><div class="hig
634634
<div class="viewcode-block" id="MainWindowPresenter.add_log_to_sample">
635635
<a class="viewcode-back" href="../../../../../api/mantidimaging.gui.windows.main.presenter.html#mantidimaging.gui.windows.main.presenter.MainWindowPresenter.add_log_to_sample">[docs]</a>
636636
<span class="k">def</span><span class="w"> </span><span class="nf">add_log_to_sample</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stack_id</span><span class="p">:</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">,</span> <span class="n">log_file</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
637-
<span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">add_log_to_sample</span><span class="p">(</span><span class="n">stack_id</span><span class="p">,</span> <span class="n">log_file</span><span class="p">)</span></div>
637+
<span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">add_log_to_sample</span><span class="p">(</span><span class="n">stack_id</span><span class="p">,</span> <span class="n">log_file</span><span class="p">)</span>
638+
639+
<span class="n">image_stack</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_stack</span><span class="p">(</span><span class="n">stack_id</span><span class="p">)</span>
640+
<span class="k">if</span> <span class="n">image_stack</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
641+
<span class="n">proj_angles</span> <span class="o">=</span> <span class="n">image_stack</span><span class="o">.</span><span class="n">real_projection_angles</span><span class="p">()</span>
642+
<span class="k">if</span> <span class="n">proj_angles</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
643+
<span class="bp">self</span><span class="o">.</span><span class="n">stack_visualisers</span><span class="p">[</span><span class="n">stack_id</span><span class="p">]</span><span class="o">.</span><span class="n">image_view</span><span class="o">.</span><span class="n">angles</span> <span class="o">=</span> <span class="n">proj_angles</span></div>
638644

639645

640646
<div class="viewcode-block" id="MainWindowPresenter.add_shuttercounts_to_sample">
@@ -968,7 +974,8 @@ <h1>Source code for mantidimaging.gui.windows.main.presenter</h1><div class="hig
968974
<div class="viewcode-block" id="MainWindowPresenter.add_projection_angles_to_sample">
969975
<a class="viewcode-back" href="../../../../../api/mantidimaging.gui.windows.main.presenter.html#mantidimaging.gui.windows.main.presenter.MainWindowPresenter.add_projection_angles_to_sample">[docs]</a>
970976
<span class="k">def</span><span class="w"> </span><span class="nf">add_projection_angles_to_sample</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stack_id</span><span class="p">:</span> <span class="n">uuid</span><span class="o">.</span><span class="n">UUID</span><span class="p">,</span> <span class="n">proj_angles</span><span class="p">:</span> <span class="n">ProjectionAngles</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
971-
<span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">add_projection_angles_to_sample</span><span class="p">(</span><span class="n">stack_id</span><span class="p">,</span> <span class="n">proj_angles</span><span class="p">)</span></div>
977+
<span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">add_projection_angles_to_sample</span><span class="p">(</span><span class="n">stack_id</span><span class="p">,</span> <span class="n">proj_angles</span><span class="p">)</span>
978+
<span class="bp">self</span><span class="o">.</span><span class="n">stack_visualisers</span><span class="p">[</span><span class="n">stack_id</span><span class="p">]</span><span class="o">.</span><span class="n">image_view</span><span class="o">.</span><span class="n">angles</span> <span class="o">=</span> <span class="n">proj_angles</span></div>
972979

973980

974981
<div class="viewcode-block" id="MainWindowPresenter.load_stacks_from_folder">

_modules/mantidimaging/gui/windows/main/view.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -506,7 +506,7 @@ <h1>Source code for mantidimaging.gui.windows.main.view</h1><div class="highligh
506506
<span class="kn">from</span><span class="w"> </span><span class="nn">PyQt5.QtCore</span><span class="w"> </span><span class="kn">import</span> <span class="n">Qt</span><span class="p">,</span> <span class="n">pyqtSignal</span><span class="p">,</span> <span class="n">QUrl</span><span class="p">,</span> <span class="n">QPoint</span>
507507
<span class="kn">from</span><span class="w"> </span><span class="nn">PyQt5.QtGui</span><span class="w"> </span><span class="kn">import</span> <span class="n">QIcon</span><span class="p">,</span> <span class="n">QDragEnterEvent</span><span class="p">,</span> <span class="n">QDropEvent</span><span class="p">,</span> <span class="n">QDesktopServices</span>
508508
<span class="kn">from</span><span class="w"> </span><span class="nn">PyQt5.QtWidgets</span><span class="w"> </span><span class="kn">import</span> <span class="n">QAction</span><span class="p">,</span> <span class="n">QDialog</span><span class="p">,</span> <span class="n">QLabel</span><span class="p">,</span> <span class="n">QMessageBox</span><span class="p">,</span> <span class="n">QMenu</span><span class="p">,</span> <span class="n">QFileDialog</span><span class="p">,</span> <span class="n">QSplitter</span><span class="p">,</span> \
509-
<span class="n">QTreeWidgetItem</span><span class="p">,</span> <span class="n">QTreeWidget</span><span class="p">,</span> <span class="n">QDockWidget</span><span class="p">,</span> <span class="n">QWidget</span>
509+
<span class="n">QTreeWidgetItem</span><span class="p">,</span> <span class="n">QTreeWidget</span><span class="p">,</span> <span class="n">QDockWidget</span><span class="p">,</span> <span class="n">QWidget</span><span class="p">,</span> <span class="n">QVBoxLayout</span>
510510

511511
<span class="kn">from</span><span class="w"> </span><span class="nn">mantidimaging.core.data</span><span class="w"> </span><span class="kn">import</span> <span class="n">ImageStack</span>
512512
<span class="kn">from</span><span class="w"> </span><span class="nn">mantidimaging.core.io.utility</span><span class="w"> </span><span class="kn">import</span> <span class="n">find_first_file_that_is_possibly_a_sample</span>
@@ -674,13 +674,13 @@ <h1>Source code for mantidimaging.gui.windows.main.view</h1><div class="highligh
674674

675675
<div class="viewcode-block" id="MainWindowView.create_welcome_screen">
676676
<a class="viewcode-back" href="../../../../../api/mantidimaging.gui.windows.main.view.html#mantidimaging.gui.windows.main.view.MainWindowView.create_welcome_screen">[docs]</a>
677-
<span class="k">def</span><span class="w"> </span><span class="nf">create_welcome_screen</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
677+
<span class="k">def</span><span class="w"> </span><span class="nf">create_welcome_screen</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
678678
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_presenter</span> <span class="o">=</span> <span class="n">WelcomeScreenPresenter</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
679679
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_screen</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">welcome_presenter</span><span class="o">.</span><span class="n">view</span>
680680
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_screen</span><span class="o">.</span><span class="n">closed</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">close_welcome_screen</span><span class="p">)</span>
681681
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span> <span class="o">=</span> <span class="n">QDockWidget</span><span class="p">(</span><span class="s2">&quot;About Mantid Imaging&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
682682
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="o">.</span><span class="n">setWidget</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">welcome_screen</span><span class="p">)</span>
683-
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="o">.</span><span class="n">setTitleBarWidget</span><span class="p">(</span><span class="n">QWidget</span><span class="p">())</span>
683+
<span class="bp">self</span><span class="o">.</span><span class="n">_hide_dock_widget_title</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="p">)</span>
684684
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="o">.</span><span class="n">setFeatures</span><span class="p">(</span><span class="n">QDockWidget</span><span class="o">.</span><span class="n">DockWidgetClosable</span><span class="p">)</span>
685685
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="o">.</span><span class="n">setStyleSheet</span><span class="p">(</span><span class="s2">&quot;QDockWidget::title { background: transparent; }&quot;</span><span class="p">)</span>
686686
<span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="o">.</span><span class="n">setAllowedAreas</span><span class="p">(</span><span class="n">Qt</span><span class="o">.</span><span class="n">RightDockWidgetArea</span><span class="p">)</span>
@@ -689,6 +689,12 @@ <h1>Source code for mantidimaging.gui.windows.main.view</h1><div class="highligh
689689
<span class="bp">self</span><span class="o">.</span><span class="n">addDockWidget</span><span class="p">(</span><span class="n">Qt</span><span class="o">.</span><span class="n">RightDockWidgetArea</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">welcome_dock</span><span class="p">)</span></div>
690690

691691

692+
<span class="nd">@staticmethod</span>
693+
<span class="k">def</span><span class="w"> </span><span class="nf">_hide_dock_widget_title</span><span class="p">(</span><span class="n">dock</span><span class="p">:</span> <span class="n">QDockWidget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
694+
<span class="n">hidden_title_bar</span> <span class="o">=</span> <span class="n">QWidget</span><span class="p">()</span>
695+
<span class="n">hidden_title_bar</span><span class="o">.</span><span class="n">setLayout</span><span class="p">(</span><span class="n">QVBoxLayout</span><span class="p">())</span>
696+
<span class="n">dock</span><span class="o">.</span><span class="n">setTitleBarWidget</span><span class="p">(</span><span class="n">hidden_title_bar</span><span class="p">)</span>
697+
692698
<div class="viewcode-block" id="MainWindowView.refresh_welcome_links">
693699
<a class="viewcode-back" href="../../../../../api/mantidimaging.gui.windows.main.view.html#mantidimaging.gui.windows.main.view.MainWindowView.refresh_welcome_links">[docs]</a>
694700
<span class="k">def</span><span class="w"> </span><span class="nf">refresh_welcome_links</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

0 commit comments

Comments
 (0)