CDSE (version 0.3.0)

MakeEvalScript: Create a Sentinel Hub API Evalscript

Description

Generates a JavaScript evalscript for calculating a spectral index for Sentinel-1 or Sentinel-2 imagery.

Usage

MakeEvalScript(x, ...)

Value

A `character` vector containing the JavaScript evalscript. It can be used as `script` argument in functions that require one as shown here:

..., script = paste(MakeEvalScript("NDVI"), collapse = "\n"), ....

It can also be saved to a file for later use or further modifications.

Arguments

x

A character string with the short_name of a spectral index from rsi::spectral_indices() or a single-row data.frame (or list) with the elements bands, formula, platforms, and optionally long_name.

...

Named arguments providing values for any constants required by the index's formula. The function will stop if a required constant is missing and warn if unused arguments are provided.

Details

This function takes a spectral index definition and creates a JavaScript evalscript compatible with the Sentinel Hub API. The index can be specified by its short name from the rsi package's spectral index database (see rsi::spectral_indices()) or as a custom list or data.frame.

The function automatically maps common band names (e.g., `N`, `R`, `G`, `B`) to the corresponding Sentinel-1 or Sentinel-2 band names required by the API. Any constants in the index formula (e.g., the soil adjustment factor `L` in SAVI) must be provided as named arguments.

Examples

if (FALSE) {

# NDVI
si <- rsi::spectral_indices() # retrieves spectral indices
ndvi <- subset(si, short_name == "NDVI") # creates one-row data.frame
ndvi_script <- MakeEvalScript(ndvi) # generates the script
cat(ndvi_script, sep = "\n")

# SAVI, which requires the constant L
cat(MakeEvalScript("SAVI", L = 0.5), sep = "\n", file = "SAVI.js")

# Using a custom index definition as a data.frame
custom_index <- data.frame(
  short_name = "GNDVI",
  long_name = "Green Normalized Difference Vegetation Index",
  platforms = I(list("Sentinel-2")),
  bands = I(list(c("N", "G"))),
  formula = "(N - G) / (N + G)"
)
cat(MakeEvalScript(custom_index))
}