Skip to content

Add support for TiTiler-CMR #1289

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

Merged
giswqs merged 1 commit into from
Jan 27, 2026
Merged

Add support for TiTiler-CMR #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
445 changes: 445 additions & 0 deletions docs/notebooks/113_titiler_cmr.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions leafmap/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9110,6 +9110,31 @@ def arc_add_layer(url, name=None, shown=True, opacity=1.0):
layer.transparency = 100 - (opacity * 100)


def is_global_bounds(bounds, tolerance=1.0):
"""Check if bounds represent global extent.

Args:
bounds (list): Bounding box as [minx, miny, maxx, maxy].
Comment on lines +9113 to +9117

Copilot AI Jan 27, 2026

Copy link

Choose a reason for hiding this comment

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

is_global_bounds is new behavior that affects map zooming decisions. The repo has existing common module tests (tests/test_common.py); please add unit tests for representative inputs (global bounds, near-global within tolerance, non-global, invalid length/None) to prevent regressions.

Copilot uses AI. Check for mistakes.
tolerance (float): Tolerance for comparing bounds to global extent.
Defaults to 1.0 degree.

Returns:
bool: True if bounds are approximately global [-180, -90, 180, 90].
"""
if bounds is None or len(bounds) != 4:
return False

minx, miny, maxx, maxy = bounds
global_bounds = [-180.0, -90.0, 180.0, 90.0]

return (
abs(minx - global_bounds[0]) <= tolerance
and abs(miny - global_bounds[1]) <= tolerance
and abs(maxx - global_bounds[2]) <= tolerance
and abs(maxy - global_bounds[3]) <= tolerance
)


def arc_zoom_to_extent(xmin, ymin, xmax, ymax):
"""Zoom to an extent in ArcGIS Pro.

Expand Down
107 changes: 107 additions & 0 deletions leafmap/foliumap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1709,6 +1709,113 @@ def add_stac_layer(
self.fit_bounds([[bounds[1], bounds[0]], [bounds[3], bounds[2]]])
common.arc_zoom_to_extent(bounds[0], bounds[1], bounds[2], bounds[3])

def add_cmr_layer(
self,
concept_id: str,
datetime: Optional[str] = None,
backend: str = "rasterio",
variable: Optional[str] = None,
bands: Optional[Union[str, List[str]]] = None,
bands_regex: Optional[str] = None,
expression: Optional[str] = None,
name: Optional[str] = "CMR Layer",
attribution: Optional[str] = "NASA Earthdata",
opacity: Optional[float] = 1.0,
shown: Optional[bool] = True,
rescale: Optional[Union[str, List]] = None,
colormap_name: Optional[str] = None,
color_formula: Optional[str] = None,
titiler_cmr_endpoint: Optional[str] = None,
zoom_to_layer: Optional[bool] = True,
**kwargs,
) -> None:
"""Adds a NASA Earthdata CMR layer to the map using TiTiler CMR.

This method allows you to visualize NASA Earthdata collections directly
on the map using the TiTiler CMR endpoint.

Args:
concept_id (str): NASA CMR collection concept ID (e.g., 'C2036881735-POCLOUD').
datetime (str, optional): RFC3339 datetime or range (e.g., '2024-01-15' or
'2024-01-01/2024-01-31'). Defaults to None.
backend (str, optional): Backend to use - 'rasterio' for COGs or 'xarray' for
NetCDF/Zarr. Defaults to 'rasterio'.
variable (str, optional): Variable name for xarray backend datasets. Required
when using backend='xarray'.
bands (str | list, optional): Band name(s) for rasterio backend.
bands_regex (str, optional): Regex pattern for selecting bands (e.g., 'B[0-9][0-9]').
expression (str, optional): Band math expression (e.g., '(B05-B04)/(B05+B04)').
name (str, optional): The layer name. Defaults to 'CMR Layer'.
attribution (str, optional): Attribution text. Defaults to 'NASA Earthdata'.
opacity (float, optional): Layer opacity (0.0 to 1.0). Defaults to 1.0.
shown (bool, optional): Whether the layer is visible. Defaults to True.
rescale (str | list, optional): Min/max values for rescaling (e.g., '270,305'
or [[270, 305]]).
colormap_name (str, optional): Name of colormap (e.g., 'thermal', 'viridis').
color_formula (str, optional): Color formula (e.g., 'Gamma RGB 3.5 Saturation 1.7').
titiler_cmr_endpoint (str, optional): TiTiler CMR endpoint URL.
zoom_to_layer (bool, optional): Whether to zoom to the layer extent. Defaults to True.
**kwargs: Additional arguments passed to the TiTiler CMR endpoint.

