Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor geographic crs attribute #158

Merged
merged 3 commits into from
Oct 15, 2024
Merged

refactor geographic crs attribute #158

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe62d47
refactor geographic crs attribute
vincentsarago Oct 10, 2024
81538fb
add more tests
vincentsarago Oct 11, 2024
4aa83ec
check crs equality
vincentsarago Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

## 6.0.0 (TBD)

* remove `_geographic_crs` private attribute in `TileMatrixSet` model **breaking change**
* use `crs.geodetic_crs` property as `geographic_crs` **breaking change**

## 5.4.2 (2024-08-29)

* better handle anti-meridian crossing bbox in `tms.tiles()` (author @ljstrnadiii, https://github.com/developmentseed/morecantile/pull/154)
Expand Down
17 changes: 4 additions & 13 deletions morecantile/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,24 +486,19 @@ class TileMatrixSet(BaseModel, arbitrary_types_allowed=True):
]

# Private attributes
_geographic_crs: pyproj.CRS = PrivateAttr(default=WGS84_CRS)
_to_geographic: pyproj.Transformer = PrivateAttr()
_from_geographic: pyproj.Transformer = PrivateAttr()

def __init__(self, **data):
"""Set private attributes."""
super().__init__(**data)

self._geographic_crs = pyproj.CRS.from_user_input(
data.get("_geographic_crs", WGS84_CRS)
)

