Skip to content

Commit b903d9b

Browse files
authored
Merge pull request #14 from domengorjup/master
readme formatting
2 parents b9f171e + cb5ae3a commit b903d9b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

readme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Photron MRAW File Reader.
66

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

9-
It's main feature is the use of memory-mapped ([`np.memmap`](https://numpy.org/doc/stable/reference/generated/numpy.memmap.html)) arrays to create memory maps to locally stored raw video files and avoid loading large amounts of data into RAM.
9+
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.
1010

1111
.. warning::
1212
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.

0 commit comments

Comments
 (0)