Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 26, 2024
1 parent 6e1f4ec commit 120db86
Show file tree
Hide file tree
Showing 89 changed files with 260 additions and 135 deletions.
Binary file modified nightly/.doctrees/developer_guide.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/environment.pickle
Binary file not shown.
Binary file modified nightly/.doctrees/framework.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/index.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/introduction.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/io.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/optimisation.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/plugins.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/processors.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/recon.doctree
Binary file not shown.
Binary file modified nightly/.doctrees/utilities.doctree
Binary file not shown.
3 changes: 1 addition & 2 deletions nightly/_modules/cil/framework/BlockDataContainer/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.framework.BlockDataContainer</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/framework/BlockGeometry/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.framework.BlockGeometry</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/framework/framework/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.framework.framework</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2018 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2018 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2018 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/NEXUSDataReader/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.NEXUSDataReader</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/NEXUSDataWriter/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.NEXUSDataWriter</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/NikonDataReader/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.NikonDataReader</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/RAWFileWriter/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.RAWFileWriter</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2023 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2023 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2023 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/TIFF/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.TIFF</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2020 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/ZEISSDataReader/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.ZEISSDataReader</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2022 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2022 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2022 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/io/utilities/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.io.utilities</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2023 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2023 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2023 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/optimisation/algorithms/ADMM/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.ADMM</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2020 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/optimisation/algorithms/CGLS/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.CGLS</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.FISTA</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/optimisation/algorithms/GD/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.GD</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/optimisation/algorithms/PDHG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.PDHG</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
3 changes: 1 addition & 2 deletions nightly/_modules/cil/optimisation/algorithms/SIRT/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.SIRT</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.algorithms.SPDHG</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2020 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.BlockFunction</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.Function</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.IndicatorBox</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.KullbackLeibler</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.L1Norm</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.L2NormSquared</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.LeastSquares</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2018 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2018 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2018 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.MixedL21Norm</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.OperatorCompositionFunction</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.Rosenbrock</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.functions.TotalVariation</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2020 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2020 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -436,8 +436,7 @@ <h3><a href="../../../../../">Table of Contents</a></h3>
<article class="bd-article" role="main">

<h1>Source code for cil.optimisation.operators.BlockOperator</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span></span><span class="c1"># Copyright 2019 United Kingdom Research and Innovation</span>
<span class="c1"># Copyright 2019 The University of Manchester</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
Expand Down
Loading

0 comments on commit 120db86

Please sign in to comment.