playnano.io.formats.read_jpk_folder module

Module to load .jpk AFM data files from a folder into Python NumPy arrays.

Files contained within the same folder are read together. Files read with the height data in nm.

playnano.io.formats.read_jpk_folder.load_jpk_folder(folder_path: Path | str, channel: str, flip_image: bool = True) AFMImageStack[source]

Load an AFM video from a folder of individual .jpk image files.

AFMReader converts “height”, “measuredHeight” and “amplitude” channels to nm.

Parameters:
  • folder_path (Path | str) – Path to folder containing .jpk files.

  • channel (str) – Channel to extract.

  • flip_image (bool, optional) – Flip each image vertically if True.

Returns:

Loaded AFM image stack with metadata and per-frame info.

Return type:

AFMImageStack