1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
#######################################################
xarray-safe-s1: xarray SAFE files reader for Sentinel-1
#######################################################
**safe_s1** is a SAR file reader
Documentation
-------------
Overview
........
**safe_s1** rely on `xarray.open_rasterio` and `rasterio` to read *digital_number* from SAFE
product to return an xarray.datatree.
Luts are decoded from xml files following `ESA Sentinel-1 Product Specification`_.
`safe_s1.metadata.Sentinel1reader` is the main class and contains a xarray.datatree with the useful data. In the following example, you will find some additional functions and properties that can be useful.
Examples
........
.. note::
Those examples use `sentinel1_xml_mappings.get_test_file` to automatically download test data from https://cyclobs.ifremer.fr/static/sarwing_datarmor/xsardata/
Those file are not official ones: they are resampled to a lower resolution and compressed to avoid big network transfert and disk usage.
Don't use them for real science !
* :doc:`examples/simple_tutorial`
Reference
.........
* :doc:`api`
Get in touch
------------
- Report bugs, suggest features or view the source code `on github`_.
----------------------------------------------
Last documentation build: |today|
.. toctree::
:maxdepth: 1
:hidden:
:caption: Getting Started
installing
.. toctree::
:maxdepth: 1
:caption: Examples
examples/simple_tutorial
.. toctree::
:maxdepth: 1
:hidden:
:caption: Reference
api
.. _on github: https://github.com/umr-lops/xarray-safe-s1
.. _xarray: http://xarray.pydata.org
.. _dask: http://dask.org
.. _rasterio: https://rasterio.readthedocs.io/en/latest/
.. _xarray.open_rasterio: http://xarray.pydata.org/en/stable/generated/xarray.open_rasterio.html
.. _ESA Sentinel-1 Product Specification: https://earth.esa.int/documents/247904/1877131/Sentinel-1-Product-Specification
.. _xarray.Dataset: http://xarray.pydata.org/en/stable/generated/xarray.Dataset.html
.. _`recommended installation`: installing.rst#recommended-packages
.. _SAFE format: https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/data-formats
.. _jupyter notebook: https://jupyter.readthedocs.io/en/latest/running.html#running
|
