lumicks.pylake.File¶

class File(filename)¶

A convenient HDF5 file wrapper for reading data exported from Bluelake

Parameters

Examples

from lumicks import pylake

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

Methods

`__getitem__`(item)	Return a subgroup or a bluelake timeline channel
`_check_file_format`()
`_get_corrected_force`(n, xyz)	Return a Slice of force measurements, including calibration, with baseline correction applied.
`_get_distance`(n)
`_get_downsampled_force`(n, xyz)	Return a Slice of low frequency force measurements, including calibration if applicable Note: direct access to HDF dataset does not include calibration data
`_get_force`(n, xyz)	Return a Slice of force measurements, including calibration Note: direct access to HDF dataset does not include calibration data
`_get_object_dictionary`(field, cls)
`_get_photon_count`(name)
`_get_photon_time_tags`(name)
`from_h5py`(h5py_file)	Directly load an existing `h5py.File`
`save_as`(filename[, compression_level, omit_data])	Write a modified h5 file to disk.

Attributes

`SUPPORTED_FILE_FORMAT_VERSIONS`
`blue_photon_count`
`blue_photon_time_tags`
`bluelake_version`	The version of Bluelake which exported this file
`corrected_force1x`
`corrected_force2x`
`description`	The description of the measurement as entered by the user in Bluelake
`distance1`
`distance2`
`downsampled_force1`
`downsampled_force1x`
`downsampled_force1y`
`downsampled_force1z`
`downsampled_force2`
`downsampled_force2x`
`downsampled_force2y`
`downsampled_force2z`
`downsampled_force3`
`downsampled_force3x`
`downsampled_force3y`
`downsampled_force3z`
`downsampled_force4`
`downsampled_force4x`
`downsampled_force4y`
`downsampled_force4z`
`experiment`	The name of the experiment as entered by the user in Bluelake
`export_time`	The moment this file was exported
`fdcurves`
`force1x`
`force1y`
`force1z`
`force2x`
`force2y`
`force2z`
`force3x`
`force3y`
`force3z`
`force4x`
`force4y`
`force4z`
`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`
`markers`
`point_scans`
`red_photon_count`
`red_photon_time_tags`
`scans`