Add a function `basemap` to get a static image from Tyler, and some converts for image #91

asinghvi17 · 2024-07-09T08:15:44Z

This file provides the ability to get static base maps from Tyler.

Its main entry point is the basemap function, which returns a tuple
(x, y, z) of the image data (z) and its axes (x and y). The image
is in a web-mercator CRS, we need to figure out a way to also get eg WGS84 tiles.

This file also contains definitions for convert_arguments that make
the following syntax "just work":

image(TileProviders.Google(), Rect2f(-0.0921, 51.5, 0.04, 0.025), (1000, 1000); axis= (; aspect = DataAspect()))

You do still have to provide the extent and image size, but this is substantially better than nothing.

asinghvi17 · 2024-07-09T09:07:11Z

(This doesn't work now but will work with #90, since that imports FileIO)

Thoughts? How do we determine which CRS the input bbox takes? Its currently WGS84 but do we want to give an option to go to webmerc at all? Conversion between the two is mostly lossless...

rafaqz · 2024-07-09T12:01:54Z

Is there a reason basemap isn't in MapTiles.jl ?

Would let other packages skip the Makie dep

asinghvi17 · 2024-07-09T12:05:38Z

HTTP.jl and ImageIO.jl are required to stitch the tiles together, but if those can go in MapTiles I'm fine to upstream this

rafaqz · 2024-07-09T13:41:37Z

Ahh right. Might be worth it for Plots.jl uses

asinghvi17 · 2024-08-03T11:12:40Z

This will have to be reimplemented based off #95

lazarusA · 2024-09-26T16:28:16Z

please add these lines at the end of our .css file

/* Component: Docstring Custom Block */

.jldocstring.custom-block {
  border: 1px solid var(--vp-c-gray-2);
  color: var(--vp-c-text-1)
}

.jldocstring.custom-block summary {
  font-weight: 700;
  cursor: pointer;
  user-select: none;
  margin: 0 0 8px;
}

Edit: Also, it looks like your examples are not working.

rafaqz

This is good, but it kinda seems to me like basemap should return a Raster so it's one self contained object with all the metadata needed to plot in GeoMakie etc

Of course, dependencies etc make that more annoying

src/basemap.jl

rafaqz · 2024-09-26T16:49:18Z

docs/src/basemap.md

+````@example nasagibs
+meshimage(
+    xs, ys, img; 
+    source = "+proj=webmerc", # REMEMBER: `img` is always in Web Mercator...


would be nice if we kept crs and lookups attached - I think there is a package that does that ;)

That's true :D - but then we'd have to add that as a dependency to Tyler as well.

The other alternative is to add ImageIO and HTTP dependencies to MapTiles or TileProviders, and have them prompt individually. But I don't think we want that...

It would be nice to have a method of basemap that returned a Raster at least, in an extension here or in Rasters.

Question is how to trigger it. We could just pass the Raster type as the first argument?

I would go the other way and create a constructor for Raster(::TileProvider, extent; size, res, ...).

This way it's at least a similar interface to what RasterDataSources has, for example

Right, just call basemap internally to get the data. A bit like RasterDataSources.jl syntax

Whats weird about that is it would need using Tyler which needs Makie when it really just needs ImageIO and HTTP

It's the ImageIO part that gives me the shivers, since it's a lot of heavy binary dependencies

I'm more scared of the Makie precompile time for Plots.jl users

rafaqz · 2024-09-26T17:17:21Z

src/basemap.jl

+    return basemap(provider, bbox, _size; min_zoom_level, max_zoom_level)
+end
+
+function basemap(provider::TileProviders.AbstractProvider, boundingbox::Union{Rect2{<: Real}, Extent}, size::Tuple{Int, Int}; min_zoom_level = 0, max_zoom_level = 16)


Shouldn't size allow a NamedTuple here?

Oh right thats handled above. Maybe make this _basemap then so its internal

That sounds complicated - should it? I don't see that anywhere else as well

Then you have to handle (; X, Y), (; Y, X), ...

I just read in _z_index docs that res should be (X=res, Y=res) so thought that was the idea with size/res here. Most of Rasters works like this too so it makes sense to me

rafaqz · 2024-09-26T17:25:46Z

src/basemap.jl

+
+## Keyword arguments
+
+`size` and `res` are mutually exclusive, and you must provide one.


Would be good to mention that they are approximate

rafaqz · 2024-09-26T17:26:26Z

src/basemap.jl

+`size` and `res` are mutually exclusive, and you must provide one.
+
+`min_zoom_level - 0` and `max_zoom_level = 16` are the minimum and maximum zoom levels to consider.
+


Could we also just let users specify z here?

As an alternative to res and size, yes

rafaqz · 2024-09-26T17:39:59Z

src/basemap.jl

+    - Some function that returns the tile size for a given provider / dispatch form
+    =#
+    tile_widths = (256, 256)
+    tilegrid_size = tile_widths .* length.(tilegrid.grid.indices)


We should warn here if this is too big. Probably people don't intend to get more than 100MB or so? and its pretty easy to accidentally ask for a 100GB

Yeah, that could be an annoying footgun if using res instead of size

asinghvi17 mentioned this pull request Jul 9, 2024

Add a function basemap and some converts for image #89

Closed

lazarusA mentioned this pull request Jul 9, 2024

Bump Makie compat to v0.21 #90

Merged

asinghvi17 added 9 commits July 9, 2024 13:25

Add a function basemap and some converts for image

d22d733

Make this work properly in a fresh env

622cb76

Fix the kwarg asserts

79fd4c5

Return an image in WebMercator to be consistent

9c37396

Thoughts? How do we determine which CRS the input bbox takes? Its currently WGS84 but do we want to give an option to go to webmerc at all? Conversion between the two is mostly lossless...

Fix tests

7bde166

Really fix tests

e756e9d

grrrrrr

2fdfd45

Use the new FileIO approach

860040d

Add a basic basemap page (needs a lot of help)

1a4bcad

asinghvi17 force-pushed the as/basemap branch from 1ce6d0a to 1a4bcad Compare July 9, 2024 11:25

asinghvi17 marked this pull request as draft August 3, 2024 11:12

SimonDanisch and others added 3 commits August 13, 2024 10:04

Merge branch 'master' into as/basemap

bc8fc9f

Merge branch 'master' into as/basemap

ffc0d48

Merge remote-tracking branch 'origin/master' into as/basemap

489a5ef

asinghvi17 self-assigned this Sep 26, 2024

asinghvi17 added 2 commits September 26, 2024 06:47

Get basemap working again

f25d5b6

Better docs + export basemap

5467c20

asinghvi17 marked this pull request as ready for review September 26, 2024 14:12

asinghvi17 requested review from SimonDanisch, rafaqz and lazarusA and removed request for SimonDanisch and rafaqz September 26, 2024 14:12

asinghvi17 requested review from SimonDanisch, rafaqz and lazarusA and removed request for lazarusA and SimonDanisch September 26, 2024 14:12

asinghvi17 added 2 commits September 26, 2024 07:53

fix doc build

1f19bb7

more fixes

00b3800

rafaqz reviewed Sep 26, 2024

View reviewed changes

asinghvi17 added 2 commits September 26, 2024 10:14

Try to fix docs again

c4cd63e

Apply suggestion from code review

3642f7b

rafaqz reviewed Sep 26, 2024

View reviewed changes

use Extents everywhere

8b6338f

rafaqz reviewed Sep 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a function `basemap` to get a static image from Tyler, and some converts for image #91

Add a function `basemap` to get a static image from Tyler, and some converts for image #91

asinghvi17 commented Jul 9, 2024

asinghvi17 commented Jul 9, 2024 •

edited

Loading

rafaqz commented Jul 9, 2024

asinghvi17 commented Jul 9, 2024

rafaqz commented Jul 9, 2024

asinghvi17 commented Aug 3, 2024

lazarusA commented Sep 26, 2024 •

edited

Loading

rafaqz left a comment •

edited

Loading

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024

rafaqz Sep 26, 2024 •

edited

Loading

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024

asinghvi17 Sep 26, 2024

rafaqz Sep 26, 2024

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024 •

edited

Loading

rafaqz Sep 26, 2024

rafaqz Sep 26, 2024

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024

asinghvi17 Sep 26, 2024

rafaqz Sep 26, 2024

rafaqz Sep 26, 2024

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024

rafaqz Sep 26, 2024

asinghvi17 Sep 26, 2024


		## Keyword arguments

		`size` and `res` are mutually exclusive, and you must provide one.

		`size` and `res` are mutually exclusive, and you must provide one.

		`min_zoom_level - 0` and `max_zoom_level = 16` are the minimum and maximum zoom levels to consider.

Add a function basemap to get a static image from Tyler, and some converts for image #91

Are you sure you want to change the base?

Add a function basemap to get a static image from Tyler, and some converts for image #91

Conversation

asinghvi17 commented Jul 9, 2024

asinghvi17 commented Jul 9, 2024 • edited Loading

rafaqz commented Jul 9, 2024

asinghvi17 commented Jul 9, 2024

rafaqz commented Jul 9, 2024

asinghvi17 commented Aug 3, 2024

lazarusA commented Sep 26, 2024 • edited Loading

rafaqz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafaqz Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asinghvi17 Sep 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add a function `basemap` to get a static image from Tyler, and some converts for image #91

Add a function `basemap` to get a static image from Tyler, and some converts for image #91

asinghvi17 commented Jul 9, 2024 •

edited

Loading

lazarusA commented Sep 26, 2024 •

edited

Loading

rafaqz left a comment •

edited

Loading

rafaqz Sep 26, 2024 •

edited

Loading

asinghvi17 Sep 26, 2024 •

edited

Loading