Merge pull request #15 from domengorjup/master

MIT license, small showcase fixes

Author: jankoslavic

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LADISK
+
+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.

Showcase.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 25,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -43,9 +43,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 2,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "d:\\workspace\\_PY_PACKAGES\\pymraw\\pyMRAW.py:104: UserWarning: Clipped footage! (Total frame: 4, Original total frame: 400)\n",
+      "  warnings.warn('Clipped footage! (Total frame: {}, Original total frame: {})'.format(cih['Total Frame'], cih['Original Total Frame'] ))\n"
+     ]
+    }
+   ],
    "source": [
     "images, info = pyMRAW.load_video('data/beam.cihx')"
    ]
@@ -59,7 +68,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -68,7 +77,7 @@
        "(numpy.memmap, dtype('uint16'), (4, 80, 1024))"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -86,7 +95,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -107,7 +116,7 @@
        " 'Comment Text': None}"
       ]
      },
-     "execution_count": 11,
+     "execution_count": 4,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -125,7 +134,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -134,7 +143,7 @@
        "(numpy.memmap, dtype('uint16'), (80, 1024))"
       ]
      },
-     "execution_count": 12,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -146,7 +155,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [
     {
@@ -211,9 +220,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    " The expected image format is and appropriately shaped, `(N_images, height, width)`, integer Numpy arrays.\n",
+    " The expected image format is an appropriately shaped, `(N_images, height, width)`, integer Numpy array.\n",
     "\n",
-    " The `info_dict` argument is a dictionary of metadata you wish to assign to your video. Default values for key metadata entries, required to view the MRAW video using Photron's PFV software, are used if they are not provided vie `info_dict`."
+    " The `info_dict` argument is a dictionary of metadata you wish to assign to your video. Default values for key metadata entries, required to view the MRAW video using Photron's PFV software, are used if they are not provided via `info_dict`."
    ]
   }
  ],