a 1$ec@sdZddlZddlZddlZddlZddlmZmZmZm Z ddl m Z m Z m Z mZmZmZmZmZmZmZmZmZddlmZmZmZmZmZmZddlmZddl m!Z!m"Z"m#Z#ddl$m%Z%m&Z&dd l'm(Z(dd l)m*Z*e+d ej,Z-Gd d d ej.Z/d2e0e1e2dddZ3e2e2dddZ4e2e2dddZ5e2e e2e6fdddZ7e e2e6fdddZ8ee1dddZ9Gd d!d!Z:Gd"d#d#e:Z;Gd$d%d%e;ZGd*d+d+e;Z?Gd,d-d-e;Z@Gd.d/d/e;ZAGd0d1d1e;ZBdS)3zx This module interfaces with PROJ to produce a pythonic interface to the coordinate reference system (CRS) information. N)AnyCallableOptionalUnion) _CRS AreaOfUseAuthorityMatchInfoAxisCoordinateOperationCoordinateSystemDatum Ellipsoid PrimeMeridian_load_proj_jsonis_projis_wkt)!_GEOGRAPHIC_GRID_MAPPING_NAME_MAP_GRID_MAPPING_NAME_MAP)_INVERSE_GEOGRAPHIC_GRID_MAPPING_NAME_MAP_INVERSE_GRID_MAPPING_NAME_MAP_horizontal_datum_from_params_try_list_if_string)ToWGS84Transformation) Cartesian2DCSEllipsoidal2DCS VerticalCS) ProjVersion WktVersion)CRSError)Geoda9 \+ # parameter starts with '+' character (?P\w+) # capture parameter name \=? # match both key only and key-value parameters (?P\S+)? # capture all characters up to next space (None if no value) \s*? # consume remaining whitespace, if any cs eZdZdZfddZZS)CRSLocalz Threading local instance for cython CRS class. For more details, see: https://github.com/pyproj4/pyproj/issues/782 csd|_tdSN)crssuper__init__self __class__J/var/www/html/django/DPS/env/lib/python3.9/site-packages/pyproj/crs/crs.pyr$<szCRSLocal.__init__)__name__ __module__ __qualname____doc__r$ __classcell__r)r)r'r*r 4sr T) projparams allow_jsonreturncCst|tstdd|vr0d|vr0|r0t|Sg}|D]t\}}t|ttfrfddd|D}|duszt |dkr| d|qLz&_prepare_from_dict..True+False= ) isinstancedictrjsondumpsitemslisttuplejoinr6append_prepare_from_string)r0r1Zpjargskeyvaluer)r)r*_prepare_from_dictAs   rL in_crs_stringr2cCstdd|}d}||sjg}d}|D].}|sT||rT|d|d}q0||q0d|}d|vrd |vr|d 7}n|d 7}|d d  }|drt j dt dd|S)Nz [\s+]?=[\s+]?r>)+initz+projr4r3FrTr?ztype=crsr<z +type=crsz type=crsz +init=EPSGz +init=epsg)rOr4z'+init=:' syntax is deprecated. ':' is the preferred initialization method. When making the change, be mindful of axis order changes: https://pyproj4.github.io/pyproj/stable/gotchas.html#axis-order-changes-in-proj-6) stacklevel) resublstrip startswithsplitinsertrHrGreplacestripwarningswarn FutureWarning)rNZstarting_paramsZkvpairsZfirst_item_insertedZkvpairr)r)r*_prepare_from_proj_stringWs.        r]c Cst|tstd|s$td|d|vrztj|dd}Wn.tyl}ztd|WYd}~n d}~00|sztdt|}nt|rt|}|S)NzCRS input is not a stringz CRS string is empty or invalid: {F)strictz'CRS appears to be JSON but is not validzCRS is empty JSON) r@r6rrBloads ValueErrorrLrr])rNcrs_dicterrr)r)r*rI}s   rI auth_name auth_codecCs|d|S)N:r)rdr)r)r*_prepare_from_authoritysrhrfcCs td|S)NZEPSG)rhrir)r)r*_prepare_from_epsgsrj)rfr2cCs@t|trdSt|tr$|r$dSt|dr<|jdkrZ'ee!ddd?d@Z(eee ddAdBZ)ee ddCdDZ*ee ddEdFZ+ee!e,ddGdHZ-eee.ddIdJZ/eee0ddKdLZ1eee2ddMdNZ3eee4ddOdPZ5eee6ddQdRZ7eee8ddSdTZ9ee ddUdVZ:ee ddWdXZ;ejd*dfe ee feeee dYdZd[Ze?j@fe e?e fe dbdcddZAde ee dfdgdhZBdee e didjdkZCdee e e!eDdldmdnZEdee ddodpdqZFdee ddodrdsZGeeddtduZHeeddvdwZIeeddxdyZJeeddzd{ZKeedd|d}ZLeedd~dZMeedddZNeddZOeed3ddZPee e fdddZQee efdddZRe dddZSe dddZTe dddZUdS)CRSaK A pythonic Coordinate Reference System manager. .. versionadded:: 2.0.0 See: :c:func:`proj_create` The functionality is based on other fantastic projects: * `rasterio `_ # noqa: E501 * `opendatacube `_ # noqa: E501 Attributes ---------- srs: str The string form of the user input used to create the CRS. N)r0r2cKsd}|rt|tr|j}nt|r,t|}nnt|tr@t|}nZt|trTt|}nFt|t t frxt |dkrxt |}n"t |dr|}ntd||rt|dd}td||f}||_t|_t|tr||j_nt|j|j_dS) u Initialize a CRS class instance with: - PROJ string - Dictionary of PROJ parameters - PROJ keyword arguments for parameters - JSON string with PROJ parameters - CRS WKT string - An authority string [i.e. 'epsg:4326'] - An EPSG integer code [i.e. 4326] - A tuple of ("auth_name": "auth_code") [i.e ('epsg', '4326')] - An object with a `to_wkt` method. - A :class:`pyproj.crs.CRS` class Example usage: >>> from pyproj import CRS >>> crs_utm = CRS.from_user_input(26915) >>> crs_utm Name: NAD83 / UTM zone 15N Axis Info [cartesian]: - E[east]: Easting (metre) - N[north]: Northing (metre) Area of Use: - name: North America - 96°W to 90°W and NAD83 by country - bounds: (-96.0, 25.61, -90.0, 84.0) Coordinate Operation: - name: UTM zone 15N - method: Transverse Mercator Datum: North American Datum 1983 - Ellipsoid: GRS 1980 - Prime Meridian: Greenwich >>> crs_utm.area_of_use.bounds (-96.0, 25.61, -90.0, 84.0) >>> crs_utm.ellipsoid ELLIPSOID["GRS 1980",6378137,298.257222101, LENGTHUNIT["metre",1], ID["EPSG",7019]] >>> crs_utm.ellipsoid.inverse_flattening 298.257222101 >>> crs_utm.ellipsoid.semi_major_metre 6378137.0 >>> crs_utm.ellipsoid.semi_minor_metre 6356752.314140356 >>> crs_utm.prime_meridian PRIMEM["Greenwich",0, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8901]] >>> crs_utm.prime_meridian.unit_name 'degree' >>> crs_utm.prime_meridian.unit_conversion_factor 0.017453292519943295 >>> crs_utm.prime_meridian.longitude 0.0 >>> crs_utm.datum DATUM["North American Datum 1983", ELLIPSOID["GRS 1980",6378137,298.257222101, LENGTHUNIT["metre",1]], ID["EPSG",6269]] >>> crs_utm.coordinate_system CS[Cartesian,2], AXIS["(E)",east, ORDER[1], LENGTHUNIT["metre",1, ID["EPSG",9001]]], AXIS["(N)",north, ORDER[2], LENGTHUNIT["metre",1, ID["EPSG",9001]]] >>> print(crs_utm.coordinate_operation.to_wkt(pretty=True)) CONVERSION["UTM zone 15N", METHOD["Transverse Mercator", ID["EPSG",9807]], PARAMETER["Latitude of natural origin",0, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8801]], PARAMETER["Longitude of natural origin",-93, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8802]], PARAMETER["Scale factor at natural origin",0.9996, SCALEUNIT["unity",1], ID["EPSG",8805]], PARAMETER["False easting",500000, LENGTHUNIT["metre",1], ID["EPSG",8806]], PARAMETER["False northing",0, LENGTHUNIT["metre",1], ID["EPSG",8807]], ID["EPSG",16015]] >>> crs = CRS(proj='utm', zone=10, ellps='WGS84') >>> print(crs.to_wkt(pretty=True)) PROJCRS["unknown", BASEGEOGCRS["unknown", DATUM["Unknown based on WGS84 ellipsoid", ELLIPSOID["WGS 84",6378137,298.257223563, LENGTHUNIT["metre",1], ID["EPSG",7030]]], PRIMEM["Greenwich",0, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8901]]], CONVERSION["UTM zone 10N", METHOD["Transverse Mercator", ID["EPSG",9807]], PARAMETER["Latitude of natural origin",0, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8801]], PARAMETER["Longitude of natural origin",-123, ANGLEUNIT["degree",0.0174532925199433], ID["EPSG",8802]], PARAMETER["Scale factor at natural origin",0.9996, SCALEUNIT["unity",1], ID["EPSG",8805]], PARAMETER["False easting",500000, LENGTHUNIT["metre",1], ID["EPSG",8806]], PARAMETER["False northing",0, LENGTHUNIT["metre",1], ID["EPSG",8807]], ID["EPSG",16010]], CS[Cartesian,2], AXIS["(E)",east, ORDER[1], LENGTHUNIT["metre",1, ID["EPSG",9001]]], AXIS["(N)",north, ORDER[2], LENGTHUNIT["metre",1, ID["EPSG",9001]]]] >>> geod = crs.get_geod() >>> f"+a={geod.a:.0f} +f={geod.f:.8f}" '+a=6378137 +f=0.00335281' >>> crs.is_projected True >>> crs.is_geographic False rPto_wktzInvalid CRS input: F)r1r?N)r@rsrsrorjr6rIrArLrErFlenrhrnrrrrGr _localr")r&r0kwargsZ projstringZ projkwargsr)r)r*r$s0             z CRS.__init__cCs"|jjdurt|j|j_|jjS)zH Retrieve the Cython based _CRS object for this thread. N)rur"rrsr%r)r)r*_crs^s zCRS._crs)recoder2cCs|t||S)a? .. versionadded:: 2.2.0 Make a CRS from an authority name and authority code Parameters ---------- auth_name: str The name of the authority. code : int or str The code used by the authority. Returns ------- CRS )from_user_inputrh)clsrerxr)r)r*from_authoritygszCRS.from_authority)rxr2cCs|t|S)zMake a CRS from an EPSG code Parameters ---------- code : int or str An EPSG code. Returns ------- CRS )ryrj)rzrxr)r)r* from_epsg{s z CRS.from_epsg)in_proj_stringr2cCs$t|std||t|S)z .. versionadded:: 2.2.0 Make a CRS from a PROJ string Parameters ---------- in_proj_string : str A PROJ string. Returns ------- CRS zInvalid PROJ string: )rrryr])rzr}r)r)r* from_proj4szCRS.from_proj4) in_wkt_stringr2cCs$t|std||t|S)z .. versionadded:: 2.2.0 Make a CRS from a WKT string Parameters ---------- in_wkt_string : str A WKT string. Returns ------- CRS zInvalid WKT string: )rrryrI)rzrr)r)r*from_wktsz CRS.from_wktrMcCs|t|S)az Make a CRS from: Initialize a CRS class instance with: - PROJ string - JSON string with PROJ parameters - CRS WKT string - An authority string [i.e. 'epsg:4326'] Parameters ---------- in_crs_string : str An EPSG, PROJ, or WKT string. Returns ------- CRS )ryrI)rzrNr)r)r* from_stringszCRS.from_stringr2cCs |jdd}|rd|S|jS)a .. versionadded:: 2.2.0 Convert the CRS to a string. It attempts to convert it to the authority string. Otherwise, it uses the string format of the user input to create the CRS. Returns ------- str dmin_confidencerg) to_authorityrGrs)r&Z auth_infor)r)r* to_strings  z CRS.to_stringrKr2cKst||r|S||fi|Sa Initialize a CRS class instance with: - PROJ string - Dictionary of PROJ parameters - PROJ keyword arguments for parameters - JSON string with PROJ parameters - CRS WKT string - An authority string [i.e. 'epsg:4326'] - An EPSG integer code [i.e. 4326] - A tuple of ("auth_name": "auth_code") [i.e ('epsg', '4326')] - An object with a `to_wkt` method. - A :class:`pyproj.crs.CRS` class Parameters ---------- value : obj A Python int, dict, or str. Returns ------- CRS )r@)rzrKrvr)r)r*rys zCRS.from_user_inputcCs(|jdurdSt|jj|jj|jjdS)zs Returns ------- pyproj.geod.Geod: Geod object based on the ellipsoid. N)arfb) ellipsoidrsemi_major_metreinverse_flatteningsemi_minor_metrer%r)r)r*get_geods z CRS.get_geod) proj_dictr2cCs|t|S)z .. versionadded:: 2.2.0 Make a CRS from a dictionary of PROJ parameters. Parameters ---------- proj_dict : str PROJ params in dict format. Returns ------- CRS )ryrL)rzrr)r)r* from_dictsz CRS.from_dict)crs_jsonr2cCs|t|S)z .. versionadded:: 2.4.0 Create CRS from a CRS JSON string. Parameters ---------- crs_json: str CRS JSON string. Returns ------- CRS )ryr)rzrr)r)r* from_jsonsz CRS.from_json)rbr2cCs|t|S)z .. versionadded:: 2.4.0 Create CRS from a JSON dictionary. Parameters ---------- crs_dict: dict CRS dictionary. Returns ------- CRS )ryrBrC)rzrbr)r)r*from_json_dict*szCRS.from_json_dictcCs`|}|duriSdd}i}t|D]0}|\}}|durJ||}|dur*|||<q*|S)a .. versionadded:: 2.2.0 Converts the CRS to dictionary of PROJ parameters. .. warning:: You will likely lose important projection information when converting to a PROJ string from another format. See: https://proj.org/faq.html#what-is-the-best-format-for-describing-coordinate-reference-systems # noqa: E501 Returns ------- dict: PROJ params in dict format. NcSsd|dkrdS|dkr dSz t|WSty<Yn0z t|WStyZYn0t|S)NtrueTfalseF)lowerrlrafloatr)r8r)r)r*_parseQs      zCRS.to_dict.._parseF)to_proj4_RE_PROJ_PARAMfinditergroups)r&Z proj_stringrrparamrJrKr)r)r*to_dict<s  z CRS.to_dictF) wkt_versionerrcheckr2c CsRd||i}|jr\|jr\|jjr\|jr\|jj||d}|d|||jj|d<|S|jr|j D]&}|j||d}|d||qh|S|j r| }d|vr|dd|d<|j r|j j |d<|S|jr|j|jj|jj|jjd|jj |d <|jr|jj|d <|jj |d <|jrJ|jj |d <|jj rJ|jj j |d <|jr|jr|jjtvr|rtd|jjd|diS|t|jj|jnd|d<|Sd}|js|jr|j}|j |d<|sdn|jdd}|tvr<|r0|r&td|jn tdd|diS|t|||S)aS .. versionadded:: 2.2.0 This converts a :obj:`pyproj.crs.CRS` object to a Climate and Forecast (CF) Grid Mapping Version 1.8 dict. :ref:`build_crs_cf` Parameters ---------- wkt_version: str or pyproj.enums.WktVersion Version of WKT supported by CRS.to_wkt. Default is :attr:`pyproj.enums.WktVersion.WKT2_2019`. errcheck: bool, default=False If True, will warn when parameters are ignored. Returns ------- dict: CF-1.8 version of the projection. crs_wkt)rrtowgs84 geoid_modelname geoid_namegeopotential_datum_name)Zsemi_major_axisZsemi_minor_axisrZreference_ellipsoid_nameZlongitude_of_prime_meridianZprime_meridian_namegeographic_crs_nameZhorizontal_datum_namez"Unsupported coordinate operation: latitude_longitudegrid_mapping_nameNprojected_crs_namer?_zCoordinate operation not found.)rris_boundcoordinate_operationr source_crsto_cfpopupdate is_compound sub_crs_list is_vertical to_json_dictdatumrrrrrprime_meridianZ longitude geodetic_crs is_geographic method_namerrrZr[ is_projectedrXr) r&rrZcf_dictZsub_cfsub_crsZ vert_jsonrZcoordinate_operation_namer)r)r*rjs                   z CRS.to_cf)in_cfellipsoidal_cs cartesian_cs vertical_csr2cCsd}d|vrt|dSd|vr,t|dS|d}|durFtdt|}z t|}Wntypd}Yn0|d}|rt|pd||d } nJ|r||vrt|} |dur| } t || d <t| } n t|d } |d kr| S|durt | |||d Sz t |} Wn$ty6td|dYn0t |dd| || |d} d} d|vrt | dt| jgt|dRd} d|vr| p| Std|d|d|d}td| p| |gdS)a .. versionadded:: 2.2.0 .. versionadded:: 3.0.0 ellipsoidal_cs, cartesian_cs, vertical_cs This converts a Climate and Forecast (CF) Grid Mapping Version 1.8 dict to a :obj:`pyproj.crs.CRS` object. :ref:`build_crs_cf` Parameters ---------- in_cf: dict CF version of the projection. ellipsoidal_cs: Any, optional Input to create an Ellipsoidal Coordinate System. Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or an Ellipsoidal Coordinate System created from :ref:`coordinate_system`. cartesian_cs: Any, optional Input to create a Cartesian Coordinate System. Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or :class:`pyproj.crs.coordinate_system.Cartesian2DCS`. vertical_cs: Any, optional Input to create a Vertical Coordinate System accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or :class:`pyproj.crs.coordinate_system.VerticalCS` Returns ------- CRS )unknown undefinedrZ spatial_refrNz4CF projection parameters missing 'grid_mapping_name'rr)rrrcoordinate_system)rr)base_crs conversionrzUnsupported grid mapping name: r)rrrrrzWGS 84)r target_crstransformationrr)rrrr)r components)rpgetrrrKeyError GeographicCRSrr ryDerivedGeographicCRSr ProjectedCRSBoundCRSrrr VerticalCRS CompoundCRS)rrrrZ unknown_namesrrZgeographic_conversion_methodrZgeographic_crsgeographic_crs_jsonZconversion_methodZ projected_crsZ bound_crsZ vertical_crsr)r)r*from_cfs(                 z CRS.from_cfc Cs,g}dd}|jdkr|jr|j}|ddd}t|dkrR|d}|jd }d d |d d  d ddd}|j  d d}|r|d||d<| ||j r| |j j||dnT|jr |jr |jj r | |jj j||jdn|jD]}| |q|S)a1 .. versionadded:: 3.0.0 This converts all coordinate systems (cs) in the CRS to a list of Climate and Forecast (CF) Version 1.8 dicts. :ref:`build_crs_cf` Returns ------- list[dict]: CF-1.8 version of the coordinate systems. cSs2z|jo|jjtvWSty,YdS0dS)NF)rrrrr)r"r)r)r* rotated_pole|s  z"CRS.cs_to_cf..rotated_polez Temporal CRSZ time_originz 1875-05-20ZzZz-01-01rtimecalendarZproleptic_gregorianr?rT)Z standard_nameZ long_nameraxisrqz since Zunits)r) type_namerrrrYrstriprt axis_inforrX unit_namerHrextendrrrrcs_to_cf) r&Z cf_axis_listrZ datum_jsonoriginrZcf_temporal_axisrrr)r)r*rls@        z CRS.cs_to_cf)otherr2cCs2zt|}Wnty"YdS0|j|jS)ab Check if the CRS objects are the exact same. Parameters ---------- other: Any Check if the other CRS is the exact same to this object. If the other object is not a CRS, it will try to create one. On Failure, it will return False. Returns ------- bool F)rpryrrw is_exact_samer&rr)r)r*rs  zCRS.is_exact_same)rignore_axis_orderr2cCs6zt|}Wnty"YdS0|jj|j|dS)a .. versionadded:: 2.5.0 Check if the CRS objects are equivalent. Parameters ---------- other: Any Check if the other object is equivalent to this object. If the other object is not a CRS, it will try to create one. On Failure, it will return False. ignore_axis_order: bool, default=False If True, it will compare the CRS class and ignore the axis order. Returns ------- bool F)r)rpryrrwequals)r&rrr)r)r*rs  z CRS.equalscCs|jjdurdS||jjSz .. versionadded:: 2.2.0 Returns ------- CRS: The geodeticCRS / geographicCRS from the CRS. N)rwrr(r%r)r)r*rs  zCRS.geodetic_crscCs|jjdurdS||jjSz The base CRS of a BoundCRS or a DerivedCRS/ProjectedCRS, or the source CRS of a CoordinateOperation. Returns ------- CRS N)rwrr(r%r)r)r*rs  zCRS.source_crscCs|jjdurdS||jjSz .. versionadded:: 2.2.0 Returns ------- CRS: The hub CRS of a BoundCRS or the target CRS of a CoordinateOperation. N)rwrr(r%r)r)r*rs  zCRS.target_crscsfddjjDS) If the CRS is a compound CRS, it will return a list of sub CRS objects. Returns ------- list[CRS] csg|]}|qSr)r'r7rr%r)r*r9r:z$CRS.sub_crs_list..rwrr%r)r%r*r s zCRS.sub_crs_listcCsh|jr|jr|jjS|jr8|jD]}|jr |jSq n,|jrdd|jjvrd|jjddSdS)z .. versionadded:: 2.6.0 Finds the UTM zone in a Projected CRS, Bound CRS, or Compound CRS Returns ------- Optional[str]: The UTM zone number and letter if applicable. zUTM ZONEz UTM ZONE N)rrutm_zonerrrupperrV)r&rr)r)r*rs  z CRS.utm_zonecCs|jjS)zx Returns ------- str: The name of the CRS (from :cpp:func:`proj_get_name`). )rwrr%r)r)r*r/szCRS.namecCs|jjS)zj Returns ------- str: The name of the type of the CRS object. )rwrr%r)r)r*r9sz CRS.type_namecCs|jjS)a; Retrieves all relevant axis information in the CRS. If it is a Bound CRS, it gets the axis list from the Source CRS. If it is a Compound CRS, it gets the axis list from the Sub CRS list. Returns ------- list[Axis]: The list of axis information. )rwrr%r)r)r*rCs z CRS.axis_infocCs|jjS)z{ Returns ------- AreaOfUse: The area of use object with associated attributes. )rw area_of_user%r)r)r*rQszCRS.area_of_usecCs|jjS)z .. versionadded:: 2.2.0 Returns ------- Ellipsoid: The ellipsoid object with associated attributes. )rwrr%r)r)r*r[s z CRS.ellipsoidcCs|jjS)z .. versionadded:: 2.2.0 Returns ------- PrimeMeridian: The prime meridian object with associated attributes. )rwrr%r)r)r*rgs zCRS.prime_meridiancCs|jjS)zX .. versionadded:: 2.2.0 Returns ------- Datum )rwrr%r)r)r*rss z CRS.datumcCs|jjS)zc .. versionadded:: 2.2.0 Returns ------- CoordinateSystem )rwrr%r)r)r*r~s zCRS.coordinate_systemcCs|jjS)zf .. versionadded:: 2.2.0 Returns ------- CoordinateOperation )rwrr%r)r)r*rs zCRS.coordinate_operationcCs|jjS)zy .. versionadded:: 2.4.0 Returns ------- str: Remarks about object. )rwremarksr%r)r)r*rs z CRS.remarkscCs|jjS)zt .. versionadded:: 2.4.0 Returns ------- str: Scope of object. )rwscoper%r)r)r*rs z CRS.scope)versionprettyoutput_axis_ruler2cCs.|jj|||d}|dur*td|d|S)aA Convert the projection to a WKT string. Version options: - WKT2_2015 - WKT2_2015_SIMPLIFIED - WKT2_2019 - WKT2_2019_SIMPLIFIED - WKT1_GDAL - WKT1_ESRI .. versionadded:: 3.6.0 output_axis_rule Parameters ---------- version: pyproj.enums.WktVersion, optional The version of the WKT output. Default is :attr:`pyproj.enums.WktVersion.WKT2_2019`. pretty: bool, default=False If True, it will set the output to be a multiline string. output_axis_rule: bool, optional, default=None If True, it will set the axis rule on any case. If false, never. None for AUTO, that depends on the CRS and version. Returns ------- str )rrrNz.CRS cannot be converted to a WKT string of a 'zG' version. Select a different version of a WKT string or edit your CRS.)rwrrr)r&rrrZwktr)r)r*rrs" z CRS.to_wktrP)r indentationr2cCs$|jj||d}|dur td|S)a .. versionadded:: 2.4.0 Convert the object to a JSON string. Parameters ---------- pretty: bool, default=False If True, it will set the output to be a multiline string. indentation: int, default=2 If pretty is True, it will set the width of the indentation. Returns ------- str )rrNz.CRS cannot be converted to a PROJ JSON string.)rwto_jsonr)r&rrZ proj_jsonr)r)r*rsz CRS.to_jsoncCs |jS)z .. versionadded:: 2.4.0 Convert the object to a JSON dictionary. Returns ------- dict )rwrr%r)r)r*rs zCRS.to_json_dict)rr2cCs"|jj|d}|durtd|S)a< Convert the projection to a PROJ string. .. warning:: You will likely lose important projection information when converting to a PROJ string from another format. See: https://proj.org/faq.html#what-is-the-best-format-for-describing-coordinate-reference-systems # noqa: E501 Parameters ---------- version: pyproj.enums.ProjVersion The version of the PROJ string output. Default is :attr:`pyproj.enums.ProjVersion.PROJ_4`. Returns ------- str )rNz)CRS cannot be converted to a PROJ string.)rwrr)r&rr3r)r)r*rsz CRS.to_proj4F)rr2cCs|jj|dS)ac Return the EPSG code best matching the CRS or None if it a match is not found. Example: >>> from pyproj import CRS >>> ccs = CRS("EPSG:4328") >>> ccs.to_epsg() 4328 If the CRS is bound, you can attempt to get an epsg code from the source CRS: >>> from pyproj import CRS >>> ccs = CRS("+proj=geocent +datum=WGS84 +towgs84=0,0,0") >>> ccs.to_epsg() >>> ccs.source_crs.to_epsg() 4978 >>> ccs == CRS.from_epsg(4978) False Parameters ---------- min_confidence: int, default=70 A value between 0-100 where 100 is the most confident. :ref:`min_confidence` Returns ------- Optional[int]: The best matching EPSG code matching the confidence level. r)rwto_epsg)r&rr)r)r*rs#z CRS.to_epsgrercCs|jj||dS)a! .. versionadded:: 2.2.0 Return the authority name and code best matching the CRS or None if it a match is not found. Example: >>> from pyproj import CRS >>> ccs = CRS("EPSG:4328") >>> ccs.to_authority() ('EPSG', '4328') If the CRS is bound, you can get an authority from the source CRS: >>> from pyproj import CRS >>> ccs = CRS("+proj=geocent +datum=WGS84 +towgs84=0,0,0") >>> ccs.to_authority() >>> ccs.source_crs.to_authority() ('EPSG', '4978') >>> ccs == CRS.from_authorty('EPSG', '4978') False Parameters ---------- auth_name: str, optional The name of the authority to filter by. min_confidence: int, default=70 A value between 0-100 where 100 is the most confident. :ref:`min_confidence` Returns ------- tuple(str, str) or None: The best matching (, ) for the confidence level. r)rwrr&rerr)r)r*r7s&zCRS.to_authority)rerr2cCs|jj||dS)aT .. versionadded:: 3.2.0 Return the authority names and codes best matching the CRS. Example: >>> from pyproj import CRS >>> ccs = CRS("EPSG:4328") >>> ccs.list_authority() [AuthorityMatchInfo(auth_name='EPSG', code='4326', confidence=100)] If the CRS is bound, you can get an authority from the source CRS: >>> from pyproj import CRS >>> ccs = CRS("+proj=geocent +datum=WGS84 +towgs84=0,0,0") >>> ccs.list_authority() [] >>> ccs.source_crs.list_authority() [AuthorityMatchInfo(auth_name='EPSG', code='4978', confidence=70)] >>> ccs == CRS.from_authorty('EPSG', '4978') False Parameters ---------- auth_name: str, optional The name of the authority to filter by. min_confidence: int, default=70 A value between 0-100 where 100 is the most confident. :ref:`min_confidence` Returns ------- list[AuthorityMatchInfo]: List of authority matches for the CRS. r)rwlist_authorityrr)r)r*ras(zCRS.list_authorityrr2cCs||jj|dSa .. versionadded:: 3.1.0 Convert the current CRS to the 3D version if it makes sense. New vertical axis attributes: - ellipsoidal height - oriented upwards - metre units Parameters ---------- name: str, optional CRS name. Defaults to use the name of the original CRS. Returns ------- CRS r)r(rwto_3dr&rr)r)r*rsz CRS.to_3dcCs||jj|dS)a# .. versionadded:: 3.6.0 Convert the current CRS to the 2D version if it makes sense. Parameters ---------- name: str, optional CRS name. Defaults to use the name of the original CRS. Returns ------- CRS r)r(rwto_2drr)r)r*rsz CRS.to_2dcCs|jjS)aW This checks if the CRS is geographic. It will check if it has a geographic CRS in the sub CRS if it is a compound CRS and will check if the source CRS is geographic if it is a bound CRS. Returns ------- bool: True if the CRS is in geographic (lon/lat) coordinates. )rwrr%r)r)r*rs zCRS.is_geographiccCs|jjS)a6 This checks if the CRS is projected. It will check if it has a projected CRS in the sub CRS if it is a compound CRS and will check if the source CRS is projected if it is a bound CRS. Returns ------- bool: True if CRS is projected. )rwrr%r)r)r*rs zCRS.is_projectedcCs|jjS)aS .. versionadded:: 2.2.0 This checks if the CRS is vertical. It will check if it has a vertical CRS in the sub CRS if it is a compound CRS and will check if the source CRS is vertical if it is a bound CRS. Returns ------- bool: True if CRS is vertical. )rwrr%r)r)r*rszCRS.is_verticalcCs|jjS)zY Returns ------- bool: True if CRS is bound. )rwrr%r)r)r*rsz CRS.is_boundcCs|jjS)z} .. versionadded:: 3.1.0 Returns ------- bool: True if CRS is compound. )rwrr%r)r)r*rs zCRS.is_compoundcCs|jjS)z .. versionadded:: 2.2.0 Returns ------- bool: True if CRS is local/engineering. )rwis_engineeringr%r)r)r*rs zCRS.is_engineeringcCs|jjS)z This checks if the CRS is geocentric and takes into account if the CRS is bound. Returns ------- bool: True if CRS is in geocentric (x/y) coordinates. )rw is_geocentricr%r)r)r*rs zCRS.is_geocentriccCs|jjS)z .. versionadded:: 3.2.0 Returns ------- bool: True if CRS is a Derived CRS. )rw is_derivedr%r)r)r*rs zCRS.is_derivedcCs ||Sr!)rrr)r)r*__eq__sz CRS.__eq__cCs d|jiS)Nrsrsr%r)r)r* __getstate__!szCRS.__getstate__)statecCs|j|t|_dSr!)__dict__rr ru)r&r r)r)r* __setstate__$s zCRS.__setstate__cCs t|Sr!)hashrrr%r)r)r*__hash__(sz CRS.__hash__cCs|jSr!rr%r)r)r*__str__+sz CRS.__str__c Csg}|jD]}|dt|dgq d|}d}d}|jrP|jjrPt|j}nv|jrz|jrzt|jj}d|jjd}nLg}dg}|j D]&} | t| j|d| jdgqd|}d|}d} |j rdddt|j d |j j dg} | } t| d kr | nd | dd d g} |p(d }d|jd| d|jd|pJdd|d|jp^dd| d|jd|jpzdd|jpdd||S)Nz-  rqz Source CRS: z Sub CRS: |zCoordinate Operation: z- name: z - method: 2r?z...z - undefined  Name: z Axis Info [rz]: z Area of Use: z - undefinedzDatum: z - Ellipsoid: z - Prime Meridian: )rrr6rGrZ axis_listrrrrrHrrrrtrrrrr) r&Zaxis_info_listrZ axis_info_strZsource_crs_reprZ sub_crs_reprZcoordinate_system_nameZcoordinate_system_namesZsub_crs_repr_listrrZsrs_reprr)r)r*__repr__.sl         (      z CRS.__repr__)N)NNN)F)FrP)r)Nr)Nr)N)N)Vr+r,r-r.rrr$propertyrw classmethodr6rrlr{r|r~rrrryrrrArrrrrZ WKT2_2019boolr staticmethodrrErrrrrrrrrrr rrrr rrrr rr rr rrrrrrrrZPROJ_5rrrrrrrrrrrrrrrrr r rrrr)r)r)r*rps( 0  ~>              , %+ ,     rpcseZdZdZeeedfdddZddZe e dd fd d Z ee ddd d Z ee ddddZee ddddZeeddddZde eddddZZS)CustomConstructorCRSz This class is a base class for CRS classes that use a different constructor than the main CRS class. .. versionadded:: 3.2.0 See: https://github.com/pyproj4/pyproj/issues/847 .rcCstdS)zt These are the type names of the CRS class that are expected when using the from_* methods. N)NotImplementedErrorr%r)r)r*_expected_typesrsz$CustomConstructorCRS._expected_typescCs*|j|jvr&td|jd|jddS)zl This validates that the type of the CRS is expected when using the from_* methods. z Invalid type z . Expected .N)rrrr%r)r)r* _check_typezs z CustomConstructorCRS._check_typerprc s<t||r|S||}tt|j|fi|||Sr)r@__new__r#rr$r)rzrKrvr"r'r)r*rys   z$CustomConstructorCRS.from_user_inputcCs|jjdurdSt|jjSr)rwrrpr%r)r)r*rs z!CustomConstructorCRS.geodetic_crscCs|jjdurdSt|jjSr)rwrrpr%r)r)r*rs zCustomConstructorCRS.source_crscCs|jjdurdSt|jjSr)rwrrpr%r)r)r*rs zCustomConstructorCRS.target_crscCsdd|jjDS)rcSsg|] }t|qSr))rprr)r)r*r9r:z5CustomConstructorCRS.sub_crs_list..rr%r)r)r*rs z!CustomConstructorCRS.sub_crs_listNrcCst|jj|dSr)rprwrrr)r)r*rszCustomConstructorCRS.to_3d)N)r+r,r-r.rrFr6rrrrryrrrrrErrr/r)r)r'r*rhs      rcs6eZdZdZdZd eeeeddfdd ZZ S) rzR .. versionadded:: 2.5.0 This class is for building a Geographic CRS )zGeographic CRSzGeographic 2D CRSzGeographic 3D CRSrurn:ogc:def:ensemble:EPSG::6326N)rrrr2csZt|}dd|t|p td}|ddkrB||d<n||d<t|dS) aC Parameters ---------- name: str, default="undefined" Name of the CRS. datum: Any, default="urn:ogc:def:ensemble:EPSG::6326" Anything accepted by :meth:`pyproj.crs.Datum.from_user_input` or a :class:`pyproj.crs.datum.CustomDatum`. ellipsoidal_cs: Any, optional Input to create an Ellipsoidal Coordinate System. Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or an Ellipsoidal Coordinate System created from :ref:`coordinate_system`. 2https://proj.org/schemas/v0.2/projjson.schema.jsonr)$schematyperrr"Z DatumEnsembleZdatum_ensemblerN)r ryrr rr#r$)r&rrrrr'r)r*r$s  zGeographicCRS.__init__)rrN r+r,r-r.rr6rrr$r/r)r)r'r*rsrcs8eZdZdZdZdeeeeeddfdd ZZ S) rzZ .. versionadded:: 2.5.0 This class is for building a Derived Geographic CRS )zDerived Geographic CRSzDerived Geographic 2D CRSzDerived Geographic 3D CRSNr)rrrrr2csFdd|t|t|t|p*td}t|dS)a Parameters ---------- base_crs: Any Input to create the Geodetic CRS, a :class:`GeographicCRS` or anything accepted by :meth:`pyproj.crs.CRS.from_user_input`. conversion: Any Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or a conversion from :ref:`coordinate_operation`. ellipsoidal_cs: Any, optional Input to create an Ellipsoidal Coordinate System. Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or an Ellipsoidal Coordinate System created from :ref:`coordinate_system`. name: str, default="undefined" Name of the CRS. r rr!r"rrrrN)rpryrr r rr#r$)r&rrrrZderived_geographic_crs_jsonr'r)r*r$$s  zDerivedGeographicCRS.__init__)Nr) r+r,r-r.rrrr6r$r/r)r)r'r*rs rcs0eZdZdZdZd eeddfdd ZZS) GeocentricCRSzR .. versionadded:: 3.2.0 This class is for building a Geocentric CRS )zGeocentric CRSrurn:ogc:def:datum:EPSG::6326N)rrr2c sTdd|t|ddddddd d d ddd d dddgdd}t|dS)a0 Parameters ---------- name: str, default="undefined" Name of the CRS. datum: Any, default="urn:ogc:def:datum:EPSG::6326" Anything accepted by :meth:`pyproj.crs.Datum.from_user_input` or a :class:`pyproj.crs.datum.CustomDatum`. r Z GeodeticCRSZ Cartesianz Geocentric XXZ geocentricXZmetre)rZ abbreviation directionunitz Geocentric YYZ geocentricYz Geocentric ZZZ geocentricZ)subtyperr!r"rrrN)r ryrr#r$)r&rrZgeocentric_crs_jsonr'r)r*r$Ss0 zGeocentricCRS.__init__)rr&) r+r,r-r.rr6rr$r/r)r)r'r*r%Jsr%cs<eZdZdZdZdeeeeeeddfdd ZZ S) rzR .. versionadded:: 2.5.0 This class is for building a Projected CRS. )z Projected CRSzDerived Projected CRSrN)rrrrr2csLdd|t|ptt|t|p0td}t|dS)a Parameters ---------- conversion: Any Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or a conversion from :ref:`coordinate_operation`. name: str, optional The name of the Projected CRS. Default is undefined. cartesian_cs: Any, optional Input to create a Cartesian Coordinate System. Anything accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or :class:`pyproj.crs.coordinate_system.Cartesian2DCS`. geodetic_crs: Any, optional Input to create the Geodetic CRS, a :class:`GeographicCRS` or anything accepted by :meth:`pyproj.crs.CRS.from_user_input`. r rr$N) rpryrrr r rr#r$)r&rrrrZ proj_crs_jsonr'r)r*r$szProjectedCRS.__init__)rNN) r+r,r-r.rrr6rr$r/r)r)r'r*rsrcs<eZdZdZdZdeeeeeeddfdd ZZ S)rz .. versionadded:: 2.5.0 This class is for building a Vetical CRS. .. warning:: geoid_model support only exists in PROJ >= 6.3.0 )z Vertical CRSN)rrrrr2csNdd|t|t|ptd}|dur>d|i|d<t|dS)a! Parameters ---------- name: str The name of the Vertical CRS (e.g. NAVD88 height). datum: Any Anything accepted by :meth:`pyproj.crs.Datum.from_user_input` vertical_cs: Any, optional Input to create a Vertical Coordinate System accepted by :meth:`pyproj.crs.CoordinateSystem.from_user_input` or :class:`pyproj.crs.coordinate_system.VerticalCS` geoid_model: str, optional The name of the GEOID Model (e.g. GEOID12B). r rr-Nrr)r ryrr rr#r$)r&rrrrZ vert_crs_jsonr'r)r*r$s   zVerticalCRS.__init__)NNr#r)r)r'r*rs rcs2eZdZdZdZeeeddfdd ZZ S)rzQ .. versionadded:: 2.5.0 This class is for building a Compound CRS. )z Compound CRSN)rrr2cs(dd|dd|Dd}t|dS)a# Parameters ---------- name: str The name of the Compound CRS. components: list[Any], optional List of CRS to create a Compound Coordinate System. List of anything accepted by :meth:`pyproj.crs.CRS.from_user_input` r rcSsg|]}t|qSr))rpryr)r7 componentr)r)r*r9sz(CompoundCRS.__init__..)r!r"rrN)r#r$)r&rrZcompound_crs_jsonr'r)r*r$s  zCompoundCRS.__init__) r+r,r-r.rr6rErr$r/r)r)r'r*rsrcs0eZdZdZdZeeeddfdd ZZS)rzN .. versionadded:: 2.5.0 This class is for building a Bound CRS. )z Bound CRSN)rrrr2cs>ddt|t|t|d}t|dS)a Parameters ---------- source_crs: Any Input to create a source CRS. target_crs: Any Input to create the target CRS. transformation: Any Input to create the transformation. r r)r!r"rrrN)rpryrr r#r$)r&rrrZbound_crs_jsonr'r)r*r$ s    zBoundCRS.__init__)r+r,r-r.rrr$r/r)r)r'r*rsr)T)Cr.rBrR threadingrZtypingrrrrZ pyproj._crsrrrr r r r r rrrrZpyproj.crs._cf1x8rrrrrrZpyproj.crs.coordinate_operationrZpyproj.crs.coordinate_systemrrrZ pyproj.enumsrrZpyproj.exceptionsrZ pyproj.geodrcompiler'rlocalr rArr6rLr]rIrlrhrjrorprrrr%rrrrr)r)r)r*sX8      & P,3710