Add warnings on use of 3D filaments in prep for initial merge to master

e-koch · Aug 26, 2024 · d17287c · d17287c
1 parent 3837feb
commit d17287c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/fil_finder/filfinderPPP.py b/fil_finder/filfinderPPP.py
@@ -30,7 +30,11 @@ class FilFinderPPP(BaseInfoMixin, Skeleton3D):
 
     """
 
-    def __init__(self, image, wcs=None, mask=None, distance=None, save_name='FilFinder3D_output'):
+    def __init__(self, image, wcs=None, mask=None, distance=None, save_name='FilFinderPPP_output'):
+
+        # Add warning that this is under development
+        warnings.warn("This algorithm is under development. Not all features are implemented"
+                      " or tested. Use with caution.")
 
         self._has_skan()
 

diff --git a/fil_finder/filfinderPPV.py b/fil_finder/filfinderPPV.py
@@ -36,7 +36,11 @@ class FilFinderPPV(Skeleton3D):
 
     """
 
-    def __init__(self, image, mask=None, save_name='FilFinder3D_output'):
+    def __init__(self, image, mask=None, save_name='FilFinderPPV_output'):
+
+        # Add warning that this is under development
+        warnings.warn("This algorithm is under development. Not all features are implemented"
+                      " or tested. Use with caution.")
 
         self._has_skan()