B q\U @sddlZddlmZddlmZmZmZm Z ddgZ ddddd d d d d ddg Z ddZ ddZ d&ddZe ggZeggZGdddZeZGdddZddZd'ddZddZdd Zd(dd ZddZd d Zd!d"Zd)d$d Zd*d%d ZdS)+N)units)WCSWCSSUB_LONGITUDEWCSSUB_LATITUDEWCSSUB_CELESTIALwcs_to_celestial_framecelestial_frame_to_wcsadd_stokes_axis_to_wcsproj_plane_pixel_scalesproj_plane_pixel_areais_proj_plane_distortednon_celestial_pixel_scalesskycoord_to_pixelpixel_to_skycoordcustom_wcs_to_frame_mappingscustom_frame_to_wcs_mappingscCsHddt|jjD}||d||}d|jj|<d|jj|<|S)a Add a new Stokes axis that is uncorrelated with any other axes. Parameters ---------- wcs : `~astropy.wcs.WCS` The WCS to add to add_before_ind : int Index of the WCS to insert the new Stokes axis in front of. To add at the end, do add_before_ind = wcs.wcs.naxis The beginning is at position 0. Returns ------- A new `~astropy.wcs.WCS` instance with an additional axis cSsg|] }|dqS)r).0irr0lib/python3.7/site-packages/astropy/wcs/utils.py %sz*add_stokes_axis_to_wcs..rZSTOKES)rangewcsnaxisinsertsubctypeZcname)rZadd_before_indZindsZnewwcsrrrr s     c Csddlm}m}m}m}m}m}ddlm}|j j dksD|j j dkrHdS|j j }t |j jrdd} n|j j} |j j|j j dd} |j j|j j dd} |dkr| dkr| dkr| dkrd }n| d krd }nd }|d kr| dk r|| d d} || d} n|dkr(| dk r|| d d} || d} n|d krT| dk rH|| dd} || d} n\|d krf|} nJ| dkr| dkr|} n.| dkr| dkr||j jpdd} nd} | S)Nr)FK4 FK4NoETermsFK5ICRSITRSGalactic)TimezRA--zDEC-r!g@rr byear)format)equinoxzFK4-NO-EjyearGLONGLATTLONTLAT)obstime)astropy.coordinatesrrr r!r"r#Z astropy.timer$rZlnglatradesysnpZisnanr*rdateobs) rrrr r!r"r#r$r3r*xcoordycoordframerrr_wcs_to_celestial_frame_builtin-sH             r9TANc Csddlm}m}m}m}m}m}m}tdd} t ||rd} d} t ||rTd| j _ qt ||rtd| j _ |j j | j _ qt ||rd | j _ |j j | j _ qt ||rd | j _ |j j| j _ qdSnBt ||rd } d } n.t ||rd } d} d| j _ |jjj| j _ndS| d|| d|g| j _| S)Nr)BaseRADecFramerrr r!r"r#)rzRA--zDEC-r!zFK4-NO-Err r,r-r.r/r"-)r1r;rrr r!r"r#r isinstancerr3r*r(r+r0ZutcZisotr5r) r8 projectionr;rrr r!r"r#rr6r7rrr_celestial_frame_to_wcs_builtinds8$         r@c@s(eZdZgfddZddZddZdS)rcCst|dr|g}t|dS)N__call__)hasattrWCS_FRAME_MAPPINGSappend)selfmappingsrrr__init__s z%custom_wcs_to_frame_mappings.__init__cCsdS)Nr)rErrr __enter__sz&custom_wcs_to_frame_mappings.__enter__cCs tdS)N)rCpop)rEtypevaluetbrrr__exit__sz%custom_wcs_to_frame_mappings.__exit__N)__name__ __module__ __qualname__rGrHrMrrrrrs c@s(eZdZgfddZddZddZdS)rcCst|dr|g}t|dS)NrA)rBFRAME_WCS_MAPPINGSrD)rErFrrrrGs z%custom_frame_to_wcs_mappings.__init__cCsdS)Nr)rErrrrHsz&custom_frame_to_wcs_mappings.__enter__cCs tdS)N)rQrI)rErJrKrLrrrrMsz%custom_frame_to_wcs_mappings.__exit__N)rNrOrPrGrHrMrrrrrs cCs<x.tD]&}x |D]}||}|dk r|SqWqWtddS)a For a given WCS, return the coordinate frame that matches the celestial component of the WCS. Parameters ---------- wcs : :class:`~astropy.wcs.WCS` instance The WCS to find the frame for Returns ------- frame : :class:`~astropy.coordinates.baseframe.BaseCoordinateFrame` subclass instance An instance of a :class:`~astropy.coordinates.baseframe.BaseCoordinateFrame` subclass instance that best matches the specified WCS. Notes ----- To extend this function to frames not defined in astropy.coordinates, you can write your own function which should take a :class:`~astropy.wcs.WCS` instance and should return either an instance of a frame, or `None` if no matching frame was found. You can register this function temporarily with:: >>> from astropy.wcs.utils import wcs_to_celestial_frame, custom_wcs_to_frame_mappings >>> with custom_wcs_to_frame_mappings(my_function): ... wcs_to_celestial_frame(...) NzMCould not determine celestial frame corresponding to the specified WCS object)rC ValueError)r mapping_setfuncr8rrrrs    cCs@x2tD]*}x$|D]}|||d}|dk r|SqWqWtddS)a For a given coordinate frame, return the corresponding WCS object. Note that the returned WCS object has only the elements corresponding to coordinate frames set (e.g. ctype, equinox, radesys). Parameters ---------- frame : :class:`~astropy.coordinates.baseframe.BaseCoordinateFrame` subclass instance An instance of a :class:`~astropy.coordinates.baseframe.BaseCoordinateFrame` subclass instance for which to find the WCS projection : str Projection code to use in ctype, if applicable Returns ------- wcs : :class:`~astropy.wcs.WCS` instance The corresponding WCS object Examples -------- :: >>> from astropy.wcs.utils import celestial_frame_to_wcs >>> from astropy.coordinates import FK5 >>> frame = FK5(equinox='J2010') >>> wcs = celestial_frame_to_wcs(frame) >>> wcs.to_header() WCSAXES = 2 / Number of coordinate axes CRPIX1 = 0.0 / Pixel coordinate of reference point CRPIX2 = 0.0 / Pixel coordinate of reference point CDELT1 = 1.0 / [deg] Coordinate increment at reference point CDELT2 = 1.0 / [deg] Coordinate increment at reference point CUNIT1 = 'deg' / Units of coordinate increment and value CUNIT2 = 'deg' / Units of coordinate increment and value CTYPE1 = 'RA---TAN' / Right ascension, gnomonic projection CTYPE2 = 'DEC--TAN' / Declination, gnomonic projection CRVAL1 = 0.0 / [deg] Coordinate value at reference point CRVAL2 = 0.0 / [deg] Coordinate value at reference point LONPOLE = 180.0 / [deg] Native longitude of celestial pole LATPOLE = 0.0 / [deg] Native latitude of celestial pole RADESYS = 'FK5' / Equatorial coordinate system EQUINOX = 2010.0 / [yr] Equinox of equatorial coordinates Notes ----- To extend this function to frames not defined in astropy.coordinates, you can write your own function which should take a :class:`~astropy.coordinates.baseframe.BaseCoordinateFrame` subclass instance and a projection (given as a string) and should return either a WCS instance, or `None` if the WCS could not be determined. You can register this function temporarily with:: >>> from astropy.wcs.utils import celestial_frame_to_wcs, custom_frame_to_wcs_mappings >>> with custom_frame_to_wcs_mappings(my_function): ... celestial_frame_to_wcs(...) )r?NzHCould not determine WCS corresponding to the specified coordinate frame.)rQrR)r8r?rSrTrrrrr s >    cCst|jdjdtdS)a1 For a WCS returns pixel scales along each axis of the image pixel at the ``CRPIX`` location once it is projected onto the "plane of intermediate world coordinates" as defined in `Greisen & Calabretta 2002, A&A, 395, 1061 `_. .. note:: This function is concerned **only** about the transformation "image plane"->"projection plane" and **not** about the transformation "celestial sphere"->"projection plane"->"image plane". Therefore, this function ignores distortions arising due to non-linear nature of most projections. .. note:: In order to compute the scales corresponding to celestial axes only, make sure that the input `~astropy.wcs.WCS` object contains celestial axes only, e.g., by passing in the `~astropy.wcs.WCS.celestial` WCS object. Parameters ---------- wcs : `~astropy.wcs.WCS` A world coordinate system object. Returns ------- scale : `~numpy.ndarray` A vector (`~numpy.ndarray`) of projection plane increments corresponding to each pixel side (axis). The units of the returned results are the same as the units of `~astropy.wcs.Wcsprm.cdelt`, `~astropy.wcs.Wcsprm.crval`, and `~astropy.wcs.Wcsprm.cd` for the celestial WCS and can be obtained by inquiring the value of `~astropy.wcs.Wcsprm.cunit` property of the input `~astropy.wcs.WCS` WCS object. See Also -------- astropy.wcs.utils.proj_plane_pixel_area r<r)ZaxisZdtype)r4Zsqrtpixel_scale_matrixsumfloat)rrrrr s)cCs,|jj}|jdkrtdttj|S)aZ For a **celestial** WCS (see `astropy.wcs.WCS.celestial`) returns pixel area of the image pixel at the ``CRPIX`` location once it is projected onto the "plane of intermediate world coordinates" as defined in `Greisen & Calabretta 2002, A&A, 395, 1061 `_. .. note:: This function is concerned **only** about the transformation "image plane"->"projection plane" and **not** about the transformation "celestial sphere"->"projection plane"->"image plane". Therefore, this function ignores distortions arising due to non-linear nature of most projections. .. note:: In order to compute the area of pixels corresponding to celestial axes only, this function uses the `~astropy.wcs.WCS.celestial` WCS object of the input ``wcs``. This is different from the `~astropy.wcs.utils.proj_plane_pixel_scales` function that computes the scales for the axes of the input WCS itself. Parameters ---------- wcs : `~astropy.wcs.WCS` A world coordinate system object. Returns ------- area : float Area (in the projection plane) of the pixel at ``CRPIX`` location. The units of the returned result are the same as the units of the `~astropy.wcs.Wcsprm.cdelt`, `~astropy.wcs.Wcsprm.crval`, and `~astropy.wcs.Wcsprm.cd` for the celestial WCS and can be obtained by inquiring the value of `~astropy.wcs.Wcsprm.cunit` property of the `~astropy.wcs.WCS.celestial` WCS object. Raises ------ ValueError Pixel area is defined only for 2D pixels. Most likely the `~astropy.wcs.Wcsprm.cd` matrix of the `~astropy.wcs.WCS.celestial` WCS is not a square matrix of second order. Notes ----- Depending on the application, square root of the pixel area can be used to represent a single pixel scale of an equivalent square pixel whose area is equal to the area of a generally non-square pixel. See Also -------- astropy.wcs.utils.proj_plane_pixel_scales )r<r<z)Pixel area is defined only for 2D pixels.) celestialrUshaperRr4abslinalgdet)rZpsmrrrr Hs7 h㈵>cCs|j}t|j| pt|S)a For a WCS returns `False` if square image (detector) pixels stay square when projected onto the "plane of intermediate world coordinates" as defined in `Greisen & Calabretta 2002, A&A, 395, 1061 `_. It will return `True` if transformation from image (detector) coordinates to the focal plane coordinates is non-orthogonal or if WCS contains non-linear (e.g., SIP) distortions. .. note:: Since this function is concerned **only** about the transformation "image plane"->"focal plane" and **not** about the transformation "celestial sphere"->"focal plane"->"image plane", this function ignores distortions arising due to non-linear nature of most projections. Let's denote by *C* either the original or the reconstructed (from ``PC`` and ``CDELT``) CD matrix. `is_proj_plane_distorted` verifies that the transformation from image (detector) coordinates to the focal plane coordinates is orthogonal using the following check: .. math:: \left \| \frac{C \cdot C^{\mathrm{T}}} {| det(C)|} - I \right \|_{\mathrm{max}} < \epsilon . Parameters ---------- wcs : `~astropy.wcs.WCS` World coordinate system object maxerr : float, optional Accuracy to which the CD matrix, **normalized** such that :math:`|det(CD)|=1`, should be close to being an orthogonal matrix as described in the above equation (see :math:`\epsilon`). Returns ------- distorted : bool Returns `True` if focal (projection) plane is distorted and `False` otherwise. )rX_is_cd_orthogonalrU_has_distortion)rmaxerrZcwcsrrrr s-c Cs|j}t|dkr"|d|dks*tdttj|}|dkrLtdt||j|}t t|t |d}||kS)Nr<rrz-CD (or PC) matrix must be a 2D square matrix.gzCD (or PC) matrix is singular.) rYlenrRr4rZr[r\dotTZamaxeye)Zcdr`rYZpixareaIZcd_unitary_errrrrr^sr^cCsV|jrtd|j}ttdtj|j|drJtt |t j StddS)aM Calculate the pixel scale along each axis of a non-celestial WCS, for example one with mixed spectral and spatial axes. Parameters ---------- inwcs : `~astropy.wcs.WCS` The world coordinate system object. Returns ------- scale : `numpy.ndarray` The pixel scale along each axis. z4WCS is celestial, use celestial_pixel_scales insteadrrz8WCS is rotated, cannot determine consistent pixel scalesN) Z is_celestialrRrUr4ZallcloseextractrdrYrZZdiagonaluZdeg)ZinwcsZpccdrrrrs  cstfdddDS)zD `True` if contains any SIP or image distortion components. c3s|]}t|dk VqdS)N)getattr)rZ dist_attr)rrr sz"_has_distortion..)Zcpdis1Zcpdis2Zdet2im1Zdet2im2Zsip)any)rr)rrr_s r_allc Cst|r|jdkrtd|ttg}|jdkr:tdt|}t|j j d}t|j j d}| |}y |j j |}|j j|}Wn0tk r|jj |}|jj|}YnX|dkr||j|j|\} } n*|dkr||j|j|\} } ntd| | fS) a Convert a set of SkyCoord coordinates into pixels. Parameters ---------- coords : `~astropy.coordinates.SkyCoord` The coordinates to convert. wcs : `~astropy.wcs.WCS` The WCS transformation to use. origin : int Whether to return 0 or 1-based pixel coordinates. mode : 'all' or 'wcs' Whether to do the transformation including distortions (``'all'``) or only including only the core WCS transformation (``'wcs'``). Returns ------- xp, yp : `numpy.ndarray` The pixel coordinates See Also -------- astropy.coordinates.SkyCoord.from_pixel r<z:Can only handle WCS with distortions for 2-dimensional WCSz&WCS should contain celestial componentrrrkrz$mode should be either 'all' or 'wcs')r_rrRrrrrrgUnitrcunitZ transform_todatalontor2AttributeErrorZ sphericalZ all_world2pixrKZ wcs_world2pix) coordsroriginmoder8Zxw_unitZyw_unitror2xpyprrrrs*   cCsddlm}m}|dkr|}t|r6|jdkr6td|ttg}|jdkrVtdt |}t |j j d} t |j j d} |dkr||||\} } n$|d kr||||\} } ntd | | } | | } || | d } ||| }|S) a Convert a set of pixel coordinates into a `~astropy.coordinates.SkyCoord` coordinate. Parameters ---------- xp, yp : float or `numpy.ndarray` The coordinates to convert. wcs : `~astropy.wcs.WCS` The WCS transformation to use. origin : int Whether to return 0 or 1-based pixel coordinates. mode : 'all' or 'wcs' Whether to do the transformation including distortions (``'all'``) or only including only the core WCS transformation (``'wcs'``). cls : class or None The class of object to create. Should be a `~astropy.coordinates.SkyCoord` subclass. If None, defaults to `~astropy.coordinates.SkyCoord`. Returns ------- coords : Whatever ``cls`` is (a subclass of `~astropy.coordinates.SkyCoord`) The celestial coordinates See Also -------- astropy.coordinates.SkyCoord.from_pixel r)SkyCoordUnitSphericalRepresentationNr<z:Can only handle WCS with distortions for 2-dimensional WCSz&WCS should contain celestial componentrrkrz$mode should be either 'all' or 'wcs')ror2)r1rwrxr_rrRrrrrrgrlrrmZ all_pix2worldZ wcs_pix2worldZ realize_frame)rurvrrsrtclsrwrxr8Zlon_unitZlat_unitror2rnrrrrrr2s*   )r:)r:)r])rrk)rrkN)Znumpyr4ZastropyrrgrrrrrZ__doctest_skip____all__r r9r@rCrQrZcustom_frame_mappingsrrr r r r r^rr_rrrrrrs6 7 ) & G,= 2 D