Add image service layers to address #932 by tsutterley · Pull Request #933 · jupyter-widgets/ipyleaflet

tsutterley · 2022-03-03T07:38:31Z

Queries ESRI Image Service APIs and adds image layers similar to an ImageOverlay. Image Service APIs allow the creation of mosaics with options for pre-defined raster functions, interpolation strategies, band combinations, time ranges, etc.

Additional updates to projections to add EPSG:5936 (Alaska Polar Stereographic) and more EPSG:3031 (Antarctic Polar Stereographic) options

martinRenou

Neat! Thanks!

ipyleaflet/leaflet.py

js/src/layers/ImageServiceLayer.js

martinRenou · 2022-03-23T08:27:04Z

Thanks I'll try to find time to test this out and review :)

tsutterley · 2022-04-18T18:36:15Z

Ok! I think this is at a good place for review. I needed to extend from a Layer model versus a RasterLayer model and that fixed my JS-Python binding issues

s-m-t-c · 2022-06-01T06:42:09Z

The additional Polar projected WMS examples in CustomProjections.ipynb helped resolve an issue I had recently.

dshean · 2022-08-24T16:43:48Z

Hi all. Wondering about status of this PR. @martinRenou, any other changes required?
This functionality will be really useful for interactive mapping applications in the polar regions (increasingly important), and having upstream support will be better than current workarounds. Thanks!

HaudinFlorence · 2022-08-26T14:23:30Z

Thanks for this PR. This works well (as shown on this video produced with using the example notebook ImageService.ipynb)

HaudinFlorence · 2022-08-26T14:38:11Z

js/src/layers/ImageService.js

+      // image server url
+      url: '',
+      // response format
+      f: 'image',
+      // output image format
+      format: 'jpgpng',
+      // data type of the raster image
+      pixelType: 'UNKNOWN',
+      // pixel value or list of pixel values representing no data
+      noData: [],
+      // how to interpret no data values
+      noDataInterpretation: '',
+      // resampling process for interpolating the pixel values
+      interpolation: '',
+      // lossy quality for image compression
+      compressionQuality: '',
+      // order of bands to export for multiple band images
+      bandIds: [],
+      // time instance or extent for image
+      time: [],
+      // rules for rendering
+      renderingRule: {},
+      // rules for mosaicking
+      mosaicRule: {},
+      // image transparency
+      transparent: false,
+      // endpoint format for building the export image url
+      endpoint: '',
+      // image service attribution
+      attribution: '',
+      // coordinate reference system
+      crs: null,
+      // emit when clicked or hovered
+      interactive: false,
+      // update interval for panning
+      updateInterval: 200


This a detail point but from an homogeneity point of view, description of the attributes are only set on the python side, in the docstrings.

