README.rst 3.41 KB
Newer Older
Daniel Scheffler's avatar
Daniel Scheffler committed
1
2
3
4
=====
pyrsr
=====

Daniel Scheffler's avatar
Daniel Scheffler committed
5
6
A package providing relative spectral response functions for remote sensing instruments.

7
* Free software: GNU General Public License v3 or later (GPLv3+)
8
* Documentation: https://geomultisens.gitext-pages.gfz-potsdam.de/pyrsr/doc/
Daniel Scheffler's avatar
Daniel Scheffler committed
9
10
* Submit feedback by filing an issue `here <https://gitext.gfz-potsdam.de/geomultisens/pyrsr/issues>`__.

Daniel Scheffler's avatar
Daniel Scheffler committed
11

Daniel Scheffler's avatar
Daniel Scheffler committed
12
13
14
Status
------

15
.. image:: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/badges/master/pipeline.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
16
17
        :target: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/commits/master
.. image:: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/badges/master/coverage.svg
18
        :target: https://geomultisens.gitext-pages.gfz-potsdam.de/pyrsr/coverage/
Daniel Scheffler's avatar
Daniel Scheffler committed
19
20
.. image:: https://img.shields.io/pypi/v/pyrsr.svg
        :target: https://pypi.python.org/pypi/pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
21
22
23
24
.. image:: https://img.shields.io/pypi/l/pyrsr.svg
        :target: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/blob/master/LICENSE
.. image:: https://img.shields.io/pypi/pyversions/pyrsr.svg
        :target: https://img.shields.io/pypi/pyversions/pyrsr.svg
Daniel Scheffler's avatar
Daniel Scheffler committed
25
26
.. image:: https://img.shields.io/pypi/dm/pyrsr.svg
        :target: https://pypi.python.org/pypi/pyrsr
Daniel Scheffler's avatar
Daniel Scheffler committed
27

Daniel Scheffler's avatar
Daniel Scheffler committed
28
See also the latest coverage_ report and the nosetests_ HTML report.
Daniel Scheffler's avatar
Daniel Scheffler committed
29
30
31
32
33


Features
--------

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
Quick usage example for getting the spectral response functions of Sentinel-2A:

.. code-block::

    >>> from pyrsr import RelativeSpectralResponse
    >>> RSR = RelativeSpectralResponse(satellite='Sentinel-2A', sensor='MSI')
    >>> RSR.plot_rsrs()

.. image:: https://gitext.gfz-potsdam.de/geomultisens/pyrsr/raw/master/docs/images/S2A_RSRs.png

.. code-block::

    >>> RSR.rsrs

    {'1': array([ 0.0001003 ,  0.00023005,  0.00020481, ...,  0.        ,
                  0.        ,  0.        ]),
     '2': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '3': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '4': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '5': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '6': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '7': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '8': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '8A': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '9': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '10': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '11': array([ 0.,  0.,  0., ...,  0.,  0.,  0.]),
     '12': array([ 0.00000000e+00,   0.00000000e+00,   0.00000000e+00, ...,
                   4.06617574e-05,   2.94133865e-05,   1.28975620e-05])}


65
66
List of supported sensors:

67
* Terra ASTER
68
69
70
* Landsat-4 TM
* Landsat-5 TM
* Landsat-7 ETM+
71
* Landsat-8 OLI_TIRS
Daniel Scheffler's avatar
Daniel Scheffler committed
72
73
* Aqua MODIS
* Terra MODIS
74
75
76
77
78
79
80
81
82
83
84
85
86
* RapidEye-5 MSI
* Sentinel-2A MSI
* Sentinel-2B MSI
* SPOT-1 HRV1
* SPOT-1 HRV2
* SPOT-2 HRV1
* SPOT-2 HRV2
* SPOT-3 HRV1
* SPOT-3 HRV2
* SPOT-4 HRVIR1
* SPOT-4 HRVIR2
* SPOT-5 HRG1
* SPOT-5 HRG2
87

Daniel Scheffler's avatar
Daniel Scheffler committed
88
89
90
91

Credits
-------

Daniel Scheffler's avatar
Daniel Scheffler committed
92
93
94
The pyrsr package was developed within the context of the GeoMultiSens project funded
by the German Federal Ministry of Education and Research (project grant code: 01 IS 14 010 A-C).

Daniel Scheffler's avatar
Daniel Scheffler committed
95
96
97
98
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
99
100
.. _coverage: https://geomultisens.gitext-pages.gfz-potsdam.de/pyrsr/coverage/
.. _nosetests: https://geomultisens.gitext-pages.gfz-potsdam.de/pyrsr/nosetests_reports/nosetests.html