[gnuastro-commits] master 17cec09: Book: added missing argument on gal_wcs_create

[Mohammad Akhlaghi]

branch: master
commit 17cec095a09053f0974126b5bb15232cde431b01
Author: Natáli D. Anzanello <natali.anzanello@ufrgs.br>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: added missing argument on gal_wcs_create
    
    Until now, the 'gal_wcs_create' function from the wcs library was missing
    the 'linearmatrix' argument.
    
    With this commit, the 'linearmatrix' argument is now documented.
---
 doc/gnuastro.texi | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index c3d4ede..0e3525a 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -26788,11 +26788,13 @@ Also put the number of coordinate representations 
found into the space that @cod
 Please see @code{gal_wcs_read_fitsptr} for more.
 @end deftypefun
 
-@deftypefun {struct wcsprm *} gal_wcs_create (double @code{*crpix}, double 
@code{*crval}, double @code{*cdelt}, double @code{*pc}, char @code{**cunit}, 
char @code{**ctype}, size_t @code{ndim})
+@deftypefun {struct wcsprm *} gal_wcs_create (double @code{*crpix}, double 
@code{*crval}, double @code{*cdelt}, double @code{*pc}, char @code{**cunit}, 
char @code{**ctype}, size_t @code{ndim}, int @code{linearmatrix})
 Given all the most common standard components of the WCS standard, construct a 
@code{struct wcsprm}, initialize and set it for future processing.
 See the FITS WCS standard for more on these keywords.
 All the arrays must have @code{ndim} elements with them except for @code{pc} 
which should have @code{ndim*ndim} elements (a square matrix).
 Also, @code{cunit} and @code{ctype} are arrays of strings.
+If @code{GAL_WCS_LINEAR_MATRIX_CD} is passed to @code{linearmatrix} then the 
output WCS structure will have a CD matrix (even though you have given a PC and 
CDELT matrix as input to this function).
+Otherwise, the output will have a PC and CDELT matrix (which is the 
recommended format by WCSLIB).
 @end deftypefun
 
 @deftypefun {char *} gal_wcs_dimension_name (struct wcsprm @code{*wcs}, size_t 
@code{dimension})