Merge pull request #271 from alexlib/master

update windef.simple_pass and tutorial in the docs

Author: alexlib

openpiv/docs/src/tutorial1.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 21,
    "metadata": {
     "lines_to_next_cell": 2
    },
@@ -39,7 +39,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 22,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -49,7 +49,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 23,
    "metadata": {},
    "outputs": [
     {
@@ -94,7 +94,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 24,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -123,7 +123,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 25,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -149,7 +149,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 26,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -168,7 +168,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 27,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -190,7 +190,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 28,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -217,7 +217,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 29,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -235,7 +235,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 30,
    "metadata": {
     "scrolled": true
    },

openpiv/test/test_windef.py

@@ -265,6 +265,15 @@ def test_simple_rectangular_window():
     print('test simple pass with rectangular windows')
 
     settings = windef.PIVSettings()
+
+
+    x, y, _,_,_ = windef.simple_multipass(
+        frame_a,
+        frame_b,
+        settings,
+    )
+    
+        
     settings.windowsizes = ((64, 32),)
     settings.overlap = ((32, 16),)
     settings.num_iterations = 1
@@ -273,7 +282,7 @@ def test_simple_rectangular_window():
     settings.subpixel_method = 'gaussian'
     settings.sig2noise_mask = 2
 
-    x, y, u, v, flags = windef.simple_multipass(
+    x, y, _,_,_ = windef.simple_multipass(
         frame_a,
         frame_b,
         settings,
@@ -290,7 +299,7 @@ def test_simple_rectangular_window():
     settings.overlap = ((16, 32), (8, 16))
     settings.num_iterations = 2
 
-    x, y, u, v, flags = windef.simple_multipass(
+    x, y, _, _, _ = windef.simple_multipass(
         frame_a,
         frame_b,
         settings,

openpiv/windef.py

@@ -972,17 +972,22 @@ def multipass_img_deform(
 def simple_multipass(
     frame_a: np.ndarray,
     frame_b: np.ndarray,
-    settings: "PIVSettings",
-    windows: Optional[Tuple[int, ...]]=None,
+    settings: Optional["PIVSettings"]=None,
     )->Tuple:
-    """ Simple windows deformation multipass run with 
-    default settings
-    """
+    """_summary_
 
-    if windows is not None:
-        settings.num_iterations = len(windows)
-        settings.windowsizes = windows
-        settings.overlap = tuple(int(w/2) for w in windows)
+    Args:
+        frame_a (np.ndarray): frame A image as an array
+        frame_b (np.ndarray): frame B,
+        settings (Optional["PIVSettings"], optional): _description_. Defaults to None.
+
+    Returns:
+        Tuple: _description_
+    """
+    if settings is None:
+        settings = PIVSettings()
+        settings.windowsizes = (64, 32)
+        settings.overlap = (32, 16)
 
     x, y, u, v, s2n = first_pass(
                                 frame_a,