Source code for eoreader.products.sar.rs2_product

# -*- coding: utf-8 -*-
# Copyright 2021, SERTIT-ICube - France,
# This file is part of eoreader project
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
RADARSAT-2 products.
More info `here <>`_.
import difflib
import logging
import warnings
from datetime import datetime
from enum import unique
from typing import Union

import geopandas as gpd
import rasterio
from lxml import etree
from sertit import vectors
from sertit.misc import ListEnum
from sertit.vectors import WGS84

from eoreader.exceptions import InvalidProductError, InvalidTypeError
from eoreader.products.sar.sar_product import SarProduct, SarProductType
from eoreader.utils import DATETIME_FMT, EOREADER_NAME

LOGGER = logging.getLogger(EOREADER_NAME)

# Disable georef warnings here as the SAR products are not georeferenced
warnings.filterwarnings("ignore", category=rasterio.errors.NotGeoreferencedWarning)

[docs]@unique class Rs2ProductType(ListEnum): """ RADARSAT-2 projection identifier. Take a look `here <>`_. """ SLC = "SLC" """Single-look complex""" SGX = "SGX" """SAR georeferenced extra""" SGF = "SGF" """SAR georeferenced fine""" SCN = "SCN" """ScanSAR narrow beam""" SCW = "SCW" """ScanSAR wide beam""" SCF = "SCF" """ScanSAR fine""" SCS = "SCS" """ScanSAR sampled""" SSG = "SSG" """SAR systematic geocorrected""" SPG = "SPG" """SAR precision geocorrected"""
[docs]@unique class Rs2SensorMode(ListEnum): """ RADARSAT-2 sensor mode. Take a look `here <>`_. .. WARNING:: The name in the metadata may vary ! """ # Single Beam Modes S = "Standard" """Standard Mode""" W = "Wide" """Spotlight Mode""" F = "Fine" """Wide Mode""" WF = "Wide Fine" """Wide Fine Mode""" MF = "Multi-Look Fine" """Multi-Look Fine Mode""" WMF = "Wide Multi-Look Fine" """Wide Multi-Look Fine Mode""" XF = "Extra-Fine" """Extra-Fine Mode""" U = "Ultra-Fine" """Ultra-Fine Mode""" WU = "Wide Ultra-Fine" """Wide Ultra-Fine Mode""" EH = "Extended High" """Extended High Mode""" EL = "Extended Low" """Extended Low Mode""" SQ = "Standard Quad-Pol" """Standard Quad-Pol Mode""" WSQ = "Wide Standard Quad-Pol" """Wide Standard Quad-Pol Mode""" FQ = "Fine Quad-Pol" """Fine Quad-Pol Mode""" WFQ = "Wide Fine Quad-Pol" """Spotlight Mode""" # ScanSAR Modes SCN = "ScanSAR Narrow" """Spotlight Mode""" SCW = "ScanSAR Wide" """Spotlight Mode""" OSVN = "Ocean Surveillance" """Ocean Surveillance Mode""" DVWF = "Ship Detection" """Ship Detection Mode""" # Spotlight Mode SLA = "Spotlight" """Spotlight Mode"""
[docs]@unique class Rs2Polarization(ListEnum): """ RADARSAT-2 polarization mode. Take a look `here <>`_ """ HH = "HH" VV = "VV" VH = "VH" HV = "HV"
[docs]class Rs2Product(SarProduct): """ Class for RADARSAT-2 Products You can use directly the .zip file """ def _set_resolution(self) -> float: """ Set product default resolution (in meters) """ # Read metadata try: root, nsmap = self.read_mtd() namespace = nsmap[None] def_res = float(root.findtext(f".//{namespace}sampledPixelSpacing")) except (InvalidProductError, TypeError): raise InvalidProductError( "sampledPixelSpacing or rowSpacing not found in metadata !" ) return def_res def _post_init(self) -> None: """ Function used to post_init the products (setting product-type, band names and so on) """ # Private attributes self._raw_band_regex = "*imagery_{}.tif" self._band_folder = self.path self._snap_path = "" # Zipped and SNAP can process its archive self.needs_extraction = False # Post init done by the super class super()._post_init()
[docs] def wgs84_extent(self) -> gpd.GeoDataFrame: """ Get the WGS84 extent of the file before any reprojection. This is useful when the SAR pre-process has not been done yet. .. code-block:: python >>> from eoreader.reader import Reader >>> path = r"" >>> prod = Reader().open(path) >>> prod.wgs84_extent() geometry 1 POLYGON ((106.57999 -6.47363, 107.06926 -6.473... Returns: gpd.GeoDataFrame: WGS84 extent as a gpd.GeoDataFrame """ # Open extent KML file try: if self.is_archived: product_kml =, archive_regex=".*product\.kml") else: extent_file = next(self.path.glob("*product.kml")) product_kml = except IndexError as ex: raise InvalidProductError( f"Extent file (product.kml) not found in {self.path}" ) from ex extent_wgs84 = product_kml[ product_kml.Name == "Polygon Outline" ].envelope.to_crs(WGS84) return gpd.GeoDataFrame(geometry=extent_wgs84.geometry,
def _set_product_type(self) -> None: """Set products type""" # Get MTD XML file root, nsmap = self.read_mtd() namespace = nsmap[None] # Open identifier try: prod_type = root.findtext(f".//{namespace}productType") except TypeError: raise InvalidProductError("mode not found in metadata !") self.product_type = Rs2ProductType.from_value(prod_type) if self.product_type == Rs2ProductType.SGF: self.sar_prod_type = SarProductType.GDRG elif self.product_type in Rs2ProductType.SLC: self.sar_prod_type = SarProductType.CPLX else: raise NotImplementedError( f"{self.product_type.value} product type is not available for {}" ) if self.product_type != Rs2ProductType.SGF: LOGGER.warning( "Other products type than SGF has not been tested for %s data. " "Use it at your own risks !", self.platform.value, ) def _set_sensor_mode(self) -> None: """ Get products type from RADARSAT-2 products name (could check the metadata too) """ # Get metadata root, nsmap = self.read_mtd() namespace = nsmap[None] # Get sensor mode # WARNING: this word may differ from the Enum !!! (no docs available) # Get the closest match sensor_mode_xml = root.findtext(f".//{namespace}acquisitionType") if sensor_mode_xml: sensor_mode = difflib.get_close_matches( sensor_mode_xml, Rs2SensorMode.list_values() )[0] try: self.sensor_mode = Rs2SensorMode.from_value(sensor_mode) except ValueError as ex: raise InvalidTypeError(f"Invalid sensor mode for {}") from ex else: raise InvalidTypeError(f"Invalid sensor mode for {}")
[docs] def get_datetime(self, as_datetime: bool = False) -> Union[str, datetime]: """ Get the product's acquisition datetime, with format `YYYYMMDDTHHMMSS` <-> `%Y%m%dT%H%M%S` .. code-block:: python >>> from eoreader.reader import Reader >>> path = r"" >>> prod = Reader().open(path) >>> prod.get_datetime(as_datetime=True) datetime.datetime(2016, 2, 28, 11, 24, 18) >>> prod.get_datetime(as_datetime=False) '20160228T112418' Args: as_datetime (bool): Return the date as a datetime.datetime. If false, returns a string. Returns: Union[str, datetime.datetime]: Its acquisition datetime """ # Get MTD XML file root, nsmap = self.read_mtd() namespace = nsmap[None] # Open identifier try: acq_date = root.findtext(f".//{namespace}rawDataStartTime") except TypeError: raise InvalidProductError("rawDataStartTime not found in metadata !") # Convert to datetime date = datetime.strptime(acq_date, "%Y-%m-%dT%H:%M:%S.%fZ") if not as_datetime: date = date.strftime(DATETIME_FMT) return date
def _read_mtd(self) -> (etree._Element, dict): """ Read metadata and outputs the metadata XML root and its namespaces as a dict .. code-block:: python >>> from eoreader.reader import Reader >>> path = r"LC08_L1GT_023030_20200518_20200527_01_T2" >>> prod = Reader().open(path) >>> prod.read_mtd() (<Element {}product at 0x1c0efbd37c8>, {None: '{}'}) Returns: (etree._Element, dict): Metadata XML root and its namespace """ mtd_from_path = "product.xml" mtd_archived = "product\.xml" return self._read_mtd_xml(mtd_from_path, mtd_archived)