Introduction

Why qpformat?

There is a multitude of phase-imaging techniques that inevitably comes with a broad range of quantitative phase imaging (QPI) file formats. In addition, raw data, such as digital holographic microscopy (DHM) images, must be preprocessed to access the phase encoded in the interference pattern. Qpformat provides a unified and user-friendly interface for loading QPI data. It is based on the qpimage library and thus benefits from its hdf5-based data structure (e.g. elaborate background correction, meta data management, and transparent data storage). Furthermore, qpformat can manage large datasets (e.g. many holograms in one folder) without running out of memory by means of its lazily-evaluated SeriesData class.

Supported file formats

Class

Storage type

Description

SeriesFolder

multiple

Folder-based wrapper file format

SeriesHDF5SinogramMeep

field

sinograms extracted from Meep/FDTD simulations

SeriesHdf5HyperSpy

hologram

HyperSpy hologram series (HDF5 format)

SeriesHdf5Qpimage

phase,amplitude

Qpimage series (HDF5 format)

SeriesHdf5QpimageSubjoined

phase,amplitude

Subjoined qpimage series (HDF5 format), may contain other data

SeriesZipTifHolo

hologram

Off-axis hologram series (zipped TIFF files)

SeriesZipTifPhasics

phase,intensity

Phasics series data (zipped “SID PHA*.tif” files)

SingleHdf5Qpimage

phase,amplitude

Qpimage single (HDF5 format)

SingleNpyNumpy

multiple

Numpy complex field or phase data (numpy binary format)

SingleTifHolo

hologram

Off-axis hologram image (TIFF format)

SingleTifPhasics

phase,intensity

Phasics image (“SID PHA*.tif”)