monochrome 2025.1.17__py3-none-macosx_10_9_universal2.whl

monochrome-2025.1.17.dist-info/METADATA

@@ -0,0 +1,166 @@
+Metadata-Version: 2.1
+Name: monochrome
+Version: 2025.1.17
+Summary: Viewer for monochromatic video data
+Author-Email: Jan Lebert <mail@janlebert.com>
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Desktop Environment
+Classifier: Topic :: Multimedia :: Video :: Display
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Project-URL: Documentation, https://monochrome.readthedocs.io
+Project-URL: Repository, https://github.com/sitic/monochrome
+Requires-Python: >=3.6
+Requires-Dist: numpy
+Requires-Dist: flatbuffers>=23.5.26
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: sphinxcontrib-video; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-codeautolink; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst_nb>=1.0.0; extra == "docs"
+Requires-Dist: jupytext; extra == "docs"
+Requires-Dist: jupyter-cache; extra == "docs"
+Requires-Dist: sphinx-remove-toctrees; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: enum-tools[sphinx]; extra == "docs"
+Requires-Dist: opticalmapping[all]; extra == "docs"
+Provides-Extra: test
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+
+# Monochrome: Viewer for Monochromatic Video Data
+[![docs](https://readthedocs.org/projects/monochrome/badge/?version=latest&style=)](https://monochrome.readthedocs.org)
+[![tests](https://github.com/sitic/monochrome/actions/workflows/build.yml/badge.svg)](https://github.com/sitic/monochrome/actions/workflows/build.yml)
+[![PyPI](https://img.shields.io/pypi/v/monochrome.svg)](https://pypi.org/project/monochrome/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/monochrome.svg)](https://python.org)
+
+Monochrome is a lightweight and fast video viewer for scientific monochromatic videos with high-dynamic range (float, uint16, etc.).
+
+It is designed for viewing high-speed monochromatic fluorescence video data from scientific cameras and meet our specific needs for cardiac optical mapping data (together with [optimap](https://github.com/cardiacvision/optimap)):
+* Support for high-dynamic range (uint16, 32-bit float) data with sliders to adjust intensity range
+* Playback of multiple videos in sync
+* High-speed playback with precise frame-rate control
+* Viewing of optical traces (average intensity in a region of interest over time)
+* Rendering of layers on top of videos with transparency
+* Rendering of point positions over time (e.g. for tracking or optical flow visualization)
+* Exporting videos as a sequence of PNG images or MP4 videos with control over frame rate and frame skipping
+* Cross-platform (Linux, Windows, MacOS)
+
+It is designed to be fast and lightweight, i.e. it uses memory-mapping to load video files to avoid copying the data into RAM.
+
+## Installation
+
+There are two ways to install Monochrome: as a standalone application and/or with its Python interface through pip.
+
+In the standalone application, supported video files can be loaded by drag & drop them into the window or by associating the file extension with Monochrome to open them with a double-click. The Python interface allows to load and play videos from Python scripts and Jupyter notebooks.
+
+### Standalone Application
+
+Download the relevant executable (Windows, macOS, or Linux) from the latest [release page](https://github.com/sitic/monochrome/releases/latest). See the [installation instructions](https://monochrome.readthedocs.io/latest/installation_standalone/) for details.
+
+### Python Library
+
+The Python library includes all necessary files and does not require the installation of the standalone Monochrome application. Open a terminal window and run the following command:
+
+```bash
+python -m pip install monochrome
+```
+
+See the [Python installation guide](https://monochrome.readthedocs.io/latest/installation_python/) for further details. To start the viewer in standalone mode, run:
+```bash
+python -m monochrome
+```
+
+See the [tutorial](https://monochrome.readthedocs.io/latest/tutorial/) for an introduction to the Python library, here is a brief overview:
+
+```python
+import monochrome as mc
+import numpy as np
+
+# Create some video with shape (time, height, width) as a numpy array
+video = np.random.rand(500, 256, 256)
+
+# Display the video, see the tutorial for more details and options.
+# Monochrome should automatically start and show the video in a loop.
+mc.show_video(video, name="First Video", cmap='viridis', vmin=0, vmax=1)
+
+# Play second video in sync with the first (note that the videos should have the same length)
+video2 = (np.random.rand(500, 256, 256) * 65535).astype(dtype=np.uint16)
+mc.show_video(video2, name="Second Video", comment="This is a uint16 video", bitrange="uint16")
+# `bitrange` argument is optional, Monochrome will auto-detect the data type
+
+# Layers can be added on top of video
+overlay = np.random.rand(500, 256, 256)
+overlay[:, 64:192, :] = np.nan # NaN values will be transparent pixels, see tutorial
+mc.show_layer(overlay, parent="Second Video", cmap='PRGn', opacity='centered')
+
+# List of functions:
+# mc.show() is a shortcut for mc.show_video()/show_layer()/show_image()/show_file(),
+#           it will try to auto-detect the input type and call the appropriate function.
+# mc.show_video() to show videos
+# mc.show_image() to show single images
+# mc.show_layer() to show layers on top of videos/images
+# mc.show_points() to visualize point positions over time over videos
+# mc.show_flow() to visualize optical flow fields over time
+# mc.show_file() to load videos from file in Monochrome
+# mc.close_video() to close a video/layer/image
+# mc.export_video() export a window (video+layers+...) as a MP4 video
+# mc.launch() to start Monochrome from Python
+# mc.quit() to close Monochrome
+```
+
+## Native Video File Formats
+Monochrome supports loading the following video file formats:
+
+* `.npy`, NumPy array with shape (time, width, height). The data type can be float (np.float32, np.float64), integer (uint8, uint16, etc.), or boolean.
+* `.dat`, raw binary file with shape (time, width, height) and data type float32
+* `.dat`, MultiRecorder file format (used in the cardiac optical mapping community)
+
+Drag & drop the file into the window or associate the file extension with Monochrome to open it with a double-click.
+
+## Usage & Key Bindings
+
+Adjust settings for each video in the main control window. To view optical traces (average intensity in a region of interest over time), click in a video. Click and drag to move the region of interest. Right-click to remove the region of interest.
+
+Keyboard shortcuts:
+
+| Keybinding &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Action &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
+| --- | --- |
+| `Ctrl + q` | Quit Monochrome |
+| `Esc` or `q` | Close focused recording |
+| `Space` | Play/Pause |
+| `Up` | Increase playback speed (frame skip) |
+| `Down` | Decrease playback speed (frame skip) |
+| `0` or `r` | Reset playback to beginning |
+| `Left` | Skip to next frame |
+| `Right` | Skip to previous frame |
+| `Shift + Left` | 10x previous frame |
+| `Shift + Right` | 10x next frame |
+| `Ctrl + Left` | Previous frame in focused recording only |
+| `Ctrl + Right` | Next frame in focused recording only |
+| `Ctrl + Left + Shift` | 10x previous frame in focused recording only |
+| `Ctrl + Right + Shift` | 10x next frame in focused recording only |
+| `p` | Save screenshot of focused recording |
+| `s` | Sync playback of all recordings |
+
+## Additional Resources
+
+* [Documentation](https://monochrome.readthedocs.io)
+* [Python Tutorial](https://monochrome.readthedocs.io/latest/tutorial/)
+* [PyPI package](https://pypi.org/project/monochrome/)
+* [GitHub repository](https://github.com/sitic/monochrome)
+
+## License
+
+Monochrome is licensed under the MIT License.

monochrome-2025.1.17.dist-info/RECORD

@@ -0,0 +1,33 @@
+monochrome/_version.py,sha256=St4qywsNJKhfVieJUKGfZbifZsWWMBUhRm2Q1WWW9W8,419
+monochrome/ipc.py,sha256=O37_futE2nmJ6fongenplSHCg7hRAkt7i4k2jYwRYE0,22000
+monochrome/__init__.py,sha256=oJZsJT9xf2_Snbkclr7d_6dn482xTloeypukWZPub2o,574
+monochrome/__main__.py,sha256=if3aYd91EFJkdRUGpZDbcIFcpnPBT9CapkzfT3FyBwg,106
+monochrome/fbs/Array3MetaFlow.py,sha256=swb0UNdSGXZH2ddzTiqr538cDn5Av0R92sQmHdCwMkU,4080
+monochrome/fbs/ColorMap.py,sha256=me_PgOsN_H4fGQuSHTOOwCztWlKYHkAkX3JIHi_zK9U,273
+monochrome/fbs/Color.py,sha256=jDgG2EoFMs0Id5Nqfgj7EgyfTpzp3OcuYhyfOrEy6AQ,1368
+monochrome/fbs/DictEntry.py,sha256=avQV-YZBgsL0ZqgN0ntNi2lJ3T-TVD3jGL4kaeCHhqA,2040
+monochrome/fbs/ArrayDataType.py,sha256=ugQbzt0Iw6OsFojkQ27M_H8AqqhWDul0DqvU0GaOV4A,186
+monochrome/fbs/Array3DataChunku16.py,sha256=Bjj2hhcqJ7avz9kovfRjGRcYbMcTFydvCbR6MAdIZPY,3112
+monochrome/fbs/Quit.py,sha256=ivWVcOhNSnEtFuIbjxhbiBWczcQBZcMGtpZCt-7_7dY,1022
+monochrome/fbs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+monochrome/fbs/Array3Meta.py,sha256=Kkz9TyGLykbC3abFerlGuPc8x3PEhRBMNwy7YJH5e4Y,9418
+monochrome/fbs/OpacityFunction.py,sha256=ICUqMo25vclASQhuQlj932w1ZJaW3T7aFCHpbXu5-GM,292
+monochrome/fbs/VideoExport.py,sha256=bCuk1PX34LanHyosMufUhoaTEUI3FCGkIWdVSUAUH6g,5100
+monochrome/fbs/BitRange.py,sha256=Daggt5sybilxPMxGWC6NsSRc-iGm4MKw42RjqCW7iog,305
+monochrome/fbs/Root.py,sha256=jZl2bp-gfmutnkdyEdOZMTqZRDOBSDvOh5qB6fMMF-o,2073
+monochrome/fbs/VideoExportFormat.py,sha256=7ekwHqACzQB68SsDnMJ4KuSbTj0EFthKTGcmUxJ_M08,174
+monochrome/fbs/CloseVideo.py,sha256=QYtP0vjZVFXziUL9xzNeiUne50Kk1AOKKAzjNiif1jw,1584
+monochrome/fbs/Array3DataChunkf.py,sha256=1y1cvViPfbsx4XGyU0nq6UrBSmriquf5HTIv5PlcOOc,3076
+monochrome/fbs/PointsVideo.py,sha256=aMlyteMlM21czkpawy4zYNSrXo0wTdT3yCci4aNMLGE,6205
+monochrome/fbs/Data.py,sha256=t3uRu58ZE2CENmH1dEC-OF9msJWw88ubLKLvs-TXptA,358
+monochrome/fbs/Filepaths.py,sha256=6IdRvuEMnQEmc_yEKq01Xir1jNMx-NueSw4_-hnLNWw,2188
+monochrome/fbs/Array3DataChunku8.py,sha256=2tE7TWuUOgD1cI67m1VNjhaaOQ2usumf6O1uqH_rVN8,3091
+monochrome/data/Monochrome.app/Contents/Info.plist,sha256=_PwjRg-HpvdFmCZndxol17YGA-gcWV1f-ZL1ri94ByM,1957
+monochrome/data/Monochrome.app/Contents/MacOS/Monochrome,sha256=y-m4S1_23umADFRsJXDCcyYMWCaTN50VS8xZpAX9cyc,7569056
+monochrome/data/Monochrome.app/Contents/Resources/npy-logo.icns,sha256=lr1hdU1-wrrljc23jgR3c3csoHm-54wmFZPI5BSL750,174427
+monochrome/data/Monochrome.app/Contents/Resources/Monochrome.icns,sha256=6n9G-qpyT7mBNhw_8SHd4RTU2thcHjW_vhtWNbcNtL4,220359
+monochrome-2025.1.17.dist-info/RECORD,,
+monochrome-2025.1.17.dist-info/WHEEL,sha256=htUCHaC3G9W7CpZNA8SRdecIaBRMX7VsLJKrQXq2Y4M,116
+monochrome-2025.1.17.dist-info/entry_points.txt,sha256=kVQolmivZmjNMMIQgDe1F6gbGv1POeXEq2c5MlDwNTw,62
+monochrome-2025.1.17.dist-info/METADATA,sha256=ILGuiinoKW_qLQc-2JiDtEt7h0wuXBeDND2ggN2eQsE,8338
+monochrome-2025.1.17.dist-info/licenses/LICENSE.md,sha256=hlfbZDVhozFVsj1Zj5ttezKMAMg3WGOIbRCUgVaSSbQ,1054

monochrome-2025.1.17.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.10.7
+Root-Is-Purelib: false
+Tag: py3-none-macosx_10_9_universal2
+

monochrome-2025.1.17.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[gui_scripts]
+Monochrome = monochrome.ipc:console_entrypoint
+

monochrome-2025.1.17.dist-info/licenses/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Jan Lebert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.