Add memory leak test

requirements.txt

@@ -11,4 +11,4 @@ imutils
 matplotlib
 pytest
 pytz
-
+psutil

setup.py

@@ -104,6 +104,7 @@
               'imutils',
               'matplotlib',
               'pytz',
+              'psutil',
        ],
        requires=["setuptools", "cython", "numpy"]
 )

src/c_modules/fine_movement/module/imagedeform.c

@@ -41,7 +41,7 @@ static int ImageDeform_init(PyObject *_self, PyObject *args, PyObject *kwds)
     return image_deform_init(&self->deform, grid_w, grid_h, image_w, image_h);
 }
 
-static void ImageDeform_finalize(PyObject *_self)
+static void ImageDeform_dealloc(PyObject *_self)
 {
     PyObject *error_type, *error_value, *error_traceback;
 
@@ -182,6 +182,6 @@ PyTypeObject ImageDeform = {
     .tp_flags = Py_TPFLAGS_DEFAULT,
     .tp_new = PyType_GenericNew,
     .tp_init = ImageDeform_init,
-    .tp_finalize = ImageDeform_finalize,
+    .tp_dealloc = ImageDeform_dealloc,
     .tp_methods = ImageDeform_methods,
 };

src/c_modules/fine_movement/module/imagedeform_gc.c

@@ -39,7 +39,7 @@ static int ImageDeformGC_init(PyObject *_self, PyObject *args, PyObject *kwds)
     return 0;
 }
 
-static void ImageDeformGC_finalize(PyObject *_self)
+static void ImageDeformGC_dealloc(PyObject *_self)
 {
     struct ImageDeformGlobalCorrelatorObject *self =
             (struct ImageDeformGlobalCorrelatorObject *)_self;
@@ -136,6 +136,6 @@ PyTypeObject ImageDeformGC = {
     .tp_flags = Py_TPFLAGS_DEFAULT,
     .tp_new = PyType_GenericNew,
     .tp_init = ImageDeformGC_init,
-    .tp_finalize = ImageDeformGC_finalize,
+    .tp_dealloc = ImageDeformGC_dealloc,
     .tp_methods = ImageDeformGC_methods,
 };

src/c_modules/fine_movement/module/imagedeform_lc.c

@@ -40,7 +40,7 @@ static int ImageDeformLC_init(PyObject *_self, PyObject *args, PyObject *kwds)
     return 0;
 }
 
-static void ImageDeformLC_finalize(PyObject *_self)
+static void ImageDeformLC_dealloc(PyObject *_self)
 {
     struct ImageDeformLocalCorrelatorObject *self =
             (struct ImageDeformLocalCorrelatorObject *)_self;
@@ -132,6 +132,6 @@ PyTypeObject ImageDeformLC = {
     .tp_flags = Py_TPFLAGS_DEFAULT,
     .tp_new = PyType_GenericNew,
     .tp_init = ImageDeformLC_init,
-    .tp_finalize = ImageDeformLC_finalize,
+    .tp_dealloc = ImageDeformLC_dealloc,
     .tp_methods = ImageDeformLC_methods,
 };

src/c_modules/fine_movement/module/imagegrid.c

@@ -43,7 +43,7 @@ static int ImageGrid_init(PyObject *_self, PyObject *args, PyObject *kwds)
  * \brief Destroy ImageGrid
  * \param _self ImageGridObject object
  */
-static void ImageGrid_finalize(PyObject *_self)
+static void ImageGrid_dealloc(PyObject *_self)
 {
     PyObject *error_type, *error_value, *error_traceback;
 
@@ -167,6 +167,6 @@ PyTypeObject ImageGrid = {
     .tp_flags = Py_TPFLAGS_DEFAULT,
     .tp_new = PyType_GenericNew,
     .tp_init = ImageGrid_init,
-    .tp_finalize = ImageGrid_finalize,
+    .tp_dealloc = ImageGrid_dealloc,
     .tp_methods = ImageGrid_methods,
 };

src/c_modules/movements/module.c

@@ -93,7 +93,7 @@ static int SphereMovements_init(PyObject *_self, PyObject *args, PyObject *kwds)
     return 0;
 }
 
-static void SphereMovements_finalize(PyObject *_self)
+static void SphereMovements_dealloc(PyObject *_self)
 {
     PyObject *error_type, *error_value, *error_traceback;
 
@@ -218,7 +218,7 @@ static PyTypeObject _SphereMovement = {
     .tp_flags = Py_TPFLAGS_DEFAULT,
     .tp_new = PyType_GenericNew,
     .tp_init = SphereMovements_init,
-    .tp_finalize = SphereMovements_finalize,
+    .tp_dealloc = SphereMovements_dealloc,
     .tp_methods = _SphereMovements_methods,
 };
 

tests/test_fine_shift.py

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2023 Vladislav Tsendrovskii
+# Copyright (c) 2023-2024 Vladislav Tsendrovskii
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,6 +16,8 @@
 import sys
 import os
 import numpy as np
+import gc
+import psutil
 
 from vstarstack.library.loaders.classic import readjpeg
 from vstarstack.library.fine_movement.module import ImageGrid
@@ -229,3 +231,39 @@ def test_approximate_by_correlation1():
     assert data.shape[2] == 2
     assert np.amin(data) == 0
     assert np.amax(data) == 0
+
+def test_memory_leak():
+    N = 5
+    df1 = next(readjpeg(os.path.join(dir_path, "fine_shift/image1.png")))
+    df2 = next(readjpeg(os.path.join(dir_path, "fine_shift/image1.png")))
+
+    image = df1.get_channel("L")[0].astype('double')
+    image_ref = df2.get_channel("L")[0].astype('double')
+
+    w = image.shape[1]
+    h = image.shape[0]
+
+    prevd = 0
+    memory1 = psutil.Process().memory_info().rss
+    deltas = []
+
+    for _ in range(N):
+        grid = ImageGrid(image_w=w, image_h=h)
+        grid.fill(image)
+        grid_ref = ImageGrid(image_w=w, image_h=h)
+        grid_ref.fill(image_ref)
+
+        lc = ImageDeformLC(image_w=w, image_h=h, pixels=1)
+        deform = lc.find(grid, None, grid_ref, None, 5, 5, 1)
+
+        lc = None
+        deform = None
+        grid = None
+        grid_ref = None
+
+        gc.collect()
+        memory2 = psutil.Process().memory_info().rss
+        print(memory1, memory2, memory2 - memory1, memory2 - memory1 - prevd)
+        deltas.append(memory2 - memory1 - prevd)
+        prevd = memory2 - memory1
+    assert deltas[-1] == 0