API Reference¶
This part of the documentation explains the code structure and describes each function, class, and method in detail.
Key Concepts¶
The key concepts of the Tike code structure are the following:
Solvers are based on forward and adjoint operators
Solvers are organized into modules based on problem-type
Modules by problem type¶
The solvers for each problem-type (ptychography, tomography, etc) are separated into modules of their respective names.
Operator class structure¶
Forward and adjoint operations in Tike are implemented as a Python class called Operator. This allows a natural linking of the forward and adjoint methods and for Operators to be composed of other Operators.
The chart below is a class diagram. It shows the inheritance and
composition relationships between the Operators in. For example,
Ptycho
is an Operator
which is composed of
Convolution
and Propagation
(which are also Operators).