[gnuastro-commits] master f61bf049 1/3: Book: description for new gal_blank_flag_not opeator of last commit

[Mohammad Akhlaghi]

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

    Book: description for new gal_blank_flag_not opeator of last commit
    
    Until now (in the previous commit), a new 'gal_blank_flag_not' operator was
    added to the library, but I forgot to document it in that commit!
    
    With this commit, this missing documentation problem has been fixed as soon
    as I noticed it.
---
 NEWS              |  2 ++
 doc/gnuastro.texi | 18 +++++++++---------
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/NEWS b/NEWS
index c0dcd2cd..c914bf91 100644
--- a/NEWS
+++ b/NEWS
@@ -149,6 +149,8 @@ See the end of the file for license conditions.
    - GAL_ARITHMETIC_OP_BOX_VERTICES_ON_SPHERE: calculate the coordinates of
      vertices of a rectable on a sphere from its center and width/height.
    - gal_binary_number_neighbors: num. non-zero neighbors of non-zero pixels.
+   - gal_blank_flag_not: binary dataset with 1 for those input pixels that
+     were blank.
    - gal_data_alloc_empty: Allocate an empty dataset with a given number of
      dimensions.
    - gal_list_f64_to_data: convert list of float64s to a 'gal_data_t'
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 60e19c3a..d920104b 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -32152,18 +32152,18 @@ input->flag &= ~GAL_DATA_FLAG_BLANK_CH;
 @end deftypefun
 
 @deftypefun size_t gal_blank_number (gal_data_t @code{*input}, int 
@code{updateflag})
-Return the number of blank elements in @code{input}. If
-@code{updateflag!=0}, then the dataset blank keyword flags will be
-updated. See the description of @code{gal_blank_present} (above) for more
-on these flags. If @code{input==NULL}, then this function will return
-@code{GAL_BLANK_SIZE_T}.
+Return the number of blank elements in @code{input}.
+If @code{updateflag!=0}, then the dataset blank keyword flags will beupdated.
+See the description of @code{gal_blank_present} (above) for more on these 
flags.
+If @code{input==NULL}, then this function will return @code{GAL_BLANK_SIZE_T}.
 @end deftypefun
 
-
 @deftypefun {gal_data_t *} gal_blank_flag (gal_data_t @code{*input})
-Find which elements in an array are blank. So, create a dataset of the
-same size as the input, but with an @code{uint8_t} type that
-has a value of 1 for data that are blank and 0 for those that are not.
+Return a ``flag'' dataset with the same size as the input, but with an 
@code{uint8_t} type that has a value of 1 for data elements that are blank and 
0 for those that are not.
+@end deftypefun
+
+@deftypefun {gal_data_t *} gal_blank_flag_not (gal_data_t @code{*input})
+Return a ``flag'' dataset with the same size as the input, but with an 
@code{uint8_t} type that has a value of 1 for data elements that are @emph{not} 
blank and 0 for those that are blank.
 @end deftypefun
 
 @deftypefun void gal_blank_flag_apply (gal_data_t @code{*input}, gal_data_t 
@code{*flag})