Skip to main content

Python xarray library to use Level-1 GRD Synthetic Aperture Radar products

Project description

Install test

xsar

Synthetic Aperture Radar (SAR) Level-1 GRD python mapper for efficient xarray/dask based processing

This python library allow to apply different operation on SAR images such as:

  • calibration
  • de-noising
  • re-sampling

The library is working regardless it is a Sentinel-1, a RadarSAT-2 or a RCM product.

The library is providing variables such as longitude , latitude, incidence_angle or sigma0 at native product resolution or coarser resolution.

The library perform resampling that are suitable for GRD (i.e. ground projected) SAR images. The same method is used for WV SLC, and one can consider the approximation still valid because the WV image is only 20 km X 20 km.

But for TOPS (IW or EW) SLC products we recommend to use xsarslc

Install

Conda

  1. Install xsar (without the readers)

For a faster installation and less conflicts between packages, it is better to make the installation with micromamba

conda install -c conda-forge mamba
  1. install xsar (without the readers)
micromamba install -c conda-forge xsar
  1. Add optional dependencies
  • Add use of Radarsat-2 :
micromamba install -c conda-forge xradarsat2
  • Add use of RCM (RadarSat Constellation Mission)
pip install xarray-safe-rcm
  • Add use of Sentinel-1
micromamba install -c conda-forge xarray-safe-s1

Pypi

  1. install xsar (this will only allow to use Sentinel-1)
pip install xsar
  1. install xsar with optional dependencies (to use Radarsat-2, RCM...)
  • install xsar including Sentinel-1 :
pip install xsar[S1]
  • install xsar including Radarsat-2 :
pip install xsar[RS2]
  • install xsar including RCM :
pip install xsar[RCM]
  • install xsar including multiple readers (here Radarsat-2 and RCM):
pip install xsar[RS2,RCM]
>>> import xsar
>>> import xarray
>>> xarray.open_dataset('S1A_IW_GRDH_1SDV_20170907T103020_20170907T103045_018268_01EB76_Z010.SAFE')

<xarray.Dataset>
Dimensions:               (atrack: 16778, pol: 2, xtrack: 25187)
Coordinates:
  * atrack                (atrack) int64 0 1 2 3 4 ... 16774 16775 16776 16777
  * pol                   (pol) object 'VV' 'VH'
  * xtrack                (xtrack) int64 0 1 2 3 4 ... 25183 25184 25185 25186
    spatial_ref           int64 ...
Data variables: (12/19)
    time                  (atrack) timedelta64[ns] ...
    digital_number        (pol, atrack, xtrack) uint16 ...
    land_mask             (atrack, xtrack) int8 ...
    ground_heading        (atrack, xtrack) float32 ...
    sigma0_raw            (pol, atrack, xtrack) float64 ...
    nesz                  (pol, atrack, xtrack) float64 ...
    ...                    ...
    longitude             (atrack, xtrack) float64 ...
    latitude              (atrack, xtrack) float64 ...
    velocity              (atrack) float64 ...
    range_ground_spacing  (xtrack) float64 ...
    sigma0                (pol, atrack, xtrack) float64 ...
    gamma0                (pol, atrack, xtrack) float64 ...
Attributes: (12/14)
    ipf:               2.84
    platform:          SENTINEL-1A
    swath:             IW
    product:           GRDH
    pols:              VV VH
    name:              SENTINEL1_DS:/home/oarcher/SAFE/S1A_IW_GRDH_1SDV_20170...
    ...                ...
    footprint:         POLYGON ((-67.84221143971432 20.72564283093837, -70.22...
    coverage:          170km * 251km (atrack * xtrack )
    pixel_atrack_m:    10.152619433217325
    pixel_xtrack_m:    9.986179379582332
    orbit_pass:        Descending
    platform_heading:  -167.7668824808032

More information

For more install options and to use xsar, see documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xsar-2025.3.7.tar.gz (1.4 MB view details)

Uploaded Source

File details

Details for the file xsar-2025.3.7.tar.gz.

File metadata

  • Download URL: xsar-2025.3.7.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xsar-2025.3.7.tar.gz
Algorithm Hash digest
SHA256 17a2fd363524c9c650c71800872717696746d3b2e9dd6e9939d125f34cb9e269
MD5 c76b611e4c038ba9441432ab3c4322ea
BLAKE2b-256 c2ae49f201cf6716eba03429dd115e7a57a9b6ef6a11ec35d352075c83c7a1dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for xsar-2025.3.7.tar.gz:

Publisher: publish.yml on umr-lops/xsar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page