[gnuastro-commits] master d14384a 007/113: Minor corrections in MakeProfiles manual

[Mohammad Akhlaghi]

branch: master
commit d14384a89a1c1ff207aa91949e07f6fbb068dbb5
Author: Mohammad Akhlaghi <akhlaghi@gnu.org>
Commit: Mohammad Akhlaghi <akhlaghi@gnu.org>

    Minor corrections in MakeProfiles manual
    
    I had forgot to describe the `astmkprof-3d.conf' configuration file that is
    installed with the rest of the configuration files at install time. It
    greatly simplifies the creation of 3D ellipsoids. So a paragraph was added
    in the manual describing this configuration file and how to use it.
    
    Also, the `--mode' option was moved to the profiles group of options
    similar to the other options that define the interpretation of the catalog
    columns.
---
 bin/mkprof/args.h | 30 +++++++++++++++---------------
 doc/gnuastro.texi | 28 +++++++++++++++++++++++-----
 2 files changed, 38 insertions(+), 20 deletions(-)

diff --git a/bin/mkprof/args.h b/bin/mkprof/args.h
index 0c7441b..41bcff1 100644
--- a/bin/mkprof/args.h
+++ b/bin/mkprof/args.h
@@ -165,6 +165,20 @@ struct argp_option program_options[] =
       ARGS_GROUP_PROFILES
     },
     {
+      "mode",
+      UI_KEY_MODE,
+      "STR",
+      0,
+      "Mode of `--ccol': `img' or `wcs'.",
+      ARGS_GROUP_PROFILES,
+      &p->mode,
+      GAL_TYPE_STRING,
+      GAL_OPTIONS_RANGE_ANY,
+      GAL_OPTIONS_MANDATORY,
+      GAL_OPTIONS_NOT_SET,
+      ui_parse_coordinate_mode
+    },
+    {
       "numrandom",
       UI_KEY_NUMRANDOM,
       "INT",
@@ -222,7 +236,7 @@ struct argp_option program_options[] =
       0,
       0,
       "mcol is flat pixel value (when fcol is 5 or 6)",
-      ARGS_GROUP_CATALOG,
+      ARGS_GROUP_PROFILES,
       &p->mforflatpix,
       GAL_OPTIONS_NO_ARG_TYPE,
       GAL_OPTIONS_RANGE_0_OR_1,
@@ -319,20 +333,6 @@ struct argp_option program_options[] =
       ARGS_GROUP_CATALOG
     },
     {
-      "mode",
-      UI_KEY_MODE,
-      "STR",
-      0,
-      "Mode of `--ccol': `img' or `wcs'.",
-      GAL_OPTIONS_GROUP_INPUT,
-      &p->mode,
-      GAL_TYPE_STRING,
-      GAL_OPTIONS_RANGE_ANY,
-      GAL_OPTIONS_MANDATORY,
-      GAL_OPTIONS_NOT_SET,
-      ui_parse_coordinate_mode
-    },
-    {
       "ccol",
       UI_KEY_CCOL,
       "STR/INT",
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index ae66b75..2ec6fc3 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -14796,6 +14796,23 @@ MakeProfiles also supports all the common Gnuastro 
program options that are
 discussed in @ref{Common options}, so please flip through them is well for
 a more comfortable usage.
 
+When building 3D profiles, there are more degrees of freedom. Hence, more
+columns are necessary and all the values related to dimensions (for example
+size of dataset in each dimension and the WCS properties) must also have 3
+values. To allow having an independent set of default values for creating
+3D profiles, MakeProfiles also installs a @file{astmkprof-3d.conf}
+configuration file (see @ref{Configuration files}). You can use this for
+default 3D profile values. For example, if you installed Gnuastro with the
+prefix @file{/usr/local} (the default location, see @ref{Installation
+directory}), you can benefit from this configuration file by running
+MakeProfiles like the example below. As with all configuration files, if
+you want to customize a given option, call it before the configuration
+file.
+
+@example
+$ astmkprof --config=/usr/local/etc/astmkprof-3d.conf catalog.txt
+@end example
+
 Please see @ref{Sufi simulates a detection} for a very complete tutorial
 explaining how one could use MakeProfiles in conjunction with other
 Gnuastro's programs to make a complete simulated image of a mock galaxy.
@@ -14856,11 +14873,6 @@ below.
 
 @table @option
 
-@item --mode=STR
-Interpret the center position columns in image or WCS coordinates. This
-option thus accepts only two values: @option{img} and @option{wcs}. It is
-mandatory when a catalog is being used.
-
 @item --ccol=STR/INT
 Center coordinate column for each dimension. This option must be called two
 times to define the center coordinates in an image. For example
@@ -14976,6 +14988,12 @@ properties.
 
 @table @option
 
+@item --mode=STR
+Interpret the center position columns (@option{--ccol} in @ref{MakeProfiles
+catalog}) in image or WCS coordinates. This option thus accepts only two
+values: @option{img} and @option{wcs}. It is mandatory when a catalog is
+being used as input.
+
 @item -r
 @itemx --numrandom
 The number of random points used in the central regions of the