gnuastro-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnuastro-commits] master a5576a8: MakeCatalog: better description for t


From: Mohammad Akhlaghi
Subject: [gnuastro-commits] master a5576a8: MakeCatalog: better description for the semi-major/minor options
Date: Thu, 2 May 2019 08:58:53 -0400 (EDT)

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

    MakeCatalog: better description for the semi-major/minor options
    
    Until now, when describing the two `--semimajor' and `--semiminor' options,
    we were just saying "Flux weighted semi-XXXX axis". But this is not exactly
    clear on how it is derived and could cause confusions.
    
    With this commit, we now say "RMS along XXXX axis (in pixels)" to be clear
    and avoid confusion.
    
    This was suggested by Lee Kelvin.
---
 bin/mkcatalog/args.h         |  8 ++++----
 doc/announce-acknowledge.txt |  1 +
 doc/gnuastro.texi            | 28 ++++++++++++++++------------
 3 files changed, 21 insertions(+), 16 deletions(-)

diff --git a/bin/mkcatalog/args.h b/bin/mkcatalog/args.h
index 07a24f9..a45ed91 100644
--- a/bin/mkcatalog/args.h
+++ b/bin/mkcatalog/args.h
@@ -1121,7 +1121,7 @@ struct argp_option program_options[] =
       UI_KEY_SEMIMAJOR,
       0,
       0,
-      "Flux weighted semi-major axis.",
+      "RMS along major axis (in pixels).",
       UI_GROUP_COLUMNS_MORPHOLOGY,
       0,
       GAL_TYPE_INVALID,
@@ -1135,7 +1135,7 @@ struct argp_option program_options[] =
       UI_KEY_SEMIMINOR,
       0,
       0,
-      "Flux weighted semi-minor axis.",
+      "RMS along minor axis (in pixels).",
       UI_GROUP_COLUMNS_MORPHOLOGY,
       0,
       GAL_TYPE_INVALID,
@@ -1177,7 +1177,7 @@ struct argp_option program_options[] =
       UI_KEY_GEOSEMIMAJOR,
       0,
       0,
-      "Geometric semi-major axis.",
+      "RMS along major axis (ignoring value).",
       UI_GROUP_COLUMNS_MORPHOLOGY,
       0,
       GAL_TYPE_INVALID,
@@ -1191,7 +1191,7 @@ struct argp_option program_options[] =
       UI_KEY_GEOSEMIMINOR,
       0,
       0,
-      "Geometric semi-minor axis.",
+      "RMS along minor axis (ignoring value).",
       UI_GROUP_COLUMNS_MORPHOLOGY,
       0,
       GAL_TYPE_INVALID,
diff --git a/doc/announce-acknowledge.txt b/doc/announce-acknowledge.txt
index dff317d..8a0b5cc 100644
--- a/doc/announce-acknowledge.txt
+++ b/doc/announce-acknowledge.txt
@@ -1,6 +1,7 @@
 Alphabetically ordered list to acknowledge in the next release.
 
 Raul Infante-Sainz
+Lee Kelvin
 David Valls-Gabaud
 
 
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index a2e0eaf..b41a0ca 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -19122,7 +19122,7 @@ upper-limit distributions. See The description of 
@option{--upmaskfile} in
 
 
 @node Measuring elliptical parameters, Adding new columns to MakeCatalog, 
Quantifying measurement limits, MakeCatalog
address@hidden Measuring elliptical parameters
+       @subsection Measuring elliptical parameters
 
 The shape or morphology of a target is one of the most commonly desired
 parameters of a target. Here, we will review the derivation of the most
@@ -19134,9 +19134,9 @@ derivations with some added explanations for easier 
reading.
 
 @cindex Moments
 Let's begin with one dimension for simplicity: Assume we have a set of
address@hidden values @mymath{B_i} (keeping the spatial distribution of
-brightness for example), each at position @mymath{x_i}. The simplest
-parameter we can define is the geometric center of the object
address@hidden values @mymath{B_i} (for example showing the spatial
+distribution of a target's brightness), each at position @mymath{x_i}. The
+simplest parameter we can define is the geometric center of the object
 (@mymath{x_g}) (ignoring the brightness values):
 @mymath{x_g=(\sum_ix_i)/N}. @emph{Moments} are defined to incorporate both
 the value (brightness) and position of the data. The first moment can be
@@ -20097,13 +20097,15 @@ column. For example, if a pixel value is blank, it 
won't be counted in
 
 @item -A
 @itemx --semimajor
-The pixel-value weighted semi-major axis of the profile (assuming it is an
-ellipse) in units of pixels. See @ref{Measuring elliptical parameters}.
+The pixel-value weighted root mean square (RMS) along the semi-major axis
+of the profile (assuming it is an ellipse) in units of pixels. See
address@hidden elliptical parameters}.
 
 @item -B
 @itemx --semiminor
-The pixel-value weighted semi-minor axis of the profile (assuming it is an
-ellipse) in units of pixels. See @ref{Measuring elliptical parameters}.
+The pixel-value weighted root mean square (RMS) along the semi-minor axis
+of the profile (assuming it is an ellipse) in units of pixels. See
address@hidden elliptical parameters}.
 
 @item --axisratio
 The pixel-value weighted axis ratio (semi-minor/semi-major) of the object
@@ -20115,12 +20117,14 @@ The pixel-value weighted angle of the semi-major axis 
with the first FITS
 axis in degrees. See @ref{Measuring elliptical parameters}.
 
 @item --geosemimajor
-The geometric (ignoring pixel values) semi-major axis of the profile,
-assuming it is an ellipse.
+The geometric (ignoring pixel values) root mean square (RMS) along the
+semi-major axis of the profile, assuming it is an ellipse, in units of
+pixels.
 
 @item --geosemiminor
-The geometric (ignoring pixel values) semi-minor axis of the profile,
-assuming it is an ellipse.
+The geometric (ignoring pixel values) root mean square (RMS) along the
+semi-minor axis of the profile, assuming it is an ellipse, in units of
+pixels.
 
 @item --geoaxisratio
 The geometric (ignoring pixel values) axis ratio of the profile, assuming



reply via email to

[Prev in Thread] Current Thread [Next in Thread]