[gnuastro-commits] master e1ded16 11/32: Book: minor typos and corrections in radial profile script examples

[Mohammad Akhlaghi]

branch: master
commit e1ded1641fb1c74f13040f777b41d6bc37d737f6
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Raul Infante-Sainz <infantesainz@gmail.com>

    Book: minor typos and corrections in radial profile script examples
    
    Until this commit, I have been writing the documentation of the radial
    profile script little by little without having a look at the compiled
    PDF book (because I had some problems in the compilation). However, I
    fixed the problems and now I am able to see the PDF. I saw that the one
    line examples text was too long and other minor typos.
    
    With this commit, I modified several part of the one line examples in
    order to make it to fit into the PDF. Also minor corrections in other
    parts have been included.
---
 doc/gnuastro.texi | 34 +++++++++++++++++++++-------------
 1 file changed, 21 insertions(+), 13 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index a8da0c0..12646c7 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -15423,7 +15423,7 @@ Sometimes it is necessary to compute a radial profile 
of an astronomical object.
 For example, imagine you want to study how the light of a galaxy is 
distributed as a function of the radial distance from the center.
 This is exactly what a radial profile is.
 Gnuastro's @file{astscript-radial-profile} script is created to obtain such 
radial profiles.
-It uses @ref{MakeProfile} to generate elliptical apertures with the values 
equal to the distance from the center of the object and @ref{Catalog} for 
measuring the values over the apertures.
+It uses @command{astmkprof} to generate elliptical apertures with the values 
equal to the distance from the center of the object and @command{astmkcatalog} 
for measuring the values over the apertures.
 With the default options, the script will generate a circular radial profile 
up to a radial distance of 10 pixels using the median value and centered at the 
center of the image.
 In order to have more flexibility, several options are available and the user 
can play with them in order to obtain the wanted radial profile.
 In this sense, it can be changed the center position, the maximum radius, the 
axis ratio and the position angle (because elliptical apertures are 
considered), the operator for obtaining the values, and some other options.
@@ -15448,18 +15448,26 @@ Examples:
 ## Generate the radial profile with default options
 $ astscript-radial-profile image.fits
 
-## Generate the radial profile centered at x=44 and y=37 (in pixels), up to
-a radial distance of 19 pixels, use the mean value, and name the output
-columns `RADIUS` and `VALUES`.
-$ astscript-radial-profile image.fits --mode=img --xcenter=44 --ycenter=37 \
-                           --rmax=19 --iname=RADIUS --jname=VALUES
-
-## Generate the radial profile centered at RA=20.53751695, DEC=0.9454292263,
-## up to a radial distance of 88 pixels, axis ratio equal to 0.32 and position
-## angle of 148 deg. Name the output table as `radial-profile.fits'
-$ astscript-radial-profile image.fits --mode=wcs --xcenter=20.53751695    \
-                           --ycenter=0.9454292263 --rmax=88 --qratio=0.32 \
-                           --pangle=148 --output=radial-profile.fits
+## Generate the radial profile centered at x=44 and y=37 (in pixels),
+## up to  a radial distance of 19 pixels, use the mean value, and
+## name the output columns `RADIUS` and `VALUES`.
+$ astscript-radial-profile image.fits      \
+                            --mode=img     \
+                            --xcenter=44   \
+                            --ycenter=37   \
+                            --rmax=19      \
+                            --iname=RADIUS \
+                            --jname=VALUES
+
+## Generate the radial profile centered at RA=20.53751695,
+## DEC=0.9454292263, up to a radial distance of 88 pixels,
+## axis ratio equal to 0.32 and position  angle of 148 deg.
+## Name the output table as `radial-profile.fits'
+$ astscript-radial-profile image.fits --mode=wcs   \
+                           --xcenter=20.53751695   \
+                           --ycenter=0.9454292263  \
+                           --rmax=88 --qratio=0.32 \
+                           --pangle=148 -oradial-profile.fits
 
 @end example