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

add support for tiling colormap configuration #392

Merged
merged 2 commits into from
May 28, 2024
Merged

add support for tiling colormap configuration #392

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1681da
add support for tiling colormap configuration
May 24, 2024
7ba4d12
add colormap example in config example
May 28, 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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## Unreleased

### Added

- Support for scene and mosaic tiling `colormap` configuration.

## 5.4.0 - 2024-05-16

### Fixed
Expand Down
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ The file `config_helper/config.example.json` is included in this repository as r
| DEFAULT_COLLECTION | Default collection option for collection dropdown | Optional |
| COLLECTIONS | Array of strings listing collections to show in dropdown. This is used to filter the collections endpoint from the list fetched from the `STAC_API_URL` defined in the config. Collection property of `id` must be used. If set, only the matched collections will show in the app. If not set, all collections in the STAC API will show in dropdown. | Optional |
| SCENE_TILER_URL | URL for map tiling | Optional |
| SCENE_TILER_PARAMS | Per-collection configuration of TiTiler `assets`, `color_formula`, `bidx`, `rescale`, `expression`, and `colormap_name` parameters. Example in [config.example.json](config_helper/config.example.json) | Optional |
| SCENE_TILER_PARAMS | Per-collection configuration of TiTiler `assets`, `color_formula`, `bidx`, `rescale`, `expression`, `colormap_name`, and `colormap` parameters. Example in [config.example.json](config_helper/config.example.json) | Optional |
| MOSAIC_MIN_ZOOM_LEVEL | Minimum zoom level for mosaic view search results. If not set, the default zoom level will be 7. | Optional |
| ACTION_BUTTON | Button text and redirect URL used to link to external website as a prominent call to action. If not set, the button will not be visible. Should be an object with `text` and `url` keys. Example: [config.example.json](config_helper/config.example.json). | Optional |
| MOSAIC_TILER_URL | URL for mosaic tiling. If not set, the View Mode selector will not be visible. The app requires the use of the [NASA IMPACT TiTiler fork](https://github.com/NASA-IMPACT/titiler) as it contains the mosaicjson endpoints needed. | Optional |
| MOSAIC_TILER_PARAMS | Per-collection configuration of TiTiler mosaic `assets`, `color_formula`, `bidx`, `rescale`, `expression`, and `colormap_name` parameters. Example in [config.example.json](config_helper/config.example.json) | Optional |
| MOSAIC_TILER_PARAMS | Per-collection configuration of TiTiler mosaic `assets`, `color_formula`, `bidx`, `rescale`, `expression`, `colormap_name`, and `colormap` parameters. Example in [config.example.json](config_helper/config.example.json) | Optional |
| MOSAIC_MAX_ITEMS | Maximum number of items in mosaic. If not set, the default max items will be 100. | Optional |
| CONFIG_COLORMAP | Color map used in low level hex grid search results. Complete list of colormaps are available here: [bpostlethwaite/colormap](https://github.com/bpostlethwaite/colormap). If not set, the default colormap will be "viridis". | Optional |
| BASEMAP_URL | URL to specify a basemap provider used by the leaflet map. Must be a raster tile provider as vector tiles are not supported. If not set, the default colormap will be `https://tile.openstreetmap.org/{z}/{x}/{y}.png`. | Optional |
Expand Down Expand Up @@ -215,9 +215,29 @@ The configurations include:
- `bidx`: if a single asset is defined, these indicies are used as the band indicies within that
image to composite.
- `colormap_name`: the colormap to use for mapping values (typically used for single band)
- `colormap`: a colormap of values to hex colors to use for mapping values (typically used for single band)
- `rescale`: the rescale range to apply prior to color mapping (typically used for single band)
- `nodata`: the nodata value to use, if not in image metadata

An example of a `colormap` configuration is:

```text
"colormap": {
"0": "#000000",
"1": "#419bdf",
"2": "#397d49",
"3": "#000000",
"4": "#7a87c6",
"5": "#e49635",
"6": "#000000",
"7": "#c4281b",
"8": "#a59b8f",
"9": "#a8ebff",
"10": "#616161",
"11": "#e3e2c3"
}
```

### Mosaic Tiling Configuration

Configuration of mosaic tiling is the same as for scene tiling, with the additional constraint
Expand Down
10 changes: 10 additions & 0 deletions src/utils/mapHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,9 @@ const constructSceneTilerParams = (collection) => {
const colormapName = parameters.colormapName(tilerParams, collection)
if (colormapName) params.push(colormapName)

const colormap = parameters.colormap(tilerParams, collection)
if (colormap) params.push(colormap)

return params.join('&')
}

Expand Down Expand Up @@ -507,6 +510,10 @@ const parameters = {
const value = tilerParams[collection]?.colormap_name
return value && `colormap_name=${value}`
},
colormap: (tilerParams, collection) => {
const value = tilerParams[collection]?.colormap
return value && `colormap=${encodeURIComponent(JSON.stringify(value))}`
},
bidx: (tilerParams, collection, asset) => {
const value = tilerParams[collection]?.bidx
// for scene tiler
Expand Down Expand Up @@ -565,6 +572,9 @@ export const constructMosaicTilerParams = (collection) => {
const colormapName = parameters.colormapName(tilerParams, collection)
if (colormapName) params.push(colormapName)

const colormap = parameters.colormap(tilerParams, collection)
if (colormap) params.push(colormap)

return params.join('&')
}

Expand Down
Loading