{ "info": { "author": "Zhenpeng Zhou and Daniel R. Stephan", "author_email": "zhenp3ngzhou@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha" ], "description": "# SIF Reader\n\nThis package is designed to read Andor SIF image file.\n\nIn addition to raw image data, it provides access to the wavelength axis for spectra, and metadata such as\nexposure time, gain, recording date etc. Image data can be read as a `numpy` array or as an\n[xarray](https://xarray.pydata.org/en/stable/) `DataArray`, which contains the image data as well as the coordinate\naxes and labels in a single object. For spectra, the spectral axis can be returned as nanometers, wavenumbers or\nelectron volts.\n\n**To the best of our knowledge, this is currently the only Python package that can extract wavelength information\nfrom .sif files using only pure Python and numpy (i.e. without relying on any Andor dll libraries).**\n\n## Requirements\n`numpy` (optionally `xarray`, `pytest` to run the unit tests)\n\n## Installation\nInstall with `pip`:\n```\n>pip install sifreader\n```\n\n## Usage\n\nOpen a file and print the metadata:\n\n```\n>file = SIFFile('my_image.sif')\n>print(file)\n\nOriginal Filename: E:\\test_sequence.sif\nDate: Thu May 10 12:01:48 2018\n...\n```\n\nRead a single or all frames contained in the file as numpy arrays:\n```\n>first_frame = file.read_block(0)\n>all_frames = file.read_all()\n```\n\nThe horizontal axis is contained in the `x_axis` member variable. If the file contains a spectrum, the axis will be\nthe wavelength in namometers, otherwise it will contain the pixel numbers:\n```\n>wavelengths = file.x_axis\n```\n\n### With the optional xarray package\n\nRead all frames in the file as a `DataArray`:\n```\n>xarr = file.as_xarray()\n```\n\nFor spectra: make a `DataArray` that contains the photon energy in eV rather than the default wavelength:\n```\n>spectrum_file = SIFFile('my_spectrum.sif')\n>xarr = spectrum_file.as_xarray('photon_energy')\n```\n\nOne of the nice features of `DataArray` is the ability to easily select data and plot it:\n```python\nspectrum_file.as_xarray().sel(frames=0, wavelength=slice(749.5, 768.2)).plot()\n```\n\n## Version History\n\n- 0.2: Added support for wavelength information, xarray exporting and unit tests\n- 0.1: First release", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/lightingghost/sifreader/archive/0.2.3.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/lightingghost/sifreader", "keywords": "SIF,Andor,Image,reader", "license": "", "maintainer": "", "maintainer_email": "", "name": "sifreader", "package_url": "https://pypi.org/project/sifreader/", "platform": "", "project_url": "https://pypi.org/project/sifreader/", "project_urls": { "Download": "https://github.com/lightingghost/sifreader/archive/0.2.3.tar.gz", "Homepage": "https://github.com/lightingghost/sifreader" }, "release_url": "https://pypi.org/project/sifreader/0.2.4/", "requires_dist": null, "requires_python": "", "summary": "A library to read Andor SIF file", "version": "0.2.4" }, "last_serial": 3901952, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "ad70b648a3c03031814e245e02047f68", "sha256": "eb62aaebba79367c849e1b763757b814b4e04f7d67c23891d1f6c827514948e7" }, "downloads": -1, "filename": "sifreader-0.1.tar.gz", "has_sig": false, "md5_digest": "ad70b648a3c03031814e245e02047f68", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2164, "upload_time": "2017-11-18T23:11:19", "url": "https://files.pythonhosted.org/packages/ea/e6/0f601a6af7d2d411711d2dfb810d0ffcb1264871ab71dc320e2508033ac9/sifreader-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "96649c4b5a7206180c31905eb9042406", "sha256": "54a0a00f34e25b1e879ff5b5323f9ce881ab07baab69a39c0d3b030cc8f19aee" }, "downloads": -1, "filename": "sifreader-0.2.tar.gz", "has_sig": false, "md5_digest": "96649c4b5a7206180c31905eb9042406", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4533, "upload_time": "2018-05-13T05:03:02", "url": "https://files.pythonhosted.org/packages/e1/ff/da503b68c42dfa86c2ce3fa3ed9c6ec55ca99e13d8c8ea3b3a70fbb331a8/sifreader-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "8ecad8ac81eb3c7e2d56f8f3f7ca7640", "sha256": "def129dc8435bc3a2de5c6212cdcb07e6cf6a34225a1047874529a6e1a2a4616" }, "downloads": -1, "filename": "sifreader-0.2.1.tar.gz", "has_sig": false, "md5_digest": "8ecad8ac81eb3c7e2d56f8f3f7ca7640", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5510, "upload_time": "2018-05-13T05:29:17", "url": "https://files.pythonhosted.org/packages/3f/02/710375136bb290454f97f0a4918f8a95c2f1c5e1b5de860b37e2fd7582c1/sifreader-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "cda437877d2546a51a195d7024c388cf", "sha256": "da47431723813a055442e1e180bdb5d5f1922bcc053b833b4fd549d77cf442a5" }, "downloads": -1, "filename": "sifreader-0.2.2.tar.gz", "has_sig": false, "md5_digest": "cda437877d2546a51a195d7024c388cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5490, "upload_time": "2018-05-13T23:25:44", "url": "https://files.pythonhosted.org/packages/ba/3e/c01531c01af0e4472018ab7481cc283fe41a96be9f1316f8b594af6d2b2b/sifreader-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "36a75785994fd9778e437436844a1fc8", "sha256": "ac3e677755bf52c9ee43d532185112bf7a2c9941d6aac2b04ba7a9d407bc8095" }, "downloads": -1, "filename": "sifreader-0.2.3.tar.gz", "has_sig": false, "md5_digest": "36a75785994fd9778e437436844a1fc8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4628, "upload_time": "2018-05-13T23:43:27", "url": "https://files.pythonhosted.org/packages/be/7c/92055f8c602e150f4e58baf52592fa792b535ecbb13c974636715ff7fe1e/sifreader-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "99902d04a72aa0fb96207835f95f8329", "sha256": "45a9235e95996a68169c1da1e273c2fbae3ed97865f96ac051650c5a3e63c488" }, "downloads": -1, "filename": "sifreader-0.2.4.tar.gz", "has_sig": false, "md5_digest": "99902d04a72aa0fb96207835f95f8329", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5583, "upload_time": "2018-05-26T18:33:45", "url": "https://files.pythonhosted.org/packages/9d/09/701d6f40d2b4afa9453cef303e7e015798e6c9dffb8739b24104c923389a/sifreader-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "99902d04a72aa0fb96207835f95f8329", "sha256": "45a9235e95996a68169c1da1e273c2fbae3ed97865f96ac051650c5a3e63c488" }, "downloads": -1, "filename": "sifreader-0.2.4.tar.gz", "has_sig": false, "md5_digest": "99902d04a72aa0fb96207835f95f8329", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5583, "upload_time": "2018-05-26T18:33:45", "url": "https://files.pythonhosted.org/packages/9d/09/701d6f40d2b4afa9453cef303e7e015798e6c9dffb8739b24104c923389a/sifreader-0.2.4.tar.gz" } ] }