Examples:
>>> import leafmap.foliumap as leafmap
>>> m = leafmap.Map()
>>> m.add_cmr_layer(
... concept_id="C2036881735-POCLOUD",
... datetime="2024-01-15",
... backend="xarray",
... variable="analysed_sst",
... rescale="270,305",
... colormap_name="thermal",
... name="Sea Surface Temperature"
... )
"""
from .stac import cmr_tile, cmr_bounds

if os.environ.get("USE_MKDOCS") is not None:
return

tile_url = cmr_tile(
concept_id=concept_id,
datetime=datetime,
backend=backend,
variable=variable,
bands=bands,
bands_regex=bands_regex,
expression=expression,
rescale=rescale,
colormap_name=colormap_name,
color_formula=color_formula,
titiler_cmr_endpoint=titiler_cmr_endpoint,
**kwargs,
)

if tile_url is None:
print("Failed to get CMR tile URL")
return

self.add_tile_layer(
url=tile_url,
name=name,
attribution=attribution,
opacity=opacity,
shown=shown,
)

if zoom_to_layer:
bounds = cmr_bounds(
concept_id=concept_id,
datetime=datetime,
backend=backend,
variable=variable,
titiler_cmr_endpoint=titiler_cmr_endpoint,
)
# Skip zooming if bounds are global (TiTiler CMR returns global bounds
# when actual data bounds are not available)
if bounds is not None and not common.is_global_bounds(bounds):
self.fit_bounds([[bounds[1], bounds[0]], [bounds[3], bounds[2]]])
common.arc_zoom_to_extent(bounds[0], bounds[1], bounds[2], bounds[3])

def add_mosaic_layer(
self,
url: str,
Expand Down
229 changes: 229 additions & 0 deletions leafmap/leafmap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1237,6 +1237,235 @@ def add_stac_layer(

self.cog_layer_dict[name] = params

def add_cmr_layer(
self,
concept_id: str,
datetime: Optional[str] = None,
backend: str = "rasterio",
Comment on lines +1240 to +1244

Copilot AI Jan 27, 2026

Copy link

Choose a reason for hiding this comment

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

No tests cover the new CMR integration methods (add_cmr_layer/add_cmr_timeseries). The repo has an established unittest suite (e.g., tests/test_leafmap.py) and uses mocking elsewhere. Please add tests that mock the underlying leafmap.stac.cmr_* functions (or requests) to verify layer addition/fit-bounds behavior and that time slider layers are constructed correctly, without requiring network access.

Copilot uses AI. Check for mistakes.
variable: Optional[str] = None,
bands: Optional[Union[str, List[str]]] = None,
bands_regex: Optional[str] = None,
expression: Optional[str] = None,
name: str = "CMR Layer",
attribution: str = "NASA Earthdata",
opacity: float = 1.0,
shown: bool = True,
rescale: Optional[Union[str, List]] = None,
colormap_name: Optional[str] = None,
color_formula: Optional[str] = None,
titiler_cmr_endpoint: Optional[str] = None,
zoom_to_layer: bool = True,
layer_index: Optional[int] = None,
**kwargs,
) -> None:
"""Adds a NASA Earthdata CMR layer to the map using TiTiler CMR.

This method allows you to visualize NASA Earthdata collections directly
on the map using the TiTiler CMR endpoint.

