VisParams Documentation

RadGEEToolbox.VisParams.get_visualization_params(satellite, index, min_val=None, max_val=None, palette=None, scaled_bands=False)

Function to define visualization parameters for image visualization. Outputs a vis_params dictionary.

Parameters:

  • satellite (str) – Denote satellite/source for visualization. Options: ‘Landsat’, ‘Sentinel2’, ‘Sentinel1’, ‘Generic’ (for DEMs, Precip, etc.). Case-insensitive.

  • index (str) – Multispectral index or band to visualize. Options include: ‘TrueColor’, ‘NDVI’, ‘NDWI’, ‘MNDWI’, ‘EVI’, ‘SAVI’, ‘MSAVI’, ‘NDMI’, ‘NBR’, ‘NDSI’, ‘halite’, ‘gypsum’, ‘LST’, ‘NDTI’, ‘KIVU’, ‘2BDA’, ‘Elevation’, ‘Precipitation’, ‘Evapotranspiration’.

  • min_val (int or float) – Optional override for minimum value to stretch raster.

  • max_val (int or float) – Optional override for maximum value to stretch raster.

  • palette (str or list) – Optional override for color palette. Can be a list of hex codes or a string name from GetPalette (e.g., ‘ndvi’, ‘viridis’, ‘magma’).

  • scaled_bands (bool) – If True, indicates that surface reflectance bands are scaled (0-1) rather than raw DNs. Defaults to False.

Returns:

vis_params dictionary to be used when visualizing an image on a map. Supplies min, max, bands, and palette.

Return type:

dict