blob: e129c3a53307fa52424df39cafe170c226b2be40 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
.. CCPi-Framework documentation master file, created by
sphinx-quickstart on Tue Mar 19 15:12:44 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to CCPi-Framework's documentation!
==========================================
The aim of this package is to enable rapid prototyping of optimisation-based
reconstruction problems, i.e. defining and solving different optimization problems to enforce different properties on the reconstructed image, while being
powerful enough to be employed on real scale problems.
Firstly, it provides a framework to handle acquisition and reconstruction
data and metadata; it also provides a basic input/output package to read data
from different sources, e.g. Nikon X-Radia, NeXus.
Secondly, it provides an object-oriented framework for defining mathematical
operators and functions as well a collection of useful example operators and
functions. Both smooth and non-smooth functions can be used.
Further, it provides a number of high-level generic implementations of
optimisation algorithms to solve genericlly formulated optimisation problems
constructed from operator and function objects.
A number of demos can be found on the `CIL-Demos`_ repository.
.. toctree::
:maxdepth: 2
:caption: Contents:
:name: mastertoc
framework
io
optimisation
plugins
astra
contrib
developer_guide
.. Indices and tables
.. ==================
.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
Contacts
========
Please refer to the main `CCPi website`_ for up-to-date information.
The CCPi developers may be contacted joining the `devel mailing list`_
.. _devel mailing list: https://www.jiscmail.ac.uk/cgi-bin/webadmin?A0=CCPI-DEVEL
.. _CCPi website: https://www.ccpi.ac.uk
.. _CIL-Demos: https://github.com/vais-ral/CIL-Demos
|
