add_masks_to_vrt

eolab.georastertools.product.vrt.add_masks_to_vrt(src_vrt: Path | str, maskfile: Path | str, bands: List[int] = [1], funcname: str | None = None, funcdef: str | None = None) → str[source]

Adds a mask bands to the vrt.

Parameters:

  • src_vrt (pathlib.Path or str) – Vrt input image

  • maskfile (pathlib.Path or str) – Input image that contains the bands to use as masks

  • bands ([int]) – Bands in the the input image to use as masks

  • funcname (str, optional, default=None) – Fully qualified name of the pixel function (e.g. indices.vrt.s2_maja_mask) used to compute the mask from the maskfile dataset.

  • funcdef (str, optional, default=None) – Function definition (without its signature). If None, the function funcname must be available in the scope

Returns:

XML content (vrt format) with the added mask band.

Return type:

(str)