Metadata-Version: 2.3
Name: pyMRAW
Version: 0.32
Summary: Module for reading and writing Photron MRAW image sequences.
Project-URL: homepage, https://github.com/ladisk/pyMRAW
Project-URL: documentation, https://github.com/ladisk/pyMRAW
Project-URL: source, https://github.com/ladisk/pyMRAW
Author-email: "Jaka Javh, Janko Slavič, Domen Gorjup" <janko.slavic@fs.uni-lj.si>
Maintainer-email: "Janko Slavič et al." <janko.slavic@fs.uni-lj.si>
License-Expression: MIT
Keywords: Photron,cih,cihx,mraw,read/write
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: colorama>=0.3.7
Requires-Dist: nose>=1.3.7
Requires-Dist: numba>=0.56.4
Requires-Dist: numpy>=1.12.0
Requires-Dist: py>=1.4.32
Requires-Dist: xmltodict>=0.12.0
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: wheel; extra == 'dev'
Description-Content-Type: text/x-rst

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



