eodal.core.sensors.sentinel1 module¶
This module contains the Sentinel1 class that inherits from
eodal’s core RasterCollection class.
The Sentinel1 class enables reading one or more polarizations from Sentinel-1
data in .SAFE format which is ESA’s standard format for distributing Sentinel-1 data.
The class handles data in GRD (ground-range detected) and RTC (radiometrically terrain corrected) processing level.
Copyright (C) 2022 Lukas Valentin Graf
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
- class eodal.core.sensors.sentinel1.Sentinel1(band_constructor: Callable[[...], Band] | None = None, scene_properties: SceneProperties | None = None, *args, **kwargs)[source]¶
Bases:
RasterCollectionReading Sentinel-1 Radiometrically Terrain Corrected (RTC) and Ground Range Detected (GRD) products
- classmethod from_safe(in_dir: Path | Dict[str, str], polarizations: List[str] | None = ['VV', 'VH'], **kwargs)[source]¶
Reads a Sentinel-1 RTC (radiometrically terrain corrected) or GRD (Ground Range Detected) products
- NOTE
When using MSPC as STAC provider a valid API key is required
- Parameters:
in_dir – file-path to the Sentinel-1 RTC SAFE or dictionary with asset items returned from STAC query
polarizations – selection of polarization to read. ‘VV’ and ‘VH’ by default.
kwargs – optional key word arguments to pass on to ~eodal.core.raster.RasterCollection.from_rasterio
- classmethod read_pixels_from_safe(in_dir: Dict[str, Any] | Path, vector_features: Path | GeoDataFrame, polarizations: List[str] | None = ['VV', 'VH']) GeoDataFrame[source]¶
Extracts Sentinel-1 raster values at locations defined by one or many vector geometry features read from a vector file (e.g., ESRI shapefile) or
GeoDataFrame.Note
A point is dimension-less, therefore, the raster grid cell (pixel) closest to the point is returned if the point lies within the raster.
- Parameters:
in_dir – Sentinel-1 scene in .SAFE structure from which to extract pixel values at the provided point locations (GRD or RTC).Can be either a dictionary item returned from STAC or a physical file-path
vector_features – vector file (e.g., ESRI shapefile or geojson) or
GeoDataFramedefining point locations for which to extract pixel valuespolarizations – selection of polarization to read. ‘VV’ and ‘VH’ by default.
- Returns:
GeoDataFramecontaining the extracted raster values. The band values are appended as columns to the dataframe. Existing columns of the input in_file_pixels are preserved.