[gnuastro-commits] master 3ee6d9e: Book: added note on Query's --overlapwith and images with bad WCS

[Mohammad Akhlaghi]

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

    Book: added note on Query's --overlapwith and images with bad WCS
    
    Until now, there was no mention of WCS problems in the Query program's
    '--overlapwith' option (in particular that the reference point isn't within
    the image when there is distortion).
    
    So with this commit, an explanation has been added to warn the users about
    such scenarios. Later, we should add some checks for this.
---
 doc/gnuastro.texi | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 4a33e0b..62cb9d2 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -10255,6 +10255,9 @@ Based on the image's WCS, the area it covers is 
estimated and values to the @opt
 Hence this option cannot be used with @code{--center}, @code{--width} or 
@code{--radius}.
 Also, since it internally generates the query, it can't be used with 
@code{--query}.
 
+Note that if the image has WCS distortions and the reference point for the WCS 
is not within the image, the WCS will not be well-defined.
+Therefore the resulting catalog may not overlap, or correspond to a 
larger/small area in the sky.
+
 @item -C FLT,FLT
 @itemx --center=FLT,FLT
 The center to use for the automatically generated query (not compatible with 
@option{--query}).