[gnuastro-commits] master 09ddc6b: astscript-ds9-region: new name for astscript-make-ds9-reg

[Mohammad Akhlaghi]

branch: master
commit 09ddc6b9ea3be2ed3a7607a4277d39d92344d831
Author: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    astscript-ds9-region: new name for astscript-make-ds9-reg
    
    Until now, this installed script started with 'make-', therefore making it
    hard to remember or find the script (especially on the command-line with
    TAB).
    
    With this commit, the name of the script starts with the main point of the
    script (which is 'ds9') and it also fully spells 'region' to help in
    readability/usability.
---
 NEWS                                          |  8 +++----
 README                                        |  2 +-
 bin/script/Makefile.am                        |  8 +++----
 bin/script/{make-ds9-reg.in => ds9-region.in} |  0
 doc/Makefile.am                               | 10 ++++----
 doc/gnuastro.texi                             | 34 +++++++++++++--------------
 6 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/NEWS b/NEWS
index f3e7fea..8c0bf43 100644
--- a/NEWS
+++ b/NEWS
@@ -8,14 +8,14 @@ See the end of the file for license conditions.
 ** New features
 
   New program:
-   - astscript-make-ds9-reg: Given a table (either as a file or from
+   - astscript-ds9-region: Given a table (either as a file or from
      standard input), create an SAO DS9 region file from the requested
      positional columns (WCS or image coordinates). For example with the
      command below you can select certain rows of a given table, and show
      them over an image:
-        asttable table.fits --range=MAG,18:20 --column=RA,DEC \
-            | astscript-make-ds9-reg --column=1,2 --radius=0.5 \
-                                     --command="ds9 image.fits"
+        asttable table.fits --range=MAGNITUDE,18:20 --column=RA,DEC \
+            | astscript-ds9-region --column=1,2 --radius=0.5 \
+                                   --command="ds9 image.fits"
    - astscript-radial-profile: Measure the radial profile of an object on
      an image. The profile can be centered anywhere in the image and any
      circular, or elliptical distance can be defined. The output is a table
diff --git a/README b/README
index b0da3d5..2b368be 100644
--- a/README
+++ b/README
@@ -109,7 +109,7 @@ running a program in a special way), Gnuastro also installs 
Bash scripts
 (all prefixed with 'astscript-'). They can be run like a program and behave
 very similarly (with minor differences, as explained in the book).
 
