Public annotation forms¶
Public signatures show the accepted and returned annotation forms. This
page explains those forms and links to the API operations that own them;
its descriptive labels are not additional import names. Other aliases
and structural types follow the signature where they are used; they do
not have standalone gometry imports.
The named result records Cell, Extremes, Features, and
PolygonizeResult are importable with:
from gometry import Cell, Extremes, Features, PolygonizeResult
Iteration results from CellArray¶
Used by: CellArray
Related meanings: Covariant cell element type for CellArray, Covariant cell element type for CellArray
| Field | Value shape |
|---|---|
Iteration results from CircleArray¶
Used by: CircleArray
Related meanings: Covariant generic element type for CircleArray
| Field | Value shape |
|---|---|
Iteration results from Coordinates¶
Used by: Coordinates
| Field | Value shape |
|---|---|
Iteration results from GeometryArray¶
Used by: GeometryArray
Related meanings: Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray
| Field | Value shape |
|---|---|
Iteration results from GeometryCollection¶
Used by: GeometryCollection, GeometryParts, MultiLineString, MultiPoint, and 1 more
Related meanings: Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray
| Field | Value shape |
|---|---|
Iteration results from Groups¶
Used by: Groups
Related meanings: Covariant geometry row type for Groups
| Field | Value shape |
|---|---|
Iteration results from H3EdgeArray¶
Used by: H3EdgeArray
Public types: H3Edge
| Field | Value shape |
|---|---|
Iteration results from H3VertexArray¶
Used by: H3VertexArray
Public types: H3Vertex
| Field | Value shape |
|---|---|
Iteration results from SpatialIndex¶
Used by: SpatialIndex
| Field | Value shape |
|---|---|
Geometry values used by GeohashCell¶
Used by: GeohashCell, H3Cell
Public types: CellArray, Point, Polygon
| Field | Value shape |
|---|---|
Geometry values used by CellArray¶
Used by: CellArray
Public types: Cell, CellArray, GeometryArray
Related meanings: Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray, Covariant generic element type for CellArray
| Field | Value shape |
|---|---|
Compatible object behavior used by CellArray¶
Used by: CellArray
Public types: Cell, CellArray, Groups
Related meanings: Cell element type for CellArray
Required behavior:
__get__()__get__()__get__()__set__()
Cell element type for CellArray¶
Used by: CellArray
Public types: Cell
Variance: invariant
Bound: Cell
Covariant cell element type for CellArray¶
Public types: Cell
Variance: covariant
Default element type: Cell
Token access behavior used by CellArray¶
Used by: CellArray
Required behavior:
__get__()__get__()__get__()__set__()
Compatible object behavior used by CircleArray¶
Used by: CircleArray
Public types: Circle, CircleArray, GeometryArray, Point
Required behavior:
__get__()__get__()__get__()__set__()
Covariant generic element type for CircleArray¶
Used by: CircleArray
Public types: Circle
Variance: covariant
Bound: Circle | None
Default element type: Circle
Default result type for SpatialIndex¶
Used by: SpatialIndex
Variance: invariant
Geometry access behavior used by GeometryArray¶
Used by: GeometryArray
Public types: Geometry, GeometryArray, GeometryCollection, Groups, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon
Required behavior:
__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__get__()__set__()
Other geometry element type for GeometryArray¶
Used by: GeometryArray, difference, intersection, nearest_points, and 5 more
Public types: Geometry
Variance: invariant
Bound: Geometry
Geometry row type for SpatialIndex¶
Used by: SpatialIndex, area, contains, contains_properly, and 31 more
Public types: Geometry
Variance: invariant
Bound: Geometry | None
Generic element type for Geometry¶
Used by: Geometry, GeometryArray, MultiPoint, Point, and 9 more
Public types: Geometry
Variance: invariant
Bound: Geometry
Covariant generic element type for CellArray¶
Used by: CellArray, GeometryArray, GeometryCollection, GeometryParts, and 1 more
Public types: Geometry
Variance: covariant
Bound: Geometry | None
Default element type: Geometry
Group key element type for GeometryArray¶
Used by: GeometryArray
Variance: invariant
Bound: Hashable
Generic element type for Groups¶
Used by: Groups
Public types: CellArray, GeometryArray
Variance: invariant
Bound: np.ndarray[Any, Any] | GeometryArray[Any] | CellArray[Any]
Covariant geometry row type for Groups¶
Used by: Groups
Public types: CellArray, GeometryArray
Variance: covariant
Bound: np.ndarray[Any, Any] | GeometryArray[Any] | CellArray[Any] | None
Generic element type for Groups¶
Used by: Groups
Public types: CellArray, GeometryArray
Variance: invariant
Bound: npt.NDArray[np.int64] | npt.NDArray[np.float64] | GeometryArray[Any] | CellArray[Any]
Compatible object behavior used by Groups¶
Used by: Groups
Public types: Groups
Related meanings: Generic element type for Groups
Required behavior:
__get__()__get__()__get__()__set__()
Geometry values used by H3Cell¶
Related meanings: Geometry values used by GeohashCell, Geometry values used by GeohashCell
| Field | Value shape |
|---|---|
CRS Area Bounds mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
west |
float |
yes | |
south |
float |
yes | |
east |
float |
yes | |
north |
float |
yes |
CRS Area Input annotation shape¶
Used by: CRS, Geometry, GeometryArray, crs_catalog, and 4 more
Related meanings: CRS Area Bounds mapping, CRS Area Of Interest Like object behavior
Shape: tuple[float, float, float, float] | Iterable[float] | CRS Area Bounds mapping | Mapping[str, float] | CRS Area Of Interest Like object behavior
CRS Area Of Interest Like object behavior¶
Used by: CRS
Required behavior:
west_lon_degreesouth_lat_degreeeast_lon_degreenorth_lat_degree
CRS Area Of Use mapping¶
Used by: CRS
Related meanings: CRS Area Bounds mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
west |
float |
yes | |
south |
float |
yes | |
east |
float |
yes | |
north |
float |
yes | |
name |
str | None |
yes |
CRS Authority Object mapping¶
Used by: CRS, crs_catalog
Related meanings: CRS Area Of Use mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
crs |
str |
yes | |
definition |
str |
no | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
name |
str | None |
yes | |
kind |
Literal['geographic_2d', 'geographic_3d', 'geographic', 'geocentric', 'projected', 'vertical', 'compound', 'temporal', 'engineering', 'bound', 'other', 'unknown'] |
yes | |
deprecated |
bool |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes |
CRS Axis Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
abbreviation |
str | None |
yes | |
direction |
str | None |
yes | |
unit_name |
str | None |
yes | |
unit_conversion_factor |
float |
yes |
CRS Cache Bucket Info mapping¶
Used by: crs_cache_info
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str |
yes | |
entries |
int |
yes | |
capacity |
int |
yes |
CRS Cache Info mapping¶
CRS cache state and current-thread transform-engine observations.
last_transform_engine answers whether the most recent transform used
the accelerated 'in_core' engine or bundled 'proj';
transform_invocations counts actual in-core batches and PROJ calls
since the last cache clear/reset.
Used by: crs_cache_info
Related meanings: CRS Cache Bucket Info mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
generation |
int |
yes | |
total_entries |
int |
yes | |
total_capacity |
int |
yes | |
buckets |
list[CRS Cache Bucket Info mapping] |
yes | |
last_transform_engine |
Literal['in_core', 'proj'] | None |
yes | |
transform_invocations |
int |
yes |
CRS Catalog Info mapping¶
Used by: crs_catalog, crs_utm_zones
Related meanings: CRS Authority Object mapping, CRS Authority Object mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
crs |
str |
yes | |
definition |
str |
no | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
name |
str | None |
yes | |
kind |
Literal['geographic_2d', 'geographic_3d', 'geographic', 'geocentric', 'projected', 'vertical', 'compound', 'temporal', 'engineering', 'bound', 'other', 'unknown'] |
yes | |
deprecated |
bool |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes | |
projection_method_name |
str | None |
yes | |
celestial_body |
str | None |
yes |
CRS Celestial Body Info mapping¶
Used by: crs_celestial_bodies
| Field | Value shape | Required | Description |
|---|---|---|---|
authority |
str | None |
yes | |
name |
str | None |
yes |
CRS CF Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
crs_wkt |
str |
no | |
spatial_ref |
str |
no | |
semi_major_axis |
float |
no | |
semi_minor_axis |
float |
no | |
inverse_flattening |
float |
no | |
reference_ellipsoid_name |
str |
no | |
longitude_of_prime_meridian |
float |
no | |
prime_meridian_name |
str |
no | |
geographic_crs_name |
str |
no | |
horizontal_datum_name |
str |
no | |
projected_crs_name |
str |
no | |
grid_mapping_name |
str |
no | |
latitude_of_projection_origin |
float |
no | |
longitude_of_central_meridian |
float |
no | |
longitude_of_projection_origin |
float |
no | |
false_easting |
float |
no | |
false_northing |
float |
no | |
scale_factor_at_central_meridian |
float |
no | |
scale_factor_at_projection_origin |
float |
no | |
standard_parallel |
float | list[float] |
no | |
straight_vertical_longitude_from_pole |
float |
no | |
units |
str |
no | |
proj_units |
str |
no |
CRS Coordinate Operation Info mapping¶
Used by: CRS
Related meanings: CRS Area Of Use mapping, CRS Coordinate Operation Info mapping, CRS Grid Info mapping, CRS Method Info mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
description |
str | None |
yes | |
definition |
str | None |
yes | |
accuracy |
float | None |
yes | |
has_inverse |
bool |
yes | |
has_ballpark_transformation |
bool |
yes | |
requires_coordinate_epoch |
bool |
yes | |
method |
CRS Method Info mapping | None |
yes | |
parameters |
list[CRS Operation Parameter Info mapping] |
yes | |
grids |
list[CRS Grid Info mapping] |
yes | |
steps |
list[CRS Coordinate Operation Info mapping] |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes | |
instantiable |
bool |
yes |
CRS Database Kind annotation shape¶
kind= filter accepted by gm.crs_codes (CrsObjectKind::parse — full
PROJ database object vocabulary, including non-CRS kinds and aliases).
Used by: crs_codes
Annotation shape: Literal['crs', 'geodetic', 'geographic', 'geographic_2d', 'geographic_3d', 'geocentric', 'projected', 'vertical', 'compound', 'temporal', 'engineering', 'bound', 'other'] | Literal['derived_projected_crs', 'ellipsoid', 'prime_meridian', 'geodetic_reference_frame', 'dynamic_geodetic_reference_frame', 'vertical_reference_frame', 'dynamic_vertical_reference_frame', 'datum_ensemble', 'temporal_datum', 'engineering_datum', 'parametric_datum', 'conversion', 'transformation', 'concatenated_operation', 'other_coordinate_operation']
CRS Datum Info mapping¶
Used by: CRS
Related meanings: CRS Datum Info mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
kind |
str | None |
yes | |
frame_reference_epoch |
float | None |
yes | |
ensemble_accuracy |
float | None |
yes | |
ensemble_members |
list[CRS Datum Info mapping] |
yes |
CRS Domain Info mapping¶
Used by: CRS
Related meanings: CRS Area Of Use mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
scope |
str | None |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes |
CRS Ellipsoid Catalog Info mapping¶
Used by: crs_ellipsoids
| Field | Value shape | Required | Description |
|---|---|---|---|
id |
str |
yes | |
semi_major |
str | None |
yes | |
definition |
str | None |
yes | |
name |
str | None |
yes |
CRS Ellipsoid Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
semi_major_metre |
float |
yes | |
semi_minor_metre |
float |
yes | |
inverse_flattening |
float |
yes | |
is_semi_minor_computed |
bool |
yes |
CRS Engine Info mapping¶
Used by: crs_engine
| Field | Value shape | Required | Description |
|---|---|---|---|
backend |
str |
yes | |
bundled_proj |
bool |
yes | |
version |
str | None |
yes | |
release |
str | None |
yes | |
major |
int |
yes | |
minor |
int |
yes | |
patch |
int |
yes | |
search_path |
str | None |
yes | |
paths |
list[str] |
yes | |
database_path |
str | None |
yes | |
database_metadata |
dict[str, str] |
yes | |
user_writable_directory |
str | None |
yes |
CRS Grid Database Info mapping¶
Used by: crs_grid
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str |
yes | |
full_name |
str | None |
yes | |
package_name |
str | None |
yes | |
url |
str | None |
yes | |
direct_download |
bool |
yes | |
available |
bool |
yes |
CRS Grid Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
short_name |
str | None |
yes | |
full_name |
str | None |
yes | |
package_name |
str | None |
yes | |
available |
bool |
yes |
CRS Identify Candidate mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
crs |
str |
yes | |
name |
str | None |
yes | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
confidence |
int |
yes |
CRS Info mapping¶
Used by: CRS
Related meanings: CRS Area Of Use mapping, CRS Authority Object mapping, CRS Authority Object mapping, CRS Axis Info mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
crs |
str |
yes | |
name |
str | None |
yes | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
kind |
Literal['geographic_2d', 'geographic_3d', 'geographic', 'geocentric', 'projected', 'vertical', 'compound', 'temporal', 'engineering', 'bound', 'other', 'unknown'] |
yes | |
is_derived |
bool |
yes | |
deprecated |
bool |
yes | |
remarks |
str | None |
yes | |
scope |
str | None |
yes | |
sub_crs |
list[CRS Authority Object mapping] |
yes | |
source_crs |
CRS Authority Object mapping | None |
yes | |
target_crs |
CRS Authority Object mapping | None |
yes | |
coordinate_operation |
CRS Coordinate Operation Info mapping | None |
yes | |
geodetic_crs |
CRS Authority Object mapping | None |
yes | |
horizontal_datum |
CRS Authority Object mapping | None |
yes | |
domains |
list[CRS Domain Info mapping] |
yes | |
datum |
CRS Datum Info mapping | None |
yes | |
ellipsoid |
CRS Ellipsoid Info mapping | None |
yes | |
prime_meridian |
CRS Prime Meridian Info mapping | None |
yes | |
celestial_body |
str | None |
yes | |
coordinate_system |
str | None |
yes | |
axis_order |
list[str] |
yes | |
axes |
list[CRS Axis Info mapping] |
yes | |
has_point_motion_operation |
bool |
yes | |
is_geographic |
bool |
yes | |
is_projected |
bool |
yes | |
is_vertical |
bool |
yes | |
is_geocentric |
bool |
yes | |
is_compound |
bool |
yes | |
is_engineering |
bool |
yes | |
is_bound |
bool |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes |
CRS Input annotation shape¶
Anything accepted where a CRS is expected: an authority string
('EPSG:4326', WKT, PROJ), an integer-like EPSG code, an
(authority, code) pair, a PROJJSON/CF mapping, or a CRS-like object
exposing a supported conversion or holder protocol (including gometry.CRS
and pyproj.CRS).
Used by: CRS, Geometry, GeometryArray, GeometryCollection, and 24 more
Related meanings: Supports To Wkt object behavior, Supports CRS Holder object behavior, Supports Srs Holder object behavior, Supports To Authority object behavior
Shape: str | SupportsIndex | tuple[str, str | SupportsIndex] | list[str | SupportsIndex] | Mapping[str, Any] | Supports To Wkt object behavior | Supports To Authority object behavior | Supports To Epsg object behavior | Supports To Json object behavior | Supports CRS Holder object behavior | Supports Srs Holder object behavior
CRS Method Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
authority |
str | None |
yes | |
code |
str | None |
yes |
CRS Operation Info mapping¶
Used by: CRS
Related meanings: CRS Coordinate Operation Info mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
description |
str | None |
yes | |
definition |
str | None |
yes | |
accuracy |
float | None |
yes | |
has_inverse |
bool |
yes | |
has_ballpark_transformation |
bool |
yes | |
requires_coordinate_epoch |
bool |
yes | |
method |
CRS Method Info mapping | None |
yes | |
parameters |
list[CRS Operation Parameter Info mapping] |
yes | |
grids |
list[CRS Grid Info mapping] |
yes | |
steps |
list[CRS Coordinate Operation Info mapping] |
yes | |
area_of_use |
CRS Area Of Use mapping | None |
yes | |
instantiable |
bool |
yes | |
source |
str |
yes | |
target |
str |
yes | |
source_epoch |
float | None |
yes | |
target_epoch |
float | None |
yes |
CRS Operation Parameter Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
authority |
str | None |
yes | |
code |
str | None |
yes | |
value |
float |
yes | |
value_string |
str | None |
yes | |
unit_conversion_factor |
float |
yes | |
unit_name |
str | None |
yes | |
unit_authority |
str | None |
yes | |
unit_code |
str | None |
yes | |
unit_category |
str | None |
yes |
CRS Prime Meridian Catalog Info mapping¶
Used by: crs_prime_meridians
| Field | Value shape | Required | Description |
|---|---|---|---|
id |
str |
yes | |
definition |
str | None |
yes |
CRS Prime Meridian Info mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
name |
str | None |
yes | |
longitude |
float |
yes | |
unit_name |
str | None |
yes | |
unit_conversion_factor |
float |
yes |
CRS Proj Operation Catalog Info mapping¶
Used by: crs_proj_operations
| Field | Value shape | Required | Description |
|---|---|---|---|
id |
str |
yes | |
description |
str | None |
yes |
CRS Projection Factors mapping¶
Used by: CRS
| Field | Value shape | Required | Description |
|---|---|---|---|
meridional_scale |
float |
yes | |
parallel_scale |
float |
yes | |
areal_scale |
float |
yes | |
angular_distortion |
float |
yes | |
meridian_parallel_angle |
float |
yes | |
meridian_convergence |
float |
yes | |
tissot_semimajor |
float |
yes | |
tissot_semiminor |
float |
yes | |
dx_dlam |
float |
yes | |
dx_dphi |
float |
yes | |
dy_dlam |
float |
yes | |
dy_dphi |
float |
yes |
CRS Projection Factors Batch mapping¶
Used by: CRS
Related meanings: Float64 Array annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
meridional_scale |
Float64 Array annotation shape |
yes | |
parallel_scale |
Float64 Array annotation shape |
yes | |
areal_scale |
Float64 Array annotation shape |
yes | |
angular_distortion |
Float64 Array annotation shape |
yes | |
meridian_parallel_angle |
Float64 Array annotation shape |
yes | |
meridian_convergence |
Float64 Array annotation shape |
yes | |
tissot_semimajor |
Float64 Array annotation shape |
yes | |
tissot_semiminor |
Float64 Array annotation shape |
yes | |
dx_dlam |
Float64 Array annotation shape |
yes | |
dx_dphi |
Float64 Array annotation shape |
yes | |
dy_dlam |
Float64 Array annotation shape |
yes | |
dy_dphi |
Float64 Array annotation shape |
yes |
CRS Runtime Config mapping¶
Used by: crs_configure, crs_reset
| Field | Value shape | Required | Description |
|---|---|---|---|
search_paths |
list[str] | None |
yes | |
user_writable_directory |
str | None |
yes |
CRS Unit Info mapping¶
| Field | Value shape | Required | Description |
|---|---|---|---|
authority |
str | None |
yes | |
code |
str | None |
yes | |
name |
str | None |
yes | |
category |
str | None |
yes | |
conversion_factor |
float |
yes | |
proj_short_name |
str | None |
yes |
Feature Id annotation shape¶
Used by: Features, to_feature, to_feature_collection
Annotation shape: str | int | float | None
Float64 Array annotation shape¶
Used by: CRS
Annotation shape: npt.NDArray[np.float64]
Float Column annotation shape¶
A float lane: any iterable of floats, or a PEP-3118 buffer exporter
(numpy arrays — float32 included — array.array, memoryviews). Buffer
values are copied into native storage; float32 values are converted to f64.
Used by: CRS, Geometry, GeometryArray, LineString, and 9 more
Annotation shape: Iterable[float] | Buffer
Float Input annotation shape¶
One float per geometry: a scalar broadcasts, or pass an iterable / zero-copy buffer with one value per element.
Used by: CRS, GeometryArray, Point, boxes, and 19 more
Related meanings: Float Column annotation shape, Float Column annotation shape, Float Column annotation shape, Float Column annotation shape
Shape: Float Scalar annotation shape | Scalar Float Array annotation shape | Float Column annotation shape
Float Scalar annotation shape¶
Python and NumPy numeric scalar values accepted by the native f64 boundary.
Used by: CRS, GeohashCell, Geometry, GeometryArray, and 36 more
Annotation shape: float | np.floating[Any] | np.signedinteger[Any] | np.unsignedinteger[Any]
GeoJSON Feature mapping¶
A gometry-parseable GeoJSON Feature object (RFC 7946 §3.2).
geometry may be None in a FeatureCollection, in a GeoJSON row
column, or with from_geojson(..., features=True). Geometry-only
decoding rejects a scalar null-geometry Feature; use
:class:GeoJsonFeatureNonNull for that overload.
Used by: Features, from_geojson, to_feature
Related meanings: GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['Feature'] |
yes | |
geometry |
GeoJSON Geometry annotation shape | None |
yes | |
properties |
Mapping[str, Any] | None |
no | |
id |
str | int | float |
no |
GeoJSON Feature Collection mapping¶
A GeoJSON FeatureCollection object (RFC 7946 §3.3).
Used by: Features, GeometryArray, from_geojson, to_feature_collection
Related meanings: GeoJSON Feature mapping, GeoJSON Feature mapping, GeoJSON Feature mapping
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['FeatureCollection'] |
yes | |
features |
list[GeoJSON Feature mapping] |
yes |
GeoJSON Feature Non Null mapping¶
A GeoJSON Feature with a non-null geometry (scalar from_geojson).
Used by: from_geojson
Related meanings: GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['Feature'] |
yes | |
geometry |
GeoJSON Geometry annotation shape |
yes | |
properties |
Mapping[str, Any] | None |
no | |
id |
str | int | float |
no |
GeoJSON Geometry annotation shape¶
A gometry-parseable GeoJSON geometry object (RFC 7946 §3.1).
Every geometry kind requires its payload key: coordinates for all kinds
except GeometryCollection, which requires geometries. A Feature may
carry geometry: None to represent a missing geometry row; missing payload
keys are rejected at parse time.
Used by: Features, Geometry, from_geojson
Related meanings: GeoJSON Geometry Collection Geometry mapping, GeoJSON Line String Geometry mapping, GeoJSON Multi Line String Geometry mapping, GeoJSON Multi Point Geometry mapping
Shape: GeoJSON Point Geometry mapping | GeoJSON Multi Point Geometry mapping | GeoJSON Line String Geometry mapping | GeoJSON Multi Line String Geometry mapping | GeoJSON Polygon Geometry mapping | GeoJSON Multi Polygon Geometry mapping | GeoJSON Geometry Collection Geometry mapping
GeoJSON Geometry Collection Geometry mapping¶
GeoJSON GeometryCollection (RFC 7946 §3.1.8).
Used by: Features
Related meanings: GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape, GeoJSON Geometry annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['GeometryCollection'] |
yes | |
geometries |
list[GeoJSON Geometry annotation shape] |
yes |
GeoJSON Line String Geometry mapping¶
GeoJSON LineString geometry (RFC 7946 §3.1.4).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['LineString'] |
yes | |
coordinates |
Sequence[GeoJSON Position annotation shape] |
yes |
GeoJSON Multi Line String Geometry mapping¶
GeoJSON MultiLineString geometry (RFC 7946 §3.1.5).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['MultiLineString'] |
yes | |
coordinates |
Sequence[Sequence[GeoJSON Position annotation shape]] |
yes |
GeoJSON Multi Point Geometry mapping¶
GeoJSON MultiPoint geometry (RFC 7946 §3.1.3).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['MultiPoint'] |
yes | |
coordinates |
Sequence[GeoJSON Position annotation shape] |
yes |
GeoJSON Multi Polygon Geometry mapping¶
GeoJSON MultiPolygon geometry (RFC 7946 §3.1.7).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['MultiPolygon'] |
yes | |
coordinates |
Sequence[Sequence[Sequence[GeoJSON Position annotation shape]]] |
yes |
GeoJSON Point Geometry mapping¶
GeoJSON Point geometry (RFC 7946 §3.1.2).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['Point'] |
yes | |
coordinates |
GeoJSON Position annotation shape |
yes |
GeoJSON Polygon Geometry mapping¶
GeoJSON Polygon geometry (RFC 7946 §3.1.6).
Used by: Features
Related meanings: GeoJSON Position annotation shape
| Field | Value shape | Required | Description |
|---|---|---|---|
type |
Literal['Polygon'] |
yes | |
coordinates |
Sequence[Sequence[GeoJSON Position annotation shape]] |
yes |
GeoJSON Position annotation shape¶
GeoJSON typing vocabulary shared by the TypedDicts below and user code.
Used by: Features
Annotation shape: list[float] | tuple[float, ...]
Geo Pandas Series annotation shape¶
Used by: GeometryArray
Annotation shape: gpd.GeoSeries
Grid Origin annotation shape¶
Grid origin for snap_to_grid: only a two-value numeric (x, y)
iterable (not 'centroid'/'center' — those are affine-only).
Used by: Geometry, GeometryArray, GeometryCollection, LineString, and 5 more
Annotation shape: Iterable[float]
Nested Coordinates annotation shape¶
Topology-preserving nested coordinate payload from Coordinates.to_nested.
A point is a flat list[float]; lines/multipoints are lists of ordinate
tuples; polygons nest rings; multiparts and arrays nest further. None
represents missing geometry rows and absent Z/M in a selected layout.
Used by: Coordinates
Related meanings: Nested Coordinates annotation shape
Annotation shape: list[float | None] | list[tuple[float | None, ...]] | list[NestedCoordinates | None]
Origin annotation shape¶
Anchor for the affine helpers (rotate/scale/skew): the
'centroid', the bounds 'center', or any two-value (x, y)
iterable (including lists, NumPy arrays, and generators).
Used by: Geometry, GeometryArray
Annotation shape: Literal['centroid', 'center'] | Iterable[float]
Pandas Series annotation shape¶
Used by: GeometryArray, from_geojson, from_polyline, from_wkb, and 1 more
Annotation shape: pd.Series
Polars Series annotation shape¶
Used by: GeometryArray, from_geojson, from_polyline, from_wkb, and 1 more
Annotation shape: pl.Series
Py Arrow Array annotation shape¶
Used by: Geometry, GeometryArray, from_arrow, from_geojson, and 3 more
Annotation shape: pa.Array | pa.ExtensionArray
Py Arrow Capsule annotation shape¶
Used by: CellArray, Geometry, GeometryArray, H3EdgeArray, and 2 more
Annotation shape: object
Py Arrow Chunked Array annotation shape¶
Used by: from_arrow, from_geojson, from_polyline, from_wkb, and 1 more
Annotation shape: pa.ChunkedArray
Py Arrow Native File annotation shape¶
Used by: GeometryArray
Annotation shape: pa.NativeFile
Py Arrow Record Batch annotation shape¶
Used by: from_arrow
Annotation shape: pa.RecordBatch
Py Arrow Record Batch Reader annotation shape¶
Used by: from_arrow
Annotation shape: pa.RecordBatchReader
Py Arrow Schema Capsule annotation shape¶
Used by: CellArray, Geometry, GeometryArray, H3EdgeArray, and 2 more
Annotation shape: object
Py Arrow Table annotation shape¶
Used by: GeometryArray, from_arrow
Annotation shape: pa.Table
Scalar Float Array annotation shape¶
A 0-D NumPy array follows the scalar native numeric path. Ordinary NDArray aliases erase shape, so only an explicitly shaped value earns scalar returns.
Used by: CRS, GeohashCell, Geometry, GeometryArray, and 31 more
Annotation shape: np.ndarray[tuple[()], np.dtype[np.floating[Any] | np.signedinteger[Any] | np.unsignedinteger[Any]]]
Supports Arrow Array object behavior¶
An object exporting Arrow C Data (schema, array) capsules.
Used by: from_arrow
Related meanings: Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape
Required behavior:
__arrow_c_array__()
Supports Arrow Stream object behavior¶
An object exporting an Arrow C stream capsule.
Used by: from_arrow
Related meanings: Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape, Py Arrow Capsule annotation shape
Required behavior:
__arrow_c_stream__()
Supports Geo Interface value shape¶
Any object exposing a typed GeoJSON-like __geo_interface__ mapping.
Used by: GeometryArray, SpatialIndex, area, coverage_clean, and 14 more
Related meanings: Generic element type
| Field | Value shape |
|---|---|
Supports To Wkt object behavior¶
An object that serializes itself to WKT — e.g. a gometry.CRS or
pyproj.CRS.
Used by: CRS
Required behavior:
to_wkt()
Generic element type¶
Used by: Extremes
Public types: Point
Variance: invariant
Default element type: Point
Generic element type¶
Used by: GeometryArray
Variance: covariant
Bound: Mapping[str, Any]
Default element type: Mapping[str, Any]
Generic element type¶
Used by: PolygonizeResult
Variance: covariant
Allowed values: Never, None
Default element type: Never
Supports CRS Holder object behavior¶
Used by: CRS
Related meanings: CRS Input annotation shape, CRS Input annotation shape, CRS Input annotation shape, CRS Input annotation shape
Required behavior:
crs()
Supports Srs Holder object behavior¶
Used by: CRS
Related meanings: CRS Input annotation shape, CRS Input annotation shape, CRS Input annotation shape, CRS Input annotation shape
Required behavior:
srs()
Supports To Authority object behavior¶
Used by: CRS
Required behavior:
to_authority()
Supports To Epsg object behavior¶
Used by: CRS
Required behavior:
to_epsg()
Supports To Json object behavior¶
Used by: CRS
Required behavior:
to_json()