pyMRAW


NamepyMRAW JSON
Version 0.32 PyPI version JSON
download
home_pageNone
SummaryModule for reading and writing Photron MRAW image sequences.
upload_time2024-07-26 07:45:15
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords photron cih cihx mraw read/write
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            pyMRAW
======

Photron MRAW File Reader.
-------------------------

`pyMRAW` is an open-source package, enabling the efficient use of the Photron MRAW video files in Python workflows.

It's main feature is the use of memory-mapped (`np.memmap`) arrays to create memory maps to locally stored raw video files and avoid loading large amounts of data into RAM. 

.. warning::
    To take advantage of pyMRAW's memory-mapping functionality, make sure to save MRAW files either in 8-bit or 16-bit formats, corresponding to standard data types `uint8` and `uint16`! Using pyMRAW to read 12-bit MRAW files is possible, but requires loading the complete image data into RAM to produce standard Numpy arrays.

To load `.mraw` - `.cihx` files, simply use the `pymraw.load_video` function::

    import pyMRAW
    images, info = pyMRAW.load_video('data/beam.cihx')

For more info, please refer to the `Showcase.ipynb` notebook.

We developed this module while working on this publication:
J. Javh, J. Slavič and M. Boltežar: The Subpixel Resolution of Optical-Flow-Based Modal Analysis,
Mechanical Systems and Signal Processing, Vol. 88, p. 89–99, 2017

Our recent research effort can be found here: http://lab.fs.uni-lj.si/ladisk/?what=incfl&flnm=research_filtered.php&keyword=optical%20methods

If you find our research useful, consider to cite us.


|pytest|

.. |pytest| image:: https://github.com/ladisk/pyMRAW/actions/workflows/python-package.yml/badge.svg
    :target: https://github.com/ladisk/pyMRAW/actions

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyMRAW",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "\"Janko Slavi\u010d et al.\" <janko.slavic@fs.uni-lj.si>",
    "keywords": "Photron, cih, cihx, mraw, read/write",
    "author": null,
    "author_email": "\"Jaka Javh, Janko Slavi\u010d, Domen Gorjup\" <janko.slavic@fs.uni-lj.si>",
    "download_url": "https://files.pythonhosted.org/packages/70/86/c951bbe99429659a19ec6f4affa3fc501d1a4491cc2613592097383a7679/pymraw-0.32.tar.gz",
    "platform": null,
    "description": "pyMRAW\n======\n\nPhotron MRAW File Reader.\n-------------------------\n\n`pyMRAW` is an open-source package, enabling the efficient use of the Photron MRAW video files in Python workflows.\n\nIt's main feature is the use of memory-mapped (`np.memmap`) arrays to create memory maps to locally stored raw video files and avoid loading large amounts of data into RAM. \n\n.. warning::\n    To take advantage of pyMRAW's memory-mapping functionality, make sure to save MRAW files either in 8-bit or 16-bit formats, corresponding to standard data types `uint8` and `uint16`! Using pyMRAW to read 12-bit MRAW files is possible, but requires loading the complete image data into RAM to produce standard Numpy arrays.\n\nTo load `.mraw` - `.cihx` files, simply use the `pymraw.load_video` function::\n\n    import pyMRAW\n    images, info = pyMRAW.load_video('data/beam.cihx')\n\nFor more info, please refer to the `Showcase.ipynb` notebook.\n\nWe developed this module while working on this publication:\nJ. Javh, J. Slavi\u010d and M. Bolte\u017ear: The Subpixel Resolution of Optical-Flow-Based Modal Analysis,\nMechanical Systems and Signal Processing, Vol. 88, p. 89\u201399, 2017\n\nOur recent research effort can be found here: http://lab.fs.uni-lj.si/ladisk/?what=incfl&flnm=research_filtered.php&keyword=optical%20methods\n\nIf you find our research useful, consider to cite us.\n\n\n|pytest|\n\n.. |pytest| image:: https://github.com/ladisk/pyMRAW/actions/workflows/python-package.yml/badge.svg\n    :target: https://github.com/ladisk/pyMRAW/actions\n\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Module for reading and writing Photron MRAW image sequences.",
    "version": "0.32",
    "project_urls": {
        "documentation": "https://github.com/ladisk/pyMRAW",
        "homepage": "https://github.com/ladisk/pyMRAW",
        "source": "https://github.com/ladisk/pyMRAW"
    },
    "split_keywords": [
        "photron",
        " cih",
        " cihx",
        " mraw",
        " read/write"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94bd2b2d75496bc15d58a4bc56adb0b0ad6bddb764c767cc4835cf7ef9dd6fb6",
                "md5": "b5a56ba95edfcec6a67c33fcdd82f561",
                "sha256": "86933f2f27f261ad48e4ae925774b605899a14661133d8a0e7dbb8fa37176a4b"
            },
            "downloads": -1,
            "filename": "pymraw-0.32-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b5a56ba95edfcec6a67c33fcdd82f561",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6772,
            "upload_time": "2024-07-26T07:45:13",
            "upload_time_iso_8601": "2024-07-26T07:45:13.600793Z",
            "url": "https://files.pythonhosted.org/packages/94/bd/2b2d75496bc15d58a4bc56adb0b0ad6bddb764c767cc4835cf7ef9dd6fb6/pymraw-0.32-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7086c951bbe99429659a19ec6f4affa3fc501d1a4491cc2613592097383a7679",
                "md5": "605adb56327b2bda123a45a6e33afdd6",
                "sha256": "3f6144b3a29af896da0b9191fe46322fa488b95d08aeac6189a30b34ac43465d"
            },
            "downloads": -1,
            "filename": "pymraw-0.32.tar.gz",
            "has_sig": false,
            "md5_digest": "605adb56327b2bda123a45a6e33afdd6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 6413335,
            "upload_time": "2024-07-26T07:45:15",
            "upload_time_iso_8601": "2024-07-26T07:45:15.212108Z",
            "url": "https://files.pythonhosted.org/packages/70/86/c951bbe99429659a19ec6f4affa3fc501d1a4491cc2613592097383a7679/pymraw-0.32.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 07:45:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ladisk",
    "github_project": "pyMRAW",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pymraw"
}
None
Elapsed time: 0.26238s