wcslib (8.2.2)

(root)/
include/
wcslib-8.2.2/
wcs.inc
*=======================================================================
*
* WCSLIB 8.2 - an implementation of the FITS WCS standard.
* Copyright (C) 1995-2023, Mark Calabretta
*
* This file is part of WCSLIB.
*
* WCSLIB is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WCSLIB is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with WCSLIB.  If not, see http://www.gnu.org/licenses.
*
* Author: Mark Calabretta, Australia Telescope National Facility, CSIRO.
* http://www.atnf.csiro.au/people/Mark.Calabretta
* $Id: wcs.inc,v 8.2.1.1 2023/11/16 10:05:58 mcalabre Exp mcalabre $
*=======================================================================

*     Functions.
      EXTERNAL  WCSPUT,  WCSPTC,  WCSPTD,  WCSPTI,
     :          WCSGET,  WCSGTC,  WCSGTD,  WCSGTI,
     :          WCSNPV,  WCSNPS,  WCSINI,  WCSINIT, WCSSUB, WCSCOMPARE,
     :          WCSFREE, WCSTRIM, WCSSIZE, AUXSIZE, WCSPRT, WCSPERR,
     :          WCSBCHK, WCSSET,  WCSP2S,  WCSS2P,  WCSMIX,
     :          WCSCCS,  WCSSPTR, WCSCOPY

      INTEGER   WCSPUT,  WCSPTC,  WCSPTD,  WCSPTI,
     :          WCSGET,  WCSGTC,  WCSGTD,  WCSGTI,
     :          WCSNPV,  WCSNPS,  WCSINI,  WCSINIT, WCSSUB,  WCSCOMPARE,
     :          WCSFREE, WCSTRIM, WCSSIZE, AUXSIZE, WCSPRT, WCSPERR,
     :          WCSBCHK, WCSSET,  WCSP2S,  WCSS2P,  WCSMIX,
     :          WCSCCS,  WCSSPTR, WCSCOPY

*     Note that the Fortran API differs from that of the C function.
      EXTERNAL  WCSLIB_VERSION
      CHARACTER WCSLIB_VERSION*8


*     Length of the WCSPRM data structure (INTEGER array) on 64-bit
*     machines.  Only needs to be 624 on 32-bit machines.
      INTEGER   WCSLEN
      PARAMETER (WCSLEN = 690)