Args:
concept_id (str): NASA CMR collection concept ID (e.g., 'C2036881735-POCLOUD').
datetime (str, optional): RFC3339 datetime or range (e.g., '2024-01-15' or
'2024-01-01/2024-01-31'). Defaults to None.
backend (str, optional): Backend to use - 'rasterio' for COGs or 'xarray' for
NetCDF/Zarr. Defaults to 'rasterio'.
variable (str, optional): Variable name for xarray backend datasets. Required
when using backend='xarray'.
bands (str | list, optional): Band name(s) for rasterio backend.
bands_regex (str, optional): Regex pattern for selecting bands (e.g., 'B[0-9][0-9]').
expression (str, optional): Band math expression (e.g., '(B05-B04)/(B05+B04)').
name (str, optional): The layer name. Defaults to 'CMR Layer'.
attribution (str, optional): Attribution text. Defaults to 'NASA Earthdata'.
opacity (float, optional): Layer opacity (0.0 to 1.0). Defaults to 1.0.
shown (bool, optional): Whether the layer is visible. Defaults to True.
rescale (str | list, optional): Min/max values for rescaling (e.g., '270,305'
or [[270, 305]]).
colormap_name (str, optional): Name of colormap (e.g., 'thermal', 'viridis').
color_formula (str, optional): Color formula (e.g., 'Gamma RGB 3.5 Saturation 1.7').
titiler_cmr_endpoint (str, optional): TiTiler CMR endpoint URL.
zoom_to_layer (bool, optional): Whether to zoom to the layer extent. Defaults to True.
layer_index (int, optional): Index to insert the layer. Defaults to None.
**kwargs: Additional arguments passed to the TiTiler CMR endpoint.

Examples:
>>> # Sea Surface Temperature using xarray backend
>>> m = leafmap.Map()
>>> m.add_cmr_layer(
... concept_id="C2036881735-POCLOUD",
... datetime="2024-01-15",
... backend="xarray",
... variable="analysed_sst",
... rescale="270,305",
... colormap_name="thermal",
... name="Sea Surface Temperature"
... )

>>> # HLS Landsat using rasterio backend
>>> m.add_cmr_layer(
... concept_id="C2021957657-LPCLOUD",
... datetime="2024-06-20T00:00:00Z/2024-06-27T23:59:59Z",
... backend="rasterio",
... bands=["B04", "B03", "B02"],
... bands_regex="B[0-9][0-9]",
... color_formula="Gamma RGB 3.5 Saturation 1.7 Sigmoidal RGB 15 0.35",
... name="HLS Landsat"
... )
"""
from .stac import cmr_tile, cmr_bounds

if os.environ.get("USE_MKDOCS") is not None:
return

tile_url = cmr_tile(
concept_id=concept_id,
datetime=datetime,
backend=backend,
variable=variable,
bands=bands,
bands_regex=bands_regex,
expression=expression,
rescale=rescale,
colormap_name=colormap_name,
color_formula=color_formula,
titiler_cmr_endpoint=titiler_cmr_endpoint,
**kwargs,
)

if tile_url is None:
print("Failed to get CMR tile URL")
return

self.add_tile_layer(tile_url, name, attribution, opacity, shown, layer_index)

if zoom_to_layer:
bounds = cmr_bounds(
concept_id=concept_id,
datetime=datetime,
backend=backend,
variable=variable,
titiler_cmr_endpoint=titiler_cmr_endpoint,
)
# Skip zooming if bounds are global (TiTiler CMR returns global bounds
# when actual data bounds are not available)
if bounds is not None and not common.is_global_bounds(bounds):
self.fit_bounds([[bounds[1], bounds[0]], [bounds[3], bounds[2]]])
common.arc_zoom_to_extent(bounds[0], bounds[1], bounds[2], bounds[3])

def add_cmr_timeseries(
self,
concept_id: str,
datetime: str,
step: str = "P1D",
temporal_mode: str = "point",
backend: str = "rasterio",
variable: Optional[str] = None,
bands: Optional[Union[str, List[str]]] = None,
bands_regex: Optional[str] = None,
expression: Optional[str] = None,
rescale: Optional[Union[str, List]] = None,
colormap_name: Optional[str] = None,
color_formula: Optional[str] = None,
name_prefix: str = "CMR",
attribution: str = "NASA Earthdata",
opacity: float = 1.0,
time_interval: int = 1,
position: str = "bottomright",
slider_length: str = "150px",
titiler_cmr_endpoint: Optional[str] = None,
**kwargs,
) -> None:
"""Adds a NASA Earthdata CMR time series layer with an interactive time slider.

