Tomographer Python Interface (v5.4)¶
The tomographer package provides tools for practical and reliable error bars in quantum tomography.
These Python bindings provide an easy-to-use interface to the underlying C++ routines. If you are interested, here is the API documentation for the Tomographer C++ framework.
Please note that the Python interface is not meant to cover the entire extent of
the C++ API. Rather, we aim to provide a high-level access to core tasks
implemented in optimized C++ routines. We provide specific types (such as for
handling histograms, receiving a status report or passing parameters of a random
walk) in order to interact with those core tasks. The Python interface is
designed to allow a seamless integration of our tomography procedure into an
existing experimental workflow. Currently, there is only one “core task”
implemented, tomographer.tomorun.tomorun()
, which is an alternative
to the tomorun executable program.
Observe that some classes may be loaded and dumped using the pickle
module. You may find this useful for caching intermediate results or for saving
the result of a computation. Classes which can be pickle
d are
documented as such.
If you are developing a new C++ extension module using Tomographer, then you
might have a look at tomographer.include.get_include()
and
tomographer.version.compile_info['cflags']
.
Modules and classes¶
- Histogram Classes (tomographer)
- Metropolis-Hastings Random Walk related classes (tomographer)
- Exception Classes (tomographer)
- Multiprocessing related classes (tomographer.multiproc)
- Storing Tomography Data and Calculating the Likelihood Function (tomographer.densedm)
- Tomorun, the main tomography routine (tomographer.tomorun)
- Utilities for Metropolis-Hastings random walk tasks (tomographer.mhrwtasks)
- Computing the quantum error bars (tomographer.querrorbars)
- Python Tools Related to Tomography (tomographer.tools)
- Utilities for Jupyter notebooks (tomographer.jpyutil)
- Utilities for compiling other modules (tomographer.include)
- Version and compilation information (tomographer.version)
- Writing Special-Purpose C++ Code with a Python Interface