change the function name to be more relevant (show_clean_params).

SAIL-Labs · Mar 31, 2021 · 36a5a2b · 36a5a2b
1 parent 9c3b9da
commit 36a5a2b
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/amical/__init__.py b/amical/__init__.py
@@ -2,7 +2,7 @@
 from .analysis.easy_pymask import pymask_cr_limit, pymask_grid, pymask_mcmc
 from .analysis.fitting import fits2obs, plot_model, smartfit
 from .calibration import calibrate
-from .data_processing import check_data_params, select_clean_data
+from .data_processing import show_clean_params, select_clean_data
 from .mf_pipeline.ami_function import make_mf
 from .mf_pipeline.bispect import extract_bs
 from .oifits import cal2dict, load, loadc, save, show

diff --git a/amical/data_processing.py b/amical/data_processing.py
@@ -215,10 +215,10 @@ def fix_bad_pixels(image, bad_map, add_bad=[], x_stddev=1):
     return fixed_image
 
 
-def check_data_params(filename, isz, r1, dr, bad_map=None, add_bad=[],
+def show_clean_params(filename, isz, r1, dr, bad_map=None, add_bad=[],
                       edge=0, remove_bad=True, nframe=0, ihdu=0, f_kernel=3,
                       offx=0, offy=0, apod=False, window=None):
-    """ Check the input parameters for the cleaning.
+    """ Display the input parameters for the cleaning.
 
     Parameters:
     -----------

diff --git a/doc/example_SPHERE.py b/doc/example_SPHERE.py
@@ -21,7 +21,7 @@
                'f_kernel': 3
                }
 
-amical.check_data_params(file_t, **clean_param)
+amical.show_clean_params(file_t, **clean_param)
 cube_t = amical.select_clean_data(file_t, clip=True,
                                   **clean_param, display=True)
 

diff --git a/doc/tutorial.md b/doc/tutorial.md
@@ -49,7 +49,7 @@ clean_param = {'isz': 69, # final cropped image size [pix]
               }
 
 # Firsly, check if the input parameters are valid
-amical.check_data_params(nrm_file, **clean_param)
+amical.show_clean_params(nrm_file, **clean_param)
 ```
 
 <p align="center">