I am wondering, if the layers from ImageService are also available in wmts (I think so if I am refering to their webpage https://enterprise.arcgis.com/en/image/latest/get-started/windows/what-is-an-image-service.htm) in such a way we could add them to the xyz-services tilelayers provider used in ipyleaflet? This may be an alternative way of using the layers from ImageService

Hi @HaudinFlorence, great question. I wanted to put this PR together to address ImageService layers that do not have layers available from other services. This was the case for digital elevation model products from the Polar Geospatial Center (PGC), such as REMA and ArcticDEM. While ArcticDEM does have a WMS url for the gray hillshade layer, it doesn't for any other layer. REMA, unfortunately, is only available through ImageService queries. One of my colleagues suggested I just try to prompt PGC to add more services, but I thought as a first step it might be easier to add the same capabilities available through the DEM web applications to ipyleaflet.

This a detail point but from an homogeneity point of view, description of the attributes are only set on the python side, in the docstrings.

Great point. I removed these comments in 93394bf

betolink · 2022-09-01T05:45:08Z

This looks neat!! @davidbrochart can you guys take a look and consider a merge?

davidbrochart

Thanks a lot @tsutterley!
I commented mainly to have more explanation and understand better.
It's still not clear to me if the ImageService is something only provided by ESRI, or if there are other providers.
Maybe @betolink can answer some questions too, as he knows quite a lot in this area!

davidbrochart · 2022-09-02T08:39:31Z

examples/CustomProjections.ipynb

+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# note that we need to use the same projection for the our layer and the map.\n",


Suggested change

"# note that we need to use the same projection for the our layer and the map.\n",

"# note that we need to use the same projection for the layer and the map.\n",

davidbrochart · 2022-09-02T08:45:23Z

examples/ImageService.ipynb

+    "    return u'{0:d}\\u2013{1:d}'.format(st.tm_year,et.tm_year)\n",
+    "\n",
+    "range_dropdown1 = Dropdown(\n",
+    "    value=u'{0:d}\\u2013{1:d}'.format(1980,1989),\n",


Suggested change

" value=u'{0:d}\\u2013{1:d}'.format(1980,1989),\n",

" value=range_formatter(years[0]),\n",

davidbrochart · 2022-09-02T08:55:19Z

examples/ImageService.ipynb

+    "\n",
+    "# watch year range function widget for changes\n",
+    "range_dropdown1.observe(set_year_range)\n",
+    "m1"


No image is displayed for zoom 9 and years 1980-1989.

Great point. I wasn't the happiest with this example so I removed it.

davidbrochart · 2022-09-02T08:56:20Z

examples/ImageService.ipynb

+   "outputs": [],
+   "source": [
+    "# ArcticDEM\n",
+    "# note that we need to use the same projection for the our image service layer and the map.\n",


Suggested change

"# note that we need to use the same projection for the our image service layer and the map.\n",

"# note that we need to use the same projection for the image service layer and the map.\n",

davidbrochart · 2022-09-02T09:00:31Z

examples/ImageService.ipynb

+    "    \"Height Orthometric\",\n",
+    "    \"Slope Map\"]\n",
+    "raster_dropdown2 = Dropdown(\n",
+    "    value=\"Hillshade Gray\",\n",


Suggested change

" value=\"Hillshade Gray\",\n",

" value=raster_functions[3],\n",

great change 👍

davidbrochart · 2022-09-02T09:10:45Z

ipyleaflet/leaflet.py

+    time: List, default []
+        time instance or extent for image
+    rendering_rule: dict, default {}
+        rules for rendering


What are possible values?

great point. I added an enumerated list of possible values

davidbrochart · 2022-09-02T09:12:55Z

ipyleaflet/leaflet.py

+    mosaic_rule: dict, default {}
+        rules for mosaicking
+    transparent: boolean, default False
+        If true, the image service will return images with transparency


I tried setting transparent=True but it doesn't seem to have any effect?

right... this appears to be defunct. I removed the option.

davidbrochart · 2022-09-02T09:13:47Z

ipyleaflet/leaflet.py

+    crs: dict, default ipyleaflet.projections.EPSG3857
+        Projection used for this image service.
+    interactive: bool, default False
+        Emit when clicked or hovered


What is emitted?

I added a handler for click events when interactive is True 👍

davidbrochart · 2022-09-02T09:14:08Z

ipyleaflet/leaflet.py

+    interactive: bool, default False
+        Emit when clicked or hovered
+    update_interval: int, default 200
+        Update interval for panning


What is updated? What is the unit of this value?

Great point. I expanded the description here. This is using L.Toggle with units in ms

ipyleaflet/projections.py

docs: add options to `format`, `pixel_type`, `no_data_interpretation` and `endpoint` feat: add function for handling mouse clicks refactor: remove columbia glacier example remove transparency option (defunct)

betolink

I think the branch is ready to be merged with a minor observation on the layer naming convention. This work will allow us to use more base layers in polar projections which has been needed for a long time! @davidbrochart @dshean

ipyleaflet/projections.py

proj changes in notebook

ipyleaflet/projections.py

examples/ImageService.ipynb

betolink · 2022-10-26T03:52:40Z

Is there any particular thing @tsutterley needs for this PR @davidbrochart? I see just one change request but perhaps was already addressed?

davidbrochart

Thanks a lot @tsutterley, this looks great!
Just some minor comments, but for me this is ready to merge.
Maybe @martinRenou wants to take a look?

davidbrochart · 2022-10-26T07:24:44Z

ipyleaflet/leaflet.py

+    format: string, default "jpgpng"
+        format of exported image
+
+        - ``jpgpng``


Did you mean:

Suggested change

- ``jpgpng``

- `'jpgpng'`

@tsutterley ?

put the docstring edits in! thanks @davidbrochart

But shouldn't it be:

`'jpgpng'`

instead of:

``"jpgpng"``

are the docstrings in ipyleaflet rendered from markdown and not restructuredtext?

Yes you're right, I think it's reStructuredText 👍

davidbrochart · 2022-10-26T07:26:18Z

ipyleaflet/leaflet.py

+        - ``U4``
+        - ``U8``
+        - ``UNKNOWN``
+    no_data: list, default []


Maybe:

Suggested change

no_data: list, default []

no_data: List[int], default []

martinRenou

LGTM!

martinRenou · 2022-10-27T15:59:35Z

This looks super nice thank you!

tsutterley marked this pull request as draft March 3, 2022 07:38

tsutterley force-pushed the imageserver branch from 9df09cf to 337705e Compare March 3, 2022 07:42

martinRenou reviewed Mar 3, 2022

View reviewed changes

ipyleaflet/leaflet.py Outdated Show resolved Hide resolved

js/src/layers/ImageServiceLayer.js Outdated Show resolved Hide resolved

tsutterley force-pushed the imageserver branch 2 times, most recently from f5d8a1b to 508837a Compare March 9, 2022 02:13

tsutterley force-pushed the imageserver branch 6 times, most recently from bbc108c to 7e2b068 Compare March 18, 2022 18:26

tsutterley force-pushed the imageserver branch 3 times, most recently from 7f1b56d to 2291070 Compare March 19, 2022 00:05

tsutterley marked this pull request as ready for review March 21, 2022 00:01

This comment was marked as resolved.

Sign in to view

tsutterley changed the title ~~feat: starting work on adding image service layers to address #932~~ [WIP] adding image service layers to address #932 Apr 18, 2022

tsutterley force-pushed the imageserver branch 2 times, most recently from a3da296 to e138882 Compare April 18, 2022 18:52

tsutterley changed the title ~~[WIP] adding image service layers to address #932~~ Add image service layers to address #932 Apr 18, 2022

tsutterley force-pushed the imageserver branch from f8f7a76 to ae41b97 Compare April 19, 2022 00:01

tsutterley force-pushed the imageserver branch from 63a0a38 to ead71bf Compare June 9, 2022 21:35

Adding image service layers to address jupyter-widgets#932

bfaa1c8

tsutterley force-pushed the imageserver branch from 1a51296 to bfaa1c8 Compare July 20, 2022 19:32

HaudinFlorence reviewed Aug 29, 2022

View reviewed changes

drop comments on imageservice options

93394bf

davidbrochart reviewed Sep 2, 2022

View reviewed changes

tsutterley added 2 commits September 4, 2022 17:42

review updates

a15c3bb

docs: add options to `format`, `pixel_type`, `no_data_interpretation` and `endpoint` feat: add function for handling mouse clicks refactor: remove columbia glacier example remove transparency option (defunct)

add whitespace to fix linting error

3bf86c5

betolink approved these changes Oct 12, 2022

View reviewed changes

ipyleaflet/projections.py Show resolved Hide resolved

ipyleaflet/projections.py Show resolved Hide resolved

update projection names following Beto's review

0dbaaf3

proj changes in notebook

tsutterley force-pushed the imageserver branch from 425a1e2 to 0dbaaf3 Compare October 14, 2022 16:36

davidbrochart reviewed Oct 17, 2022

View reviewed changes

ipyleaflet/projections.py Show resolved Hide resolved

davidbrochart requested changes Oct 19, 2022

View reviewed changes

examples/ImageService.ipynb Outdated Show resolved Hide resolved

examples/ImageService.ipynb Outdated Show resolved Hide resolved

tsutterley added 2 commits October 19, 2022 04:10

Fix proj for image service example

16629b0

Merge branch 'jupyter-widgets:master' into imageserver

d31fbc9

davidbrochart approved these changes Oct 26, 2022

View reviewed changes

tsutterley added 2 commits October 26, 2022 06:55

JS lint fixes

89c1852

docstring edits for review comments

c155067

martinRenou approved these changes Oct 27, 2022

View reviewed changes

martinRenou merged commit aabb752 into jupyter-widgets:master Oct 27, 2022

tsutterley deleted the imageserver branch October 27, 2022 15:48

	"# note that we need to use the same projection for the our layer and the map.\n",
	"# note that we need to use the same projection for the layer and the map.\n",

	" value=u'{0:d}\\u2013{1:d}'.format(1980,1989),\n",
	" value=range_formatter(years[0]),\n",

	" value=\"Hillshade Gray\",\n",
	" value=raster_functions[3],\n",

Conversation

tsutterley commented Mar 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

martinRenou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

martinRenou commented Mar 23, 2022

Uh oh!

tsutterley commented Apr 18, 2022

Uh oh!

s-m-t-c commented Jun 1, 2022

Uh oh!

dshean commented Aug 24, 2022

Uh oh!

HaudinFlorence commented Aug 26, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HaudinFlorence Aug 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

betolink commented Sep 1, 2022

Uh oh!

davidbrochart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

betolink left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

betolink commented Oct 26, 2022

Uh oh!

davidbrochart left a comment

tsutterley commented Mar 3, 2022 •

edited

Loading

HaudinFlorence Aug 29, 2022 •

edited

Loading

betolink left a comment •

edited

Loading