This method creates multiple tile layers for different time steps and adds
a time slider control to navigate through the time series.

Args:
concept_id (str): NASA CMR collection concept ID (e.g., 'C2036881735-POCLOUD').
datetime (str): RFC3339 datetime range (e.g., '2024-01-01/2024-01-31').
step (str, optional): ISO 8601 duration for time steps (e.g., 'P1D' for 1 day,
'P1M' for 1 month, 'P2W' for 2 weeks). Defaults to 'P1D'.
temporal_mode (str, optional): Temporal mode - 'point' or 'range'. Defaults to 'point'.
backend (str, optional): Backend to use - 'rasterio' for COGs or 'xarray' for
NetCDF/Zarr. Defaults to 'rasterio'.
variable (str, optional): Variable name for xarray backend datasets.
bands (str | list, optional): Band name(s) for rasterio backend.
bands_regex (str, optional): Regex pattern for selecting bands (e.g., 'B[0-9][0-9]').
expression (str, optional): Band math expression (e.g., '(B05-B04)/(B05+B04)').
rescale (str | list, optional): Min/max values for rescaling (e.g., '270,305'
or [[270, 305]]).
colormap_name (str, optional): Name of colormap (e.g., 'thermal', 'viridis').
color_formula (str, optional): Color formula (e.g., 'Gamma RGB 3.5 Saturation 1.7').
name_prefix (str, optional): Prefix for layer names. Defaults to 'CMR'.
attribution (str, optional): Attribution text. Defaults to 'NASA Earthdata'.
opacity (float, optional): Layer opacity (0.0 to 1.0). Defaults to 1.0.
time_interval (int, optional): Time interval in seconds between frames. Defaults to 1.
position (str, optional): Position of the time slider ('topleft', 'topright',
'bottomleft', 'bottomright'). Defaults to 'bottomright'.
slider_length (str, optional): Length of the time slider. Defaults to '150px'.
titiler_cmr_endpoint (str, optional): TiTiler CMR endpoint URL.
**kwargs: Additional arguments passed to the TiTiler CMR endpoint.

Example:
>>> m = leafmap.Map()
>>> m.add_cmr_timeseries(
... concept_id="C2036881735-POCLOUD",
... datetime="2023-11-01/2024-10-30",
... step="P1M",
... backend="xarray",
... variable="sea_ice_fraction",
... colormap_name="blues_r",
... rescale="0,1"
... )
"""
from .stac import cmr_timeseries_tilejson

if os.environ.get("USE_MKDOCS") is not None:
return

tilejsons = cmr_timeseries_tilejson(
concept_id=concept_id,
datetime=datetime,
step=step,
temporal_mode=temporal_mode,
backend=backend,
variable=variable,
bands=bands,
bands_regex=bands_regex,
expression=expression,
rescale=rescale,
colormap_name=colormap_name,
color_formula=color_formula,
titiler_cmr_endpoint=titiler_cmr_endpoint,
**kwargs,
)

if tilejsons is None:
print("Failed to get CMR time series TileJSON")
return

layers_dict = {}

for dt_str, tilejson in tilejsons.items():
if "tiles" in tilejson:
tile_url = tilejson["tiles"][0]
# Format the datetime string for display (extract date portion)
if "T" in dt_str:
label = dt_str.split("T")[0]
else:
label = dt_str
layers_dict[label] = tile_url

if len(layers_dict) == 0:
print("No valid time series layers found")
return

self.add_time_slider(
layers=layers_dict,
time_interval=time_interval,
position=position,
slider_length=slider_length,
)

def add_zarr(
self,
url: str,
Expand Down
Loading
Loading