try:
self._to_geographic = pyproj.Transformer.from_crs(
self.crs._pyproj_crs, self._geographic_crs, always_xy=True
self.crs._pyproj_crs, self.crs._pyproj_crs.geodetic_crs, always_xy=True
)
self._from_geographic = pyproj.Transformer.from_crs(
self._geographic_crs, self.crs._pyproj_crs, always_xy=True
self.crs._pyproj_crs.geodetic_crs, self.crs._pyproj_crs, always_xy=True
)
except ProjError:
warnings.warn(
Expand Down Expand Up @@ -555,7 +550,7 @@ def __repr__(self):
@cached_property
def geographic_crs(self) -> pyproj.CRS:
"""Return the TMS's geographic CRS."""
return self._geographic_crs
return self.crs._pyproj_crs.geodetic_crs

@cached_property
def rasterio_crs(self):
Expand All @@ -565,7 +560,7 @@ def rasterio_crs(self):
@cached_property
def rasterio_geographic_crs(self):
"""Return the geographic CRS as a rasterio CRS."""
return to_rasterio_crs(self._geographic_crs)
return to_rasterio_crs(self.crs._pyproj_crs.geodetic_crs)

@property
def minzoom(self) -> int:
Expand Down Expand Up @@ -656,7 +651,6 @@ def custom(
title: Optional[str] = None,
id: Optional[str] = None,
ordered_axes: Optional[List[str]] = None,
geographic_crs: pyproj.CRS = WGS84_CRS,
screen_pixel_size: float = 0.28e-3,
decimation_base: int = 2,
**kwargs: Any,
Expand Down Expand Up @@ -689,8 +683,6 @@ def custom(
Tile Matrix Set title
id: str, optional
Tile Matrix Set identifier
geographic_crs: pyproj.CRS
Geographic (lat,lon) coordinate reference system (default is EPSG:4326)
ordered_axes: list of str, optional
Override Axis order (e.g `["N", "S"]`) else default to CRS's metadata
screen_pixel_size: float, optional
Expand Down Expand Up @@ -769,7 +761,6 @@ def custom(
tileMatrices=tile_matrices,
id=id,
title=title,
_geographic_crs=geographic_crs,
**kwargs,
)

Expand Down
56 changes: 39 additions & 17 deletions tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,24 @@ def test_tile_matrix_set(tileset):
ts = TileMatrixSet.model_validate_json(f.read())
# This would fail if `crs` isn't supported by PROJ
assert isinstance(ts.crs._pyproj_crs, pyproj.CRS)
assert isinstance(ts.geographic_crs, pyproj.CRS)
assert repr(ts)


@pytest.mark.parametrize("tileset", tilesets)
def test_geographic_crs_bbox(tileset):
"""check that geographic bounds are correct."""
with open(tileset, "r") as f:
ts = TileMatrixSet.model_validate_json(f.read())

if not pyproj.CRS.from_epsg(4326) == ts.geographic_crs:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for some TMS, the geographic_crs returned by tms._pyproj_crs.geodetic_crs isn't strictly equal to WGS84, but by checking the geographic transformation of the tms bbox we can see they give the same result

_to_geographic = pyproj.Transformer.from_crs(
ts.crs._pyproj_crs, pyproj.CRS.from_epsg(4326), always_xy=True
)
bbox = _to_geographic.transform_bounds(*ts.xy_bbox, densify_pts=21)
assert bbox == ts.bbox


def test_tile_matrix_iter():
"""Test iterator"""
tms = morecantile.tms.get("WebMercatorQuad")
Expand Down Expand Up @@ -163,17 +178,13 @@ def test_Custom():
assert round(wmMat.pointOfOrigin[0], 6) == round(cusMat.pointOfOrigin[0], 6)

extent = (-20037508.3427892, -20037508.3427892, 20037508.3427892, 20037508.3427892)
custom_tms = TileMatrixSet.custom(
extent, pyproj.CRS.from_epsg(3857), geographic_crs="epsg:4326"
)
assert isinstance(custom_tms._geographic_crs, pyproj.CRS)
assert custom_tms._geographic_crs == pyproj.CRS.from_epsg(4326)
custom_tms = TileMatrixSet.custom(extent, pyproj.CRS.from_epsg(3857))
assert isinstance(custom_tms.geographic_crs, pyproj.CRS)
assert custom_tms.geographic_crs == pyproj.CRS.from_epsg(4326)

extent = (-20037508.3427892, -20037508.3427892, 20037508.3427892, 20037508.3427892)
custom_tms = TileMatrixSet.custom(
extent, pyproj.CRS.from_epsg(3857), geographic_crs=pyproj.CRS.from_epsg(4326)
)
assert isinstance(custom_tms._geographic_crs, pyproj.CRS)
custom_tms = TileMatrixSet.custom(extent, pyproj.CRS.from_epsg(3857))
assert isinstance(custom_tms.geographic_crs, pyproj.CRS)


def test_custom_tms_bounds_epsg4326():
Expand Down Expand Up @@ -300,8 +311,7 @@ def test_schema():
"+proj=stere +lat_0=90 +lon_0=0 +k=2 +x_0=0 +y_0=0 +R=3396190 +units=m +no_defs"
)
extent = [-13584760.000, -13585240.000, 13585240.000, 13584760.000]
with pytest.warns(UserWarning):
tms = morecantile.TileMatrixSet.custom(extent, crs, id="MarsNPolek2MOLA5k")
tms = morecantile.TileMatrixSet.custom(extent, crs, id="MarsNPolek2MOLA5k")
assert tms.model_json_schema()
assert tms.model_dump(exclude_none=True)
json_doc = json.loads(tms.model_dump_json(exclude_none=True))
Expand All @@ -316,13 +326,12 @@ def test_schema():
assert json_doc["crs"] == "http://www.opengis.net/def/crs/EPSG/0/3031"


MARS2000_SPHERE = pyproj.CRS.from_proj4("+proj=longlat +R=3396190 +no_defs")


def test_mars_tms():
"""The Mars global mercator scheme should broadly align with the Earth
Web Mercator CRS, despite the different planetary radius and scale.
"""
MARS2000_SPHERE = pyproj.CRS.from_proj4("+proj=longlat +R=3396190 +no_defs")

MARS_MERCATOR = pyproj.CRS.from_proj4(
"+proj=merc +R=3396190 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +no_defs"
)
Expand All @@ -338,8 +347,8 @@ def test_mars_tms():
MARS_MERCATOR,
extent_crs=MARS2000_SPHERE,
title="Web Mercator Mars",
geographic_crs=MARS2000_SPHERE,
vincentsarago marked this conversation as resolved.
Show resolved Hide resolved
)
assert mars_tms.geographic_crs

pos = (35, 40, 3)
mars_tile = mars_tms.tile(*pos)
Expand All @@ -350,9 +359,17 @@ def test_mars_tms():
assert mars_tile.y == earth_tile.y
assert mars_tile.z == earth_tile.z == 3

_to_geographic = pyproj.Transformer.from_crs(
mars_tms.crs._pyproj_crs, MARS2000_SPHERE, always_xy=True
)
bbox = _to_geographic.transform_bounds(*mars_tms.xy_bbox, densify_pts=21)
assert bbox == mars_tms.bbox


def test_mars_local_tms():
"""Local TMS using Mars CRS"""
MARS2000_SPHERE = pyproj.CRS.from_proj4("+proj=longlat +R=3396190 +no_defs")

# A transverse mercator projection for the landing site of the Perseverance rover.
SYRTIS_TM = pyproj.CRS.from_proj4(
"+proj=tmerc +lat_0=17 +lon_0=76.5 +k=0.9996 +x_0=0 +y_0=0 +a=3396190 +b=3376200 +units=m +no_defs"
Expand All @@ -362,15 +379,21 @@ def test_mars_local_tms():
[-5e5, -5e5, 5e5, 5e5],
SYRTIS_TM,
title="Web Mercator Mars",
geographic_crs=MARS2000_SPHERE,
)
assert SYRTIS_TM == syrtis_tms.crs._pyproj_crs
assert syrtis_tms.geographic_crs
vincentsarago marked this conversation as resolved.
Show resolved Hide resolved
assert syrtis_tms.model_dump(mode="json")

center = syrtis_tms.ul(1, 1, 1)
assert round(center.x, 6) == 76.5
assert round(center.y, 6) == 17

_to_geographic = pyproj.Transformer.from_crs(
syrtis_tms.crs._pyproj_crs, MARS2000_SPHERE, always_xy=True
)
bbox = _to_geographic.transform_bounds(*syrtis_tms.xy_bbox, densify_pts=21)
assert bbox == syrtis_tms.bbox


@pytest.mark.parametrize(
"identifier, file, crs",
Expand Down Expand Up @@ -558,7 +581,6 @@ def test_boundingbox():
def test_private_attr():
"""Check private attr."""
tms = morecantile.tms.get("WebMercatorQuad")
assert "_geographic_crs" in tms.__private_attributes__
assert "_to_geographic" in tms.__private_attributes__
assert "_from_geographic" in tms.__private_attributes__

Expand Down
Loading