lumicks.pylake.File

class File(filename)

A convenient HDF5 file wrapper for reading data exported from Bluelake

Parameters:
filename : str

The HDF5 file to open in read-only mode

Examples

from lumicks import pylake

file = pylake.File("example.h5")
file.force1x.plot()
file.kymos["name"].plot()
__init__(filename)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(filename) Initialize self.
from_h5py(h5py_file) Directly load an existing h5py.File

Attributes

SUPPORTED_FILE_FORMAT_VERSIONS
blue_photon_count
blue_photon_time_tags
bluelake_version The version of Bluelake which exported this file
description The description of the measurement as entered by the user in Bluelake
distance1
distance2
downsampled_force1
downsampled_force1x
downsampled_force1y
downsampled_force2
downsampled_force2x
downsampled_force2y
downsampled_force3
downsampled_force3x
downsampled_force3y
downsampled_force4
downsampled_force4x
downsampled_force4y
experiment The name of the experiment as entered by the user in Bluelake
export_time The moment this file was exported
fdcurves
force1x
force1y
force2x
force2y
force3x
force3y
force4x
force4y
format_version The version of the Bluelake-specific HDF5 file structure
green_photon_count
green_photon_time_tags
guid An ID which uniquely identifies each exported file
kymos
point_scans
red_photon_count
red_photon_time_tags
scans
__getitem__(item)

Return a subgroup or a bluelake timeline channel

classmethod from_h5py(h5py_file)

Directly load an existing h5py.File

bluelake_version

The version of Bluelake which exported this file

description

The description of the measurement as entered by the user in Bluelake

experiment

The name of the experiment as entered by the user in Bluelake

export_time

The moment this file was exported

format_version

The version of the Bluelake-specific HDF5 file structure

guid

An ID which uniquely identifies each exported file