Read Becker & Hickl SDT files
=============================
Sdtfile is a Python library to read SDT files produced by Becker & Hickl
SPCM software. SDT files contain time correlated single photon counting
instrumentation parameters and measurement data. Currently only the
"Setup & Data", "DLL Data", and "FCS Data" formats are supported.
`Becker & Hickl GmbH <http://www.becker-hickl.de/>`_ is a manufacturer of
equipment for photon counting.
:Author: `Christoph Gohlke <https://www.cgohlke.com>`_
:License: BSD 3-Clause
:Version: 2024.5.24
:DOI: `10.5281/zenodo.10125608 <https://doi.org/10.5281/zenodo.10125608>`_
Quickstart
----------
Install the sdtfile package and all dependencies from the
`Python Package Index <https://pypi.org/project/sdtfile/>`_::
python -m pip install -U sdtfile
See `Examples`_ for using the programming interface.
Source code and support are available on
`GitHub <https://github.com/cgohlke/sdtfile>`_.
Requirements
------------
This revision was tested with the following requirements and dependencies
(other versions may work):
- `CPython <https://www.python.org>`_ 3.9.13, 3.10.11, 3.11.9, 3.12.3
- `NumPy <https://pypi.org/project/numpy>`_ 1.26.4
Revisions
---------
2024.5.24
- Fix docstring examples not correctly rendered on GitHub.
2024.4.24
- Support NumPy 2.
2023.9.28
- Update structs to SPCM v.9.66 (breaking).
- Shorten MEASURE_INFO struct to meas_desc_block_length.
2023.8.30
- …
Refer to the CHANGES file for older revisions.
References
----------
1. W Becker. The bh TCSPC Handbook. 9th Edition. Becker & Hickl GmbH 2021.
pp 879.
2. SPC_data_file_structure.h header file. Part of the Becker & Hickl
SPCM software installation.
Examples
--------
Read image and metadata from a "SPC Setup & Data File":
>>> sdt = SdtFile('image.sdt')
>>> int(sdt.header.revision)
588
>>> sdt.info.id[1:-1]
'SPC Setup & Data File'
>>> int(sdt.measure_info[0].scan_x[0])
128
>>> len(sdt.data)
1
>>> sdt.data[0].shape
(128, 128, 256)
>>> sdt.times[0].shape
(256,)
Read data and metadata from a "SPC Setup & Data File" with multiple data sets:
>>> sdt = SdtFile('fluorescein.sdt')
>>> len(sdt.data)
4
>>> sdt.data[3].shape
(1, 1024)
>>> sdt.times[3].shape
(1024,)
Read image data from a "SPC FCS Data File" as numpy array:
>>> sdt = SdtFile('fcs.sdt')
>>> sdt.info.id[1:-1]
'SPC FCS Data File'
>>> len(sdt.data)
1
>>> sdt.data[0].shape
(512, 512, 256)
>>> sdt.times[0].shape
(256,)
Raw data
{
"_id": null,
"home_page": "https://www.cgohlke.com",
"name": "sdtfile",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Christoph Gohlke",
"author_email": "cgohlke@cgohlke.com",
"download_url": "https://files.pythonhosted.org/packages/9b/66/1ce7fb0912d32ee90e72abe07949d898709813016b54e0cfa9a572aba888/sdtfile-2024.5.24.tar.gz",
"platform": "any",
"description": "Read Becker & Hickl SDT files\r\n=============================\r\n\r\nSdtfile is a Python library to read SDT files produced by Becker & Hickl\r\nSPCM software. SDT files contain time correlated single photon counting\r\ninstrumentation parameters and measurement data. Currently only the\r\n\"Setup & Data\", \"DLL Data\", and \"FCS Data\" formats are supported.\r\n\r\n`Becker & Hickl GmbH <http://www.becker-hickl.de/>`_ is a manufacturer of\r\nequipment for photon counting.\r\n\r\n:Author: `Christoph Gohlke <https://www.cgohlke.com>`_\r\n:License: BSD 3-Clause\r\n:Version: 2024.5.24\r\n:DOI: `10.5281/zenodo.10125608 <https://doi.org/10.5281/zenodo.10125608>`_\r\n\r\nQuickstart\r\n----------\r\n\r\nInstall the sdtfile package and all dependencies from the\r\n`Python Package Index <https://pypi.org/project/sdtfile/>`_::\r\n\r\n python -m pip install -U sdtfile\r\n\r\nSee `Examples`_ for using the programming interface.\r\n\r\nSource code and support are available on\r\n`GitHub <https://github.com/cgohlke/sdtfile>`_.\r\n\r\nRequirements\r\n------------\r\n\r\nThis revision was tested with the following requirements and dependencies\r\n(other versions may work):\r\n\r\n- `CPython <https://www.python.org>`_ 3.9.13, 3.10.11, 3.11.9, 3.12.3\r\n- `NumPy <https://pypi.org/project/numpy>`_ 1.26.4\r\n\r\nRevisions\r\n---------\r\n\r\n2024.5.24\r\n\r\n- Fix docstring examples not correctly rendered on GitHub.\r\n\r\n2024.4.24\r\n\r\n- Support NumPy 2.\r\n\r\n2023.9.28\r\n\r\n- Update structs to SPCM v.9.66 (breaking).\r\n- Shorten MEASURE_INFO struct to meas_desc_block_length.\r\n\r\n2023.8.30\r\n\r\n- \u2026\r\n\r\nRefer to the CHANGES file for older revisions.\r\n\r\nReferences\r\n----------\r\n\r\n1. W Becker. The bh TCSPC Handbook. 9th Edition. Becker & Hickl GmbH 2021.\r\n pp 879.\r\n2. SPC_data_file_structure.h header file. Part of the Becker & Hickl\r\n SPCM software installation.\r\n\r\nExamples\r\n--------\r\n\r\nRead image and metadata from a \"SPC Setup & Data File\":\r\n\r\n>>> sdt = SdtFile('image.sdt')\r\n>>> int(sdt.header.revision)\r\n588\r\n>>> sdt.info.id[1:-1]\r\n'SPC Setup & Data File'\r\n>>> int(sdt.measure_info[0].scan_x[0])\r\n128\r\n>>> len(sdt.data)\r\n1\r\n>>> sdt.data[0].shape\r\n(128, 128, 256)\r\n>>> sdt.times[0].shape\r\n(256,)\r\n\r\nRead data and metadata from a \"SPC Setup & Data File\" with multiple data sets:\r\n\r\n>>> sdt = SdtFile('fluorescein.sdt')\r\n>>> len(sdt.data)\r\n4\r\n>>> sdt.data[3].shape\r\n(1, 1024)\r\n>>> sdt.times[3].shape\r\n(1024,)\r\n\r\nRead image data from a \"SPC FCS Data File\" as numpy array:\r\n\r\n>>> sdt = SdtFile('fcs.sdt')\r\n>>> sdt.info.id[1:-1]\r\n'SPC FCS Data File'\r\n>>> len(sdt.data)\r\n1\r\n>>> sdt.data[0].shape\r\n(512, 512, 256)\r\n>>> sdt.times[0].shape\r\n(256,)\r\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Read Becker & Hickl SDT files",
"version": "2024.5.24",
"project_urls": {
"Bug Tracker": "https://github.com/cgohlke/sdtfile/issues",
"Homepage": "https://www.cgohlke.com",
"Source Code": "https://github.com/cgohlke/sdtfile"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "67f574b78be873ef64b287bab89aa46c7c2f5802e26581edf59920adf6eeebc6",
"md5": "b9a1cf5646dc081a280079a958dd56ba",
"sha256": "fb8a92cc9bf87456172e59c7b8b895f16a1b2519bdb17c351397b5318bba10ce"
},
"downloads": -1,
"filename": "sdtfile-2024.5.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9a1cf5646dc081a280079a958dd56ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16089,
"upload_time": "2024-05-25T16:27:26",
"upload_time_iso_8601": "2024-05-25T16:27:26.715417Z",
"url": "https://files.pythonhosted.org/packages/67/f5/74b78be873ef64b287bab89aa46c7c2f5802e26581edf59920adf6eeebc6/sdtfile-2024.5.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b661ce7fb0912d32ee90e72abe07949d898709813016b54e0cfa9a572aba888",
"md5": "68994515b5826b5a09eb608adf07de8e",
"sha256": "2aec1563a594fc4414442ab8b1409f2dcbb96d19198cb6ab2ed19301cc079dee"
},
"downloads": -1,
"filename": "sdtfile-2024.5.24.tar.gz",
"has_sig": false,
"md5_digest": "68994515b5826b5a09eb608adf07de8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14467,
"upload_time": "2024-05-25T16:27:27",
"upload_time_iso_8601": "2024-05-25T16:27:27.894216Z",
"url": "https://files.pythonhosted.org/packages/9b/66/1ce7fb0912d32ee90e72abe07949d898709813016b54e0cfa9a572aba888/sdtfile-2024.5.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-25 16:27:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cgohlke",
"github_project": "sdtfile",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sdtfile"
}
JSON
