[gnuastro-commits] master b441b03: NoiseChisel's --convolvedname option back to --convolved

[Mohammad Akhlaghi]

branch: master
commit b441b0319443b5904cb0ed8fa3afde22053ece4c
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    NoiseChisel's --convolvedname option back to --convolved
    
    In a previous commit, I had mistakenly assumed that all the file name
    options end in `name'. But in NoiseChisel, this was the standard in
    `main.h', not the options. We should probably fix this sometime (so the
    names in `main.h' and the option names exactly correspond). So with this
    commit, the `name' suffix is removed and the option is only called
    `--convolved'.
    
    Also, I noticed that the `--log' option is present in NoiseChisel's
    `--help' output while NoiseChisel doesn't produce any logs. So in
    `bin/noisechisel/ui.c', `--log' is now set to be a hidden option.
---
 NEWS                   | 11 ++++++-----
 bin/noisechisel/args.h |  2 +-
 bin/noisechisel/ui.c   |  7 ++++---
 doc/gnuastro.texi      |  6 +++---
 4 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/NEWS b/NEWS
index b80a32c..269a79a 100644
--- a/NEWS
+++ b/NEWS
@@ -45,15 +45,16 @@ GNU Astronomy Utilities NEWS                          -*- 
outline -*-
   `--geora', `--geodec', `--clumpsra', `--clumpsdec', `--clumpsgeora',
   `--clumpsgeodec'. No alias is currently defined for the latter group.
 
-  MakeCatalog: The new `--uprange' option allows you to specify a range for
+  MakeCatalog: the new `--uprange' option allows you to specify a range for
   the random values around each object. This is useful when the noise
   properties of the dataset vary gradually and sampling from the whole
   dataset might produce biased results.
 
-  NoiseChisel: with the new `--convolved' option, NoiseChisel will not
-  convolve the input any more and use the given image. In many cases,
-  convolution is the most time consuming step of NoiseChisel, so with this
-  option, you can greatly speed up your tests (to find the best parameters
+  NoiseChisel: with the new `--convolved' and `--convolvedhdu' options,
+  NoiseChisel will not convolve the input any more and use the given
+  dataset instead. In many cases, as the inputs get larger, convolution is
+  the most time consuming step of NoiseChisel. With this option, you can
+  greatly speed up your tests (to find the best parameters by varying them,
   for a given analysis). See the book for more information and examples.
 
   NoiseChisel: with the new `--widekernel' option it is now possible to use
diff --git a/bin/noisechisel/args.h b/bin/noisechisel/args.h
index aee682f..e44efbd 100644
--- a/bin/noisechisel/args.h
+++ b/bin/noisechisel/args.h
@@ -60,7 +60,7 @@ struct argp_option program_options[] =
       GAL_OPTIONS_NOT_SET
     },
     {
-      "convolvedname",
+      "convolved",
       UI_KEY_CONVOLVED,
       "STR",
       0,
diff --git a/bin/noisechisel/ui.c b/bin/noisechisel/ui.c
index ba68215..75c4ee9 100644
--- a/bin/noisechisel/ui.c
+++ b/bin/noisechisel/ui.c
@@ -119,6 +119,7 @@ ui_initialize_options(struct noisechiselparams *p,
       /* Select individually. */
       switch(cp->coptions[i].key)
         {
+        case GAL_OPTIONS_KEY_LOG:
         case GAL_OPTIONS_KEY_TYPE:
         case GAL_OPTIONS_KEY_SEARCHIN:
         case GAL_OPTIONS_KEY_IGNORECASE:
@@ -218,7 +219,7 @@ ui_read_check_only_options(struct noisechiselparams *p)
      mandatory. */
   if(p->convolvedname && p->convolvedhdu==NULL)
     error(EXIT_FAILURE, 0, "no value given to `--convolvedhdu'. When the "
-          "`--convolvedname' option is called (to specify a convolved image "
+          "`--convolved' option is called (to specify a convolved image "
           "and avoid convolution) it is mandatory to also specify a HDU "
           "for it");
 
@@ -606,8 +607,8 @@ ui_preparations(struct noisechiselparams *p)
 
       /* Make sure the convolved image is the same size as the input. */
       if( gal_data_dsize_is_different(p->input, p->conv) )
-        error(EXIT_FAILURE, 0, "%s (hdu %s), given to `--convolvedname' "
-              "and `--convolvehdu', is not the same size as NoiseChisel's "
+        error(EXIT_FAILURE, 0, "%s (hdu %s), given to `--convolved' and "
+              "`--convolvehdu', is not the same size as NoiseChisel's "
               "input: %s (hdu: %s)", p->convolvedname, p->convolvedhdu,
               p->inputname, p->cp.hdu);
     }
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 34304f7..c7bac20 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -12527,7 +12527,7 @@ Akhlaghi and Ichikawa [2015].
 HDU containing the kernel in the file given to the @option{--kernel}
 option.
 
address@hidden --convolvedname=STR
address@hidden --convolved=STR
 Use this file as the convolved image and don't do convolution and ignore
 @option{--kernel}. NoiseChisel will just check the size of the given
 dataset is the same as the input's size. If a wrong image (with the same
@@ -12568,7 +12568,7 @@ $ astconvolve input.fits --kernel=kernel.fits           
     \
 
 ## Run NoiseChisel with seven growth quantile values.
 $ for g in 60 65 70 75 80 85 90; do                          \
-    astnoisechisel input.fits --convolvedname=convolved.fits \
+    astnoisechisel input.fits --convolved=convolved.fits     \
                    --detgrowquant=0.$g --output=$g.fits;     \
   done
 @end example
@@ -12577,7 +12577,7 @@ $ for g in 60 65 70 75 80 85 90; do                     
     \
 
 @item --convolvedhdu=STR
 The HDU/extension containing the convolved image in the file given to
address@hidden
address@hidden
 
 @item -w STR
 @itemx --widekernel=STR