# 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](https://github.com/umr-lops/xsar_slc.git)
# 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`
```bash
conda install -c conda-forge mamba
```
2) install `xsar` (without the readers)
```bash
micromamba install -c conda-forge xsar
```
3) Add optional dependencies
- Add use of Radarsat-2 :
```bash
micromamba install -c conda-forge xradarsat2
```
- Add use of RCM (RadarSat Constellation Mission)
```bash
pip install xarray-safe-rcm
```
- Add use of Sentinel-1
```bash
micromamba install -c conda-forge xarray-safe-s1
```
## Pypi
1) install `xsar` (this will only allow to use Sentinel-1)
```bash
pip install xsar
```
2) install `xsar` with optional dependencies (to use Radarsat-2, RCM...)
- install `xsar` including Sentinel-1 :
```bash
pip install xsar[S1]
```
- install `xsar` including Radarsat-2 :
```bash
pip install xsar[RS2]
```
- install `xsar` including RCM :
```bash
pip install xsar[RCM]
```
- install `xsar` including multiple readers (here Radarsat-2 and RCM):
```bash
pip install xsar[RS2,RCM]
```
```python
>>> 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](https://cyclobs.ifremer.fr/static/sarwing_datarmor/xsar/)
Raw data
{
"_id": null,
"home_page": null,
"name": "xsar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "xarray, earth-observation, remote-sensing, satellite-imagery, Sentinel-1, RCM, RadarSat2, sar, synthetic-aperture-radar",
"author": null,
"author_email": "Olivier Archer <olivier.archer@ifremer.fr>",
"download_url": "https://files.pythonhosted.org/packages/a5/da/2b47bbf01263d73bb5ecb048073c5ab9ab713d33f6f682471b773d148567/xsar-2024.12.3.tar.gz",
"platform": null,
"description": "\n# xsar\n\nSynthetic Aperture Radar (SAR) Level-1 GRD python mapper for efficient xarray/dask based processing\n\nThis python library allow to apply different operation on SAR images such as:\n - calibration\n - de-noising\n - re-sampling\n\nThe library is working regardless it is a **Sentinel-1**, a **RadarSAT-2** or a **RCM** product.\n\nThe library is providing variables such as `longitude` , `latitude`, `incidence_angle` or `sigma0` at native product resolution or coarser resolution.\n\nThe 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.\n\nBut for TOPS (IW or EW) SLC products we recommend to use [xsarslc](https://github.com/umr-lops/xsar_slc.git)\n\n# Install\n\n## Conda\n\n1) Install `xsar` (without the readers)\n\nFor a faster installation and less conflicts between packages, it is better\nto make the installation with `micromamba`\n\n```bash\nconda install -c conda-forge mamba\n```\n\n2) install `xsar` (without the readers)\n\n```bash\nmicromamba install -c conda-forge xsar\n```\n3) Add optional dependencies\n\n- Add use of Radarsat-2 :\n\n```bash\nmicromamba install -c conda-forge xradarsat2\n```\n\n- Add use of RCM (RadarSat Constellation Mission)\n\n```bash\npip install xarray-safe-rcm\n```\n\n- Add use of Sentinel-1\n\n```bash\nmicromamba install -c conda-forge xarray-safe-s1\n```\n\n## Pypi\n\n1) install `xsar` (this will only allow to use Sentinel-1)\n\n```bash\npip install xsar\n```\n2) install `xsar` with optional dependencies (to use Radarsat-2, RCM...)\n\n- install `xsar` including Sentinel-1 :\n\n```bash\npip install xsar[S1]\n```\n\n- install `xsar` including Radarsat-2 :\n\n```bash\npip install xsar[RS2]\n```\n\n- install `xsar` including RCM :\n\n```bash\npip install xsar[RCM]\n```\n\n- install `xsar` including multiple readers (here Radarsat-2 and RCM):\n\n```bash\npip install xsar[RS2,RCM]\n```\n\n\n```python\n>>> import xsar\n>>> import xarray\n>>> xarray.open_dataset('S1A_IW_GRDH_1SDV_20170907T103020_20170907T103045_018268_01EB76_Z010.SAFE')\n\n<xarray.Dataset>\nDimensions: (atrack: 16778, pol: 2, xtrack: 25187)\nCoordinates:\n * atrack (atrack) int64 0 1 2 3 4 ... 16774 16775 16776 16777\n * pol (pol) object 'VV' 'VH'\n * xtrack (xtrack) int64 0 1 2 3 4 ... 25183 25184 25185 25186\n spatial_ref int64 ...\nData variables: (12/19)\n time (atrack) timedelta64[ns] ...\n digital_number (pol, atrack, xtrack) uint16 ...\n land_mask (atrack, xtrack) int8 ...\n ground_heading (atrack, xtrack) float32 ...\n sigma0_raw (pol, atrack, xtrack) float64 ...\n nesz (pol, atrack, xtrack) float64 ...\n ... ...\n longitude (atrack, xtrack) float64 ...\n latitude (atrack, xtrack) float64 ...\n velocity (atrack) float64 ...\n range_ground_spacing (xtrack) float64 ...\n sigma0 (pol, atrack, xtrack) float64 ...\n gamma0 (pol, atrack, xtrack) float64 ...\nAttributes: (12/14)\n ipf: 2.84\n platform: SENTINEL-1A\n swath: IW\n product: GRDH\n pols: VV VH\n name: SENTINEL1_DS:/home/oarcher/SAFE/S1A_IW_GRDH_1SDV_20170...\n ... ...\n footprint: POLYGON ((-67.84221143971432 20.72564283093837, -70.22...\n coverage: 170km * 251km (atrack * xtrack )\n pixel_atrack_m: 10.152619433217325\n pixel_xtrack_m: 9.986179379582332\n orbit_pass: Descending\n platform_heading: -167.7668824808032\n\n```\n\n\n\n# More information\n\nFor more install options and to use xsar, see [documentation](https://cyclobs.ifremer.fr/static/sarwing_datarmor/xsar/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python xarray library to use Level-1 GRD Synthetic Aperture Radar products",
"version": "2024.12.3",
"project_urls": {
"changelog": "https://xsar.readthedocs.io/en/latest/changelog.html",
"documentation": "https://xsar.readthedocs.io",
"homepage": "https://github.com/umr-lops/xsar.readthedocs.io",
"repository": "https://github.com/umr-lops/xsar"
},
"split_keywords": [
"xarray",
" earth-observation",
" remote-sensing",
" satellite-imagery",
" sentinel-1",
" rcm",
" radarsat2",
" sar",
" synthetic-aperture-radar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5da2b47bbf01263d73bb5ecb048073c5ab9ab713d33f6f682471b773d148567",
"md5": "66c526a5b81e1ed6a46d7f0a3eeb3be3",
"sha256": "807788c87bab06e0781a2cb1229ded93da18d6a2b3fb3ee87c29c5dbcf5ecad6"
},
"downloads": -1,
"filename": "xsar-2024.12.3.tar.gz",
"has_sig": false,
"md5_digest": "66c526a5b81e1ed6a46d7f0a3eeb3be3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1387737,
"upload_time": "2024-12-03T09:56:52",
"upload_time_iso_8601": "2024-12-03T09:56:52.623602Z",
"url": "https://files.pythonhosted.org/packages/a5/da/2b47bbf01263d73bb5ecb048073c5ab9ab713d33f6f682471b773d148567/xsar-2024.12.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 09:56:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "umr-lops",
"github_project": "xsar.readthedocs.io",
"github_not_found": true,
"lcname": "xsar"
}
JSON
