sdkagent

pyproj API reference

149 public APIs from pyproj (pyproj4/pyproj) — 68 classes, 9 functions, 72 methods. Signatures extracted by static analysis of the actual source.

Repository: pyproj4/pyproj

KindCount
Classes68
Functions9
Methods72

API list

funcpyproj._show_versions.show_versions()
..
classpyproj.aoi.AreaOfInterest
..
classpyproj.aoi.AreaOfUse
..
methodpyproj.aoi.AreaOfUse.bounds() -> tuple[float, float, float, float]
The bounds of the area of use.
methodpyproj.aoi.BBox.intersects(other:Union['BBox', AreaOfUse]) -> bool
Parameters ---------- other: BBox The other BBox to use to check.
classpyproj.crs.coordinate_operation.AlbersEqualAreaConversion
..
classpyproj.crs.coordinate_operation.AzimuthalEquidistantConversion
..
classpyproj.crs.coordinate_operation.EquidistantCylindricalConversion
..
classpyproj.crs.coordinate_operation.GeostationarySatelliteConversion
..
classpyproj.crs.coordinate_operation.HotineObliqueMercatorBConversion
..
classpyproj.crs.coordinate_operation.LambertAzimuthalEqualAreaConversion
..
classpyproj.crs.coordinate_operation.LambertConformalConic1SPConversion
..
classpyproj.crs.coordinate_operation.LambertConformalConic2SPConversion
..
classpyproj.crs.coordinate_operation.LambertCylindricalEqualAreaConversion
..
classpyproj.crs.coordinate_operation.LambertCylindricalEqualAreaScaleConversion
..
classpyproj.crs.coordinate_operation.MercatorAConversion
..
classpyproj.crs.coordinate_operation.MercatorBConversion
..
classpyproj.crs.coordinate_operation.OrthographicConversion
..
classpyproj.crs.coordinate_operation.PolarStereographicAConversion
..
classpyproj.crs.coordinate_operation.PolarStereographicBConversion
..
classpyproj.crs.coordinate_operation.PoleRotationNetCDFCFConversion
..
classpyproj.crs.coordinate_operation.RotatedLatitudeLongitudeConversion
..
classpyproj.crs.coordinate_operation.SinusoidalConversion
..
classpyproj.crs.coordinate_operation.StereographicConversion
..
classpyproj.crs.coordinate_operation.ToWGS84Transformation
..
classpyproj.crs.coordinate_operation.TransverseMercatorConversion
..
classpyproj.crs.coordinate_operation.UTMConversion
..
classpyproj.crs.coordinate_operation.VerticalPerspectiveConversion
..
classpyproj.crs.coordinate_system.Cartesian2DCS
..
classpyproj.crs.coordinate_system.Ellipsoidal2DCS
..
classpyproj.crs.coordinate_system.Ellipsoidal3DCS
..
classpyproj.crs.coordinate_system.VerticalCS
..
classpyproj.crs.crs.BoundCRS
..
classpyproj.crs.crs.CRS
A pythonic Coordinate Reference System manager.
methodpyproj.crs.crs.CRS.axis_info() -> list[Axis]
Retrieves all relevant axis information in the CRS.
methodpyproj.crs.crs.CRS.coordinate_operation() -> CoordinateOperation | None
..
methodpyproj.crs.crs.CRS.coordinate_system() -> CoordinateSystem | None
..
methodpyproj.crs.crs.CRS.cs_to_cf() -> list[dict]
..
methodpyproj.crs.crs.CRS.datum() -> Datum | None
..
methodpyproj.crs.crs.CRS.ellipsoid() -> Ellipsoid | None
..
methodpyproj.crs.crs.CRS.equals(other:Any, ignore_axis_order:bool=False) -> bool
..
methodpyproj.crs.crs.CRS.from_authority(auth_name:str, code:str | int) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_cf(in_cf:dict, ellipsoidal_cs:Any | None=None, cartesian_cs:Any | None=None, vertical_cs:Any | None=None) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_dict(proj_dict:dict[str, Any]) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_json(crs_json:str) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_json_dict(crs_dict:dict) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_proj4(in_proj_string:str) -> 'CRS'
..
methodpyproj.crs.crs.CRS.from_wkt(in_wkt_string:str) -> 'CRS'
..
methodpyproj.crs.crs.CRS.geodetic_crs() -> Optional['CRS']
..
methodpyproj.crs.crs.CRS.get_non_deprecated() -> list['CRS']
..
methodpyproj.crs.crs.CRS.is_bound() -> bool
Returns ------- bool: True if CRS is bound.
methodpyproj.crs.crs.CRS.is_compound() -> bool
..
methodpyproj.crs.crs.CRS.is_deprecated() -> bool
..
methodpyproj.crs.crs.CRS.is_derived()
..
methodpyproj.crs.crs.CRS.is_engineering() -> bool
..
methodpyproj.crs.crs.CRS.is_exact_same(other:Any) -> bool
Check if the CRS objects are the exact same.
methodpyproj.crs.crs.CRS.is_geographic() -> bool
This checks if the CRS is geographic.
methodpyproj.crs.crs.CRS.is_projected() -> bool
This checks if the CRS is projected.
methodpyproj.crs.crs.CRS.is_vertical() -> bool
..
methodpyproj.crs.crs.CRS.list_authority(auth_name:str | None=None, min_confidence:int=70) -> list[AuthorityMatchInfo]
..
methodpyproj.crs.crs.CRS.prime_meridian() -> PrimeMeridian | None
..
methodpyproj.crs.crs.CRS.remarks() -> str
..
methodpyproj.crs.crs.CRS.scope() -> str
..
methodpyproj.crs.crs.CRS.target_crs() -> Optional['CRS']
..
methodpyproj.crs.crs.CRS.to_2d(name:str | None=None) -> 'CRS'
..
methodpyproj.crs.crs.CRS.to_3d(name:str | None=None) -> 'CRS'
..
methodpyproj.crs.crs.CRS.to_authority(auth_name:str | None=None, min_confidence:int=70)
..
methodpyproj.crs.crs.CRS.to_cf(wkt_version:WktVersion | str=WktVersion.WKT2_2019, errcheck:bool=False) -> dict
..
methodpyproj.crs.crs.CRS.to_dict() -> dict
..
methodpyproj.crs.crs.CRS.to_json(pretty:bool=False, indentation:int=2) -> str
..
methodpyproj.crs.crs.CRS.to_json_dict() -> dict
..
methodpyproj.crs.crs.CRS.to_proj4(version:ProjVersion | int=ProjVersion.PROJ_5) -> str
Convert the projection to a PROJ string.
methodpyproj.crs.crs.CRS.to_string() -> str
..
methodpyproj.crs.crs.CRS.to_wkt(version:WktVersion | str=WktVersion.WKT2_2019, pretty:bool=False, output_axis_rule:bool | None=None) -> str
Convert the projection to a WKT string.
methodpyproj.crs.crs.CRS.type_name() -> str
Returns ------- str: The name of the type of the CRS object.
methodpyproj.crs.crs.CRS.utm_zone() -> str | None
..
classpyproj.crs.crs.CRSLocal
Threading local instance for cython CRS class.
classpyproj.crs.crs.CompoundCRS
..
classpyproj.crs.crs.DerivedGeographicCRS
..
classpyproj.crs.crs.GeocentricCRS
..
classpyproj.crs.crs.GeographicCRS
..
classpyproj.crs.crs.ProjectedCRS
..
classpyproj.crs.crs.VerticalCRS
..
classpyproj.crs.datum.CustomDatum
..
classpyproj.crs.datum.CustomEllipsoid
..
classpyproj.crs.datum.CustomPrimeMeridian
..
classpyproj.crs.enums.Cartesian2DCSAxis
..
classpyproj.crs.enums.CoordinateOperationType
..
classpyproj.crs.enums.DatumType
..
classpyproj.crs.enums.Ellipsoidal2DCSAxis
..
classpyproj.crs.enums.Ellipsoidal3DCSAxis
..
classpyproj.crs.enums.VerticalCSAxis
..
funcpyproj.datadir.append_data_dir(proj_data_dir:str | Path) -> None
Add an additional data directory for PROJ to use.
funcpyproj.datadir.get_data_dir() -> str
The order of preference for the data directory is: 1.
funcpyproj.datadir.set_data_dir(proj_data_dir:str | Path) -> None
Set the data directory for PROJ to use.
classpyproj.enums.BaseEnum
Base enumeration class that handles input as strings ignoring case.
classpyproj.enums.CRSExtentUse
..
classpyproj.enums.GeodIntermediateFlag
..
classpyproj.enums.GridAvailabilityUse
..
classpyproj.enums.IntermediateCRSUse
..
classpyproj.enums.PJType
..
classpyproj.enums.ProjVersion
..
classpyproj.enums.TransformDirection
..
classpyproj.enums.WktVersion
..
classpyproj.exceptions.CRSError
Raised when a CRS error occurs.
classpyproj.exceptions.DataDirError
Raised when a the data directory was not found.
classpyproj.exceptions.GeodError
Raised when a Geod error occurs.
classpyproj.exceptions.ProjError
Raised when a Proj error occurs.
methodpyproj.geod.Geod.fwd_intermediate(lon1:float, lat1:float, azi1:float, npts:int, del_s:float, initial_idx:int=1, terminus_idx:int=1, radians:bool=False, flags:GeodIntermediateFlag=GeodIntermediateFlag.DEFAULT, out_lons:Any | None=None, out_lats:Any | None=None, out_azis:Any | None=None, return_back_azimuth:bool | None=None) -> GeodIntermediateReturn
..
methodpyproj.geod.Geod.geometry_area_perimeter(geometry, radians:bool=False) -> tuple[float, float]
..
methodpyproj.geod.Geod.geometry_length(geometry, radians:bool=False) -> float
..
methodpyproj.geod.Geod.line_length(lons:Any, lats:Any, radians:bool=False) -> float
..
methodpyproj.geod.Geod.line_lengths(lons:Any, lats:Any, radians:bool=False) -> Any
..
methodpyproj.geod.Geod.npts(lon1:float, lat1:float, lon2:float, lat2:float, npts:int, radians:bool=False, initial_idx:int=1, terminus_idx:int=1) -> list[tuple[float, float]]
..
methodpyproj.geod.Geod.polygon_area_perimeter(lons:Any, lats:Any, radians:bool=False) -> tuple[float, float]
..
funcpyproj.geod.reverse_azimuth(azi:Any, radians:bool=False) -> Any
Reverses the given azimuth (forward <-> backwards) ..
funcpyproj.network.set_ca_bundle_path(ca_bundle_path:Path | str | bool | None=None) -> None
..
classpyproj.proj.Proj
Performs cartographic transformations.
methodpyproj.proj.Proj.get_factors(longitude:Any, latitude:Any, radians:bool=False, errcheck:bool=False) -> Factors
..
methodpyproj.transformer.Transformer.accuracy() -> float
float: Expected accuracy of the transformation.
methodpyproj.transformer.Transformer.area_of_use() -> AreaOfUse
..
methodpyproj.transformer.Transformer.definition() -> str
str: Definition of the projection.
methodpyproj.transformer.Transformer.description() -> str
str: Description of the projection.
methodpyproj.transformer.Transformer.from_pipeline(proj_pipeline:str, always_xy:bool=False) -> 'Transformer'
Make a Transformer from a PROJ pipeline string.
methodpyproj.transformer.Transformer.get_last_used_operation() -> 'Transformer'
..
methodpyproj.transformer.Transformer.has_inverse() -> bool
bool: True if an inverse mapping exists.
methodpyproj.transformer.Transformer.is_exact_same(other:Any) -> bool
Check if the Transformer objects are the exact same.
methodpyproj.transformer.Transformer.is_network_enabled() -> bool
..
methodpyproj.transformer.Transformer.name() -> str
str: Name of the projection.
methodpyproj.transformer.Transformer.operations() -> tuple[CoordinateOperation] | None
..
methodpyproj.transformer.Transformer.remarks() -> str
..
methodpyproj.transformer.Transformer.scope() -> str
..
methodpyproj.transformer.Transformer.source_crs() -> CRS | None
..
methodpyproj.transformer.Transformer.target_crs() -> CRS | None
..
methodpyproj.transformer.Transformer.to_json(pretty:bool=False, indentation:int=2) -> str
Convert the projection to a JSON string.
methodpyproj.transformer.Transformer.to_json_dict() -> dict
Convert the projection to a JSON dictionary.
methodpyproj.transformer.Transformer.to_proj4(version:ProjVersion | str=ProjVersion.PROJ_5, pretty:bool=False) -> str
Convert the projection to a PROJ string.
methodpyproj.transformer.Transformer.to_wkt(version:WktVersion | str=WktVersion.WKT2_2019, pretty:bool=False) -> str
Convert the projection to a WKT string.
methodpyproj.transformer.Transformer.transform_bounds(left:float, bottom:float, right:float, top:float, densify_pts:int=21, radians:bool=False, errcheck:bool=False, direction:TransformDirection | str=TransformDirection.FORWARD) -> tuple[float, float, float, float]
..
classpyproj.transformer.TransformerFromCRS
..
classpyproj.transformer.TransformerFromPipeline
..
classpyproj.transformer.TransformerLocal
Threading local instance for cython _Transformer class.
classpyproj.transformer.TransformerMaker
..
classpyproj.transformer.TransformerUnsafe
..
funcpyproj.transformer.itransform(p1:Any, p2:Any, points:Iterable[Iterable], switch:bool=False, time_3rd:bool=False, radians:bool=False, errcheck:bool=False, always_xy:bool=False)
..
funcpyproj.transformer.transform(p1:Any, p2:Any, x:Any, y:Any, z:Any | None=None, tt:Any | None=None, radians:bool=False, errcheck:bool=False, always_xy:bool=False)
..
classpyproj.utils.DataType
Data type for copy to buffer and convertback operations
classpyproj.utils.NumpyEncoder
Handle numpy types when dumping to JSON
funcpyproj.utils.is_null(value:Any) -> bool
Check if value is NaN or None

About this data

These signatures were extracted from the public source of pyproj4/pyproj using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries