Documentation update

r-xue · Jul 8, 2020 · dae47c0 · dae47c0
1 parent 9964931
commit dae47c0
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 1,312 deletions.
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ and then call it using
         Default: Write to the directory where img_fits resides.
         NOTE: Currently this directory is assumed to exist.
     outname : string, optional
-        Basname for output files.  For instance, outname='foo' produces files
+        Basename for output files.  For instance, outname='foo' produces files
         'foo.mom0.fits.gz', etc.
         Default: Based on root name of img_fits.
     snr_hi : float, optional
@@ -58,12 +58,13 @@ and then call it using
         Low significance mask is required to span at least this many channels
         at all pixels.
         Default: 1
+    min_tot_ch : int, optional
+        Each contiguous mask region must span at least this many channels (but 
+        it's not necessary that every pixel in the region span this many channels).
+        Default: 2
     minbeam : float, optional
         Minimum velocity-integrated area of a mask region in units of the beam size.
         Default: 1
-    min_tot_ch : int, optional
-        Dilated mask regions are required to span at least this many channels.
-        Default: 2
     nguard : tuple of two ints, optional
         Expand the final mask by nguard[0] pixels in the sky directions and
         nguard[1] channels in velocity.  Currently these values must be equal

diff --git a/example/edge_compare_flux.ipynb b/example/edge_compare_flux.ipynb
diff --git a/example/edge_compare_mom.ipynb b/example/edge_compare_mom.ipynb
diff --git a/example/edge_compare_spec.ipynb b/example/edge_compare_spec.ipynb
diff --git a/maskmoment.py b/maskmoment.py
@@ -39,7 +39,7 @@ def maskmoment(img_fits, gain_fits=None, rms_fits=None, mask_fits=None, outdir='
         Default: Write to the directory where img_fits resides.
         NOTE: Currently this directory is assumed to exist.
     outname : string, optional
-        Basname for output files.  For instance, outname='foo' produces files
+        Basename for output files.  For instance, outname='foo' produces files
         'foo.mom0.fits.gz', etc.
         Default: Based on root name of img_fits.
     snr_hi : float, optional
@@ -48,9 +48,6 @@ def maskmoment(img_fits, gain_fits=None, rms_fits=None, mask_fits=None, outdir='
     snr_lo : float, optional
         The low significance sigma threshold at which to end mask dilation.
         Default: 2
-    minbeam : float, optional
-        Minimum velocity-integrated area of a mask region in units of the beam size.
-        Default: 1
     snr_hi_minch : int, optional
         High significance mask is required to span at least this many channels
         at all pixels.
@@ -60,8 +57,12 @@ def maskmoment(img_fits, gain_fits=None, rms_fits=None, mask_fits=None, outdir='
         at all pixels.
         Default: 1
     min_tot_ch : int, optional
-        Dilated mask regions are required to span at least this many channels.
+        Each contiguous mask region must span at least this many channels (but 
+        it's not necessary that every pixel in the region span this many channels).
         Default: 2
+    minbeam : float, optional
+        Minimum velocity-integrated area of a mask region in units of the beam size.
+        Default: 1
     nguard : tuple of two ints, optional
         Expand the final mask by nguard[0] pixels in the sky directions and
         nguard[1] channels in velocity.  Currently these values must be equal