User API

The qpretrieve library offers user-convenient classes for QLSI and DHM data.

Please also check out the examples section.

Let’s say you have your DHM data loaded into a numpy array called hologram. Then your analysis could be as simple as

import qpretrieve
import matplotlib.pylab as plt

dhm = qpretrieve.OffAxisHologram(hologram)
plt.imshow(dhm.phase)
plt.show()

With dhm, an instance of OffAxisHologram, you now have full access to all intermediate computation results. You can pass additional keyword arguments during instantiation or pass them to OffAxisHologram.run_pipeline().