*     Codes for WCS data structure elements used by WCSPUT and WCSGET.
      INTEGER   WCS_FLAG, WCS_NAXIS, WCS_CRPIX, WCS_PC, WCS_CDELT,
     :          WCS_CRVAL, WCS_CUNIT, WCS_CTYPE, WCS_LONPOLE,
     :          WCS_LATPOLE, WCS_RESTFRQ, WCS_RESTWAV, WCS_NPV,
     :          WCS_NPVMAX, WCS_PV, WCS_NPS, WCS_NPSMAX, WCS_PS, WCS_CD,
     :          WCS_CROTA, WCS_ALTLIN, WCS_VELREF, WCS_ALT, WCS_COLNUM,
     :          WCS_COLAX, WCS_CNAME,  WCS_CRDER, WCS_CSYER, WCS_CZPHS,
     :          WCS_CPERI, WCS_WCSNAME, WCS_TIMESYS, WCS_TREFPOS,
     :          WCS_TREFDIR, WCS_PLEPHEM, WCS_TIMEUNIT, WCS_DATEREF,
     :          WCS_MJDREF, WCS_TIMEOFFS, WCS_DATEOBS, WCS_DATEBEG,
     :          WCS_DATEAVG, WCS_DATEEND, WCS_MJDOBS, WCS_MJDBEG,
     :          WCS_MJDAVG, WCS_MJDEND, WCS_JEPOCH, WCS_BEPOCH,
     :          WCS_TSTART, WCS_TSTOP, WCS_XPOSURE, WCS_TELAPSE,
     :          WCS_TIMSYER, WCS_TIMRDER, WCS_TIMEDEL, WCS_TIMEPIXR,
     :          WCS_OBSGEO, WCS_OBSORBIT, WCS_RADESYS, WCS_EQUINOX,
     :          WCS_SPECSYS, WCS_SSYSOBS, WCS_VELOSYS, WCS_ZSOURCE,
     :          WCS_SSYSSRC, WCS_VELANGL, WCS_RSUN_REF, WCS_DSUN_OBS,
     :          WCS_CRLN_OBS, WCS_HGLN_OBS, WCS_HGLT_OBS,
     :          WCS_A_RADIUS, WCS_B_RADIUS, WCS_C_RADIUS,
     :          WCS_BLON_OBS, WCS_BLAT_OBS, WCS_BDIS_OBS

      PARAMETER (WCS_FLAG     = 100)
      PARAMETER (WCS_NAXIS    = 101)
      PARAMETER (WCS_CRPIX    = 102)
      PARAMETER (WCS_PC       = 103)
      PARAMETER (WCS_CDELT    = 104)
      PARAMETER (WCS_CRVAL    = 105)
      PARAMETER (WCS_CUNIT    = 106)
      PARAMETER (WCS_CTYPE    = 107)
      PARAMETER (WCS_LONPOLE  = 108)
      PARAMETER (WCS_LATPOLE  = 109)
      PARAMETER (WCS_RESTFRQ  = 110)
      PARAMETER (WCS_RESTWAV  = 111)
      PARAMETER (WCS_NPV      = 112)
      PARAMETER (WCS_NPVMAX   = 113)
      PARAMETER (WCS_PV       = 114)
      PARAMETER (WCS_NPS      = 115)
      PARAMETER (WCS_NPSMAX   = 116)
      PARAMETER (WCS_PS       = 117)
      PARAMETER (WCS_CD       = 118)
      PARAMETER (WCS_CROTA    = 119)
      PARAMETER (WCS_ALTLIN   = 120)
      PARAMETER (WCS_VELREF   = 121)

      PARAMETER (WCS_ALT      = 122)
      PARAMETER (WCS_COLNUM   = 123)
      PARAMETER (WCS_COLAX    = 124)

      PARAMETER (WCS_CNAME    = 125)
      PARAMETER (WCS_CRDER    = 126)
      PARAMETER (WCS_CSYER    = 127)
      PARAMETER (WCS_CZPHS    = 128)
      PARAMETER (WCS_CPERI    = 129)

      PARAMETER (WCS_WCSNAME  = 130)

      PARAMETER (WCS_TIMESYS  = 131)
      PARAMETER (WCS_TREFPOS  = 132)
      PARAMETER (WCS_TREFDIR  = 133)
      PARAMETER (WCS_PLEPHEM  = 134)
      PARAMETER (WCS_TIMEUNIT = 135)
      PARAMETER (WCS_DATEREF  = 136)
      PARAMETER (WCS_MJDREF   = 137)
      PARAMETER (WCS_TIMEOFFS = 138)

      PARAMETER (WCS_DATEOBS  = 139)
      PARAMETER (WCS_DATEBEG  = 140)
      PARAMETER (WCS_DATEAVG  = 141)
      PARAMETER (WCS_DATEEND  = 142)
      PARAMETER (WCS_MJDOBS   = 143)
      PARAMETER (WCS_MJDBEG   = 144)
      PARAMETER (WCS_MJDAVG   = 145)
      PARAMETER (WCS_MJDEND   = 146)
      PARAMETER (WCS_JEPOCH   = 147)
      PARAMETER (WCS_BEPOCH   = 148)
      PARAMETER (WCS_TSTART   = 149)
      PARAMETER (WCS_TSTOP    = 150)
      PARAMETER (WCS_XPOSURE  = 151)
      PARAMETER (WCS_TELAPSE  = 152)

      PARAMETER (WCS_TIMSYER  = 153)
      PARAMETER (WCS_TIMRDER  = 154)
      PARAMETER (WCS_TIMEDEL  = 155)
      PARAMETER (WCS_TIMEPIXR = 156)

      PARAMETER (WCS_OBSGEO   = 157)
      PARAMETER (WCS_OBSORBIT = 158)
      PARAMETER (WCS_RADESYS  = 159)
      PARAMETER (WCS_EQUINOX  = 160)
      PARAMETER (WCS_SPECSYS  = 161)
      PARAMETER (WCS_SSYSOBS  = 162)
      PARAMETER (WCS_VELOSYS  = 163)
      PARAMETER (WCS_ZSOURCE  = 164)
      PARAMETER (WCS_SSYSSRC  = 165)
      PARAMETER (WCS_VELANGL  = 166)

      PARAMETER (WCS_RSUN_REF = 167)
      PARAMETER (WCS_DSUN_OBS = 168)
      PARAMETER (WCS_CRLN_OBS = 169)
      PARAMETER (WCS_HGLN_OBS = 170)
      PARAMETER (WCS_HGLT_OBS = 171)
      PARAMETER (WCS_A_RADIUS = 172)
      PARAMETER (WCS_B_RADIUS = 173)
      PARAMETER (WCS_C_RADIUS = 174)
      PARAMETER (WCS_BLON_OBS = 175)
      PARAMETER (WCS_BLAT_OBS = 176)
      PARAMETER (WCS_BDIS_OBS = 177)