-  - astscript-make-ds9-reg: Given a table (either as a file or from
+  - astscript-ds9-region: Given a table (either as a file or from
     standard input), create an SAO DS9 region file from the requested
     positional columns (WCS or image coordinates).
 
diff --git a/bin/script/Makefile.am b/bin/script/Makefile.am
index 1e17699..3c45589 100644
--- a/bin/script/Makefile.am
+++ b/bin/script/Makefile.am
@@ -26,11 +26,11 @@
 ## 'prefix/bin' directory ('bin_SCRIPTS'), files necessary to distribute
 ## with the tarball ('EXTRA_DIST') and output files (to be cleaned with
 ## 'make clean').
-bin_SCRIPTS = astscript-make-ds9-reg \
+bin_SCRIPTS = astscript-ds9-region \
               astscript-radial-profile \
               astscript-sort-by-night
 
-EXTRA_DIST = make-ds9-reg.in \
+EXTRA_DIST = ds9-region.in \
              radial-profile.in \
              sort-by-night.in
 
@@ -49,8 +49,8 @@ do_subst = sed -e 's,[@]VERSION[@],$(VERSION),g' \
 
 
 ## Rules to install the scripts.
-astscript-make-ds9-reg: make-ds9-reg.in Makefile
-       $(do_subst) < $(srcdir)/make-ds9-reg.in > $@
+astscript-ds9-region: ds9-region.in Makefile
+       $(do_subst) < $(srcdir)/ds9-region.in > $@
        chmod +x $@
 
 astscript-radial-profile: radial-profile.in Makefile
diff --git a/bin/script/make-ds9-reg.in b/bin/script/ds9-region.in
similarity index 100%
rename from bin/script/make-ds9-reg.in
rename to bin/script/ds9-region.in
diff --git a/doc/Makefile.am b/doc/Makefile.am
index c5dff6a..c0c4a43 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -153,7 +153,7 @@ dist_man_MANS = $(MAYBE_ARITHMETIC_MAN) 
$(MAYBE_BUILDPROG_MAN) \
   $(MAYBE_MKCATALOG_MAN) $(MAYBE_MKNOISE_MAN) $(MAYBE_MKPROF_MAN) \
   $(MAYBE_NOISECHISEL_MAN) $(MAYBE_QUERY_MAN) $(MAYBE_SEGMENT_MAN) \
   $(MAYBE_STATISTICS_MAN) $(MAYBE_TABLE_MAN) $(MAYBE_WARP_MAN) \
-  man/astscript-make-ds9-reg.1 man/astscript-radial-profile.1 \
+  man/astscript-ds9-region.1 man/astscript-radial-profile.1 \
   man/astscript-sort-by-night.1
 
 
@@ -250,13 +250,13 @@ man/astwarp.1: $(top_srcdir)/bin/warp/args.h  
$(ALLMANSDEP)
 
 
 # The Scripts:
-man/astscript-make-ds9-reg.1: $(top_srcdir)/bin/script/make-ds9-reg.in   \
-                               $(ALLMANSDEP)
+man/astscript-ds9-region.1: $(top_srcdir)/bin/script/ds9-region.in   \
+                            $(ALLMANSDEP)
        $(MAYBE_HELP2MAN) -n "Create an SAO DS9 region file from a table" \
-                         --libtool $(toputildir)/script/astscript-make-ds9-reg
+                         --libtool $(toputildir)/script/astscript-ds9-region
 
 man/astscript-radial-profile.1: $(top_srcdir)/bin/script/radial-profile.in   \
-                               $(ALLMANSDEP)
+                                $(ALLMANSDEP)
        $(MAYBE_HELP2MAN) -n "Create a radial profile of an object in an image" 
\
                          --libtool 
$(toputildir)/script/astscript-radial-profile
 
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index f9d1950..ade0b0f 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -107,7 +107,7 @@ A copy of the license is included in the section entitled 
``GNU Free Documentati
 
 * astscript-sort-by-night: (gnuastro)Invoking astscript-sort-by-night. Options 
to this script
 
-* astscript-make-ds9-reg: (gnuastro)Invoking astscript-make-ds9-reg. Options 
to this script
+* astscript-ds9-region: (gnuastro)Invoking astscript-ds9-region. Options to 
this script
 
 @end direntry
 
@@ -620,7 +620,7 @@ Generate radial profile
 
 SAO DS9 region files from table
 
-* Invoking astscript-make-ds9-reg::  How to call astscript-make-ds9-reg
+* Invoking astscript-ds9-region::  How to call astscript-ds9-region
 
 Library
 
@@ -4819,14 +4819,14 @@ astmkcatalog lab.fits -h1 --zeropoint=$zeropoint 
-osbl.fits \
 But where do all the random apertures of the upper-limit measurement fall on 
the image?
 It is good to actually inspect their location to get a better understanding 
for the process and also detect possible bugs/biases.
 When MakeCatalog is run with the @option{--checkuplim} option, it will print 
all the random locations and their measured brightness as a table in a file 
with the suffix @file{_upcheck.fits}.
-With the first command below you can use Gnuastro's @command{asttable} and 
@command{astscript-make-ds9-reg} to convert the successful aperture locations 
into a DS9 region file, and with the second can load the region file into the 
detections and sky-subtracted image to visually see where they are.
+With the first command below you can use Gnuastro's @command{asttable} and 
@command{astscript-ds9-region} to convert the successful aperture locations 
into a DS9 region file, and with the second can load the region file into the 
detections and sky-subtracted image to visually see where they are.
 
 @example
 ## Create a DS9 region file from the check table (activated
 ## with '--checkuplim')
 asttable lab_upcheck.fits --noblank=RANDOM_SUM \
-         | astscript-make-ds9-reg -c1,2 --mode=img \
-                                  --radius=$r_pixel
+         | astscript-ds9-region -c1,2 --mode=img \
+                                --radius=$r_pixel
 
 ## Have a look at the regions in relation with NoiseChisel's
 ## detections.
@@ -5002,11 +5002,11 @@ set -u     # Stop execution when a variable is not 
initialized.
 # Default output is `$1_cat.fits'.
 astmkcatalog $1.fits --clumpscat --ids --ra --dec
 
-# Use Gnuastro's Table and astscript-make-ds9-reg to build the DS9
+# Use Gnuastro's Table and astscript-ds9-region to build the DS9
 # region file (a circle of radius 1 arcseconds on each point).
 asttable $1"_cat.fits" -hCLUMPS -cRA,DEC \
-         | astscript-make-ds9-reg -c1,2 --mode=wcs --radius=1 \
-                                  --output=$1.reg
+         | astscript-ds9-region -c1,2 --mode=wcs --radius=1 \
+                                --output=$1.reg
 
 # Show the image (with the requested color scale) and the region file.
 ds9 -geometry 1800x3000 -mecube $1.fits -zoom to fit                   \
@@ -21129,11 +21129,11 @@ In this section we describe a simple installed script 
that is provided within Gn
 SAO DS9@footnote{@url{https://sites.google.com/cfa.harvard.edu/saoimageds9}} 
is one of the most common FITS image vizualization tools in astronomy and is 
free software.
 
 @menu
-* Invoking astscript-make-ds9-reg::  How to call astscript-make-ds9-reg
+* Invoking astscript-ds9-region::  How to call astscript-ds9-region
 @end menu
 
-@node Invoking astscript-make-ds9-reg,  , SAO DS9 region files from table, SAO 
DS9 region files from table
-@subsection Invoking astscript-make-ds9-reg
+@node Invoking astscript-ds9-region,  , SAO DS9 region files from table, SAO 
DS9 region files from table
+@subsection Invoking astscript-ds9-region
 
 This installed script will read two positional columns within an input table 
and generate an SAO DS9 region file to visualize the position of the given 
objects over an image.
 For more on installed scripts please see (see @ref{Installed scripts}).
@@ -21141,23 +21141,23 @@ This script can be used with the following general 
template:
 
 @example
 ## Use the RA and DEC columns of 'table.fits' for the region file.
-$ astscript-make-ds9-reg table.fits --column=RA,DEC \
-                          --output=ds9.reg
+$ astscript-ds9-region table.fits --column=RA,DEC \
+                       --output=ds9.reg
 
 ## Select objects with a magnitude between 18 to 20, and generate the
 ## region file directly (through a pipe), each region with radius of
 ## 0.5 arcseconds.
 $ asttable table.fits --range=MAG,18:20 --column=RA,DEC \
-      | astscript-make-ds9-reg --column=1,2 --radius=0.5
+      | astscript-ds9-region --column=1,2 --radius=0.5
 
 ## With the first command, select objects with a magnitude of 25 to 26
 ## as red regions in 'bright.reg'. With the second command, select
 ## objects with a magnitude between 28 to 29 as a green region and
 ## show both.
 $ asttable cat.fits --range=MAG_F160W,25:26 -cRA,DEC \
-      | ./astscript-make-ds9-reg -c1,2 --color=red -obright.reg
+      | ./astscript-ds9-region -c1,2 --color=red -obright.reg
 $ asttable cat.fits --range=MAG_F160W,28:29 -cRA,DEC \
-      | ./astscript-make-ds9-reg -c1,2 --color=green \
+      | ./astscript-ds9-region -c1,2 --color=green \
                     --command="ds9 image.fits -regions bright.reg"
 @end example
 
@@ -31376,7 +31376,7 @@ in a special way), are done with installed Bash scripts 
(all prefixed with
 similarly (with minor differences, see @ref{Installed scripts}).
 
 @table @code
-@item astscript-make-ds9-reg
+@item astscript-ds9-region
 (See @ref{SAO DS9 region files from table}) Given a table (either as a file or 
from standard input), create an SAO DS9 region file from the requested 
positional columns (WCS or image coordinates).
 
 @item astscript-radial-profile