*     Codes for WCS data structure elements used by WCSGET (only).
      INTEGER   WCS_NTAB, WCS_NWTB, WCS_TAB, WCS_WTB, WCS_LNGTYP,
     :          WCS_LATTYP, WCS_LNG, WCS_LAT, WCS_SPEC, WCS_TIME,
     :          WCS_CUBEFACE, WCS_TYPES, WCS_LIN, WCS_CEL, WCS_SPC,
     :          WCS_ERR

      PARAMETER (WCS_NTAB     = 200)
      PARAMETER (WCS_NWTB     = 201)
      PARAMETER (WCS_TAB      = 202)
      PARAMETER (WCS_WTB      = 203)
      PARAMETER (WCS_LNGTYP   = 204)
      PARAMETER (WCS_LATTYP   = 205)
      PARAMETER (WCS_LNG      = 206)
      PARAMETER (WCS_LAT      = 207)
      PARAMETER (WCS_SPEC     = 208)
      PARAMETER (WCS_TIME     = 209)
      PARAMETER (WCS_CUBEFACE = 210)
      PARAMETER (WCS_TYPES    = 211)
      PARAMETER (WCS_LIN      = 212)
      PARAMETER (WCS_CEL      = 213)
      PARAMETER (WCS_SPC      = 214)
      PARAMETER (WCS_ERR      = 215)

*     Flag bits for WCSSUB's AXES argument.
      INTEGER   WCSSUB_LONGITUDE, WCSSUB_LATITUDE, WCSSUB_CUBEFACE,
     :          WCSSUB_CELESTIAL, WCSSUB_SPECTRAL, WCSSUB_STOKES

      PARAMETER (WCSSUB_LONGITUDE = 4096 +  1)
      PARAMETER (WCSSUB_LATITUDE  = 4096 +  2)
      PARAMETER (WCSSUB_CUBEFACE  = 4096 +  4)
      PARAMETER (WCSSUB_CELESTIAL = 4096 +  7)
      PARAMETER (WCSSUB_SPECTRAL  = 4096 +  8)
      PARAMETER (WCSSUB_STOKES    = 4096 + 16)

*     Flag bits for WCSCOMPARE's CMP argument.
      INTEGER WCSCOMPARE_ANCILLARY, WCSCOMPARE_TILING, WCSCOMPARE_CRPIX

      PARAMETER (WCSCOMPARE_ANCILLARY = 1)
      PARAMETER (WCSCOMPARE_TILING    = 2)
      PARAMETER (WCSCOMPARE_CRPIX     = 4)

*     Error codes and messages.
      INTEGER   WCSERR_SUCCESS, WCSERR_NULL_POINTER, WCSERR_MEMORY,
     :          WCSERR_SINGULAR_MTX, WCSERR_BAD_CTYPE, WCSERR_BAD_PARAM,
     :          WCSERR_BAD_COORD_TRANS, WCSERR_ILL_COORD_TRANS,
     :          WCSERR_BAD_PIX, WCSERR_BAD_WORLD,
     :          WCSERR_BAD_WORLD_COORD, WCSERR_NO_SOLUTION,
     :          WCSERR_BAD_SUBIMAGE, WCSERR_NON_SEPARABLE

      PARAMETER (WCSERR_SUCCESS         =  0)
      PARAMETER (WCSERR_NULL_POINTER    =  1)
      PARAMETER (WCSERR_MEMORY          =  2)
      PARAMETER (WCSERR_SINGULAR_MTX    =  3)
      PARAMETER (WCSERR_BAD_CTYPE       =  4)
      PARAMETER (WCSERR_BAD_PARAM       =  5)
      PARAMETER (WCSERR_BAD_COORD_TRANS =  6)
      PARAMETER (WCSERR_ILL_COORD_TRANS =  7)
      PARAMETER (WCSERR_BAD_PIX         =  8)
      PARAMETER (WCSERR_BAD_WORLD       =  9)
      PARAMETER (WCSERR_BAD_WORLD_COORD = 10)
      PARAMETER (WCSERR_NO_SOLUTION     = 11)
      PARAMETER (WCSERR_BAD_SUBIMAGE    = 12)
      PARAMETER (WCSERR_NON_SEPARABLE   = 13)

      CHARACTER WCS_ERRMSG(0:13)*80
      COMMON /WCS_DATA/ WCS_ERRMSG