README.md 2.61 KB
Newer Older
Shanyu Zhou's avatar
Shanyu Zhou committed
1
2
# wvpd

Shanyu Zhou's avatar
Shanyu Zhou committed
3
Tool for automatically classication of aliphatic and aromatic plastic on the configuration of WorldView-3 imagery
Shanyu Zhou's avatar
Shanyu Zhou committed
4
5
6
7
8
9
10
11
12
13
14

## Requirements

This tool is compatible with Python 3.8.11.

Dependencies can be installed using [pip](https://pip.pypa.io/en/stable/):

```bash
pip install -r requirements.txt
```

Shanyu Zhou's avatar
Shanyu Zhou committed
15

Shanyu Zhou's avatar
Shanyu Zhou committed
16
17
## Test data

Shanyu Zhou's avatar
Shanyu Zhou committed
18
The [example](https://git.gfz-potsdam.de/plastic/wv3plastic/-/tree/main/example) folder contains data that can be used to test the processing chain. It contains one PRISMA L2D image, showing parts of the Almeria, Spain.
Shanyu Zhou's avatar
Shanyu Zhou committed
19
20
21
22


## Quickstart

Shanyu Zhou's avatar
Shanyu Zhou committed
23
To start a classification right away, run the example script:
Shanyu Zhou's avatar
Shanyu Zhou committed
24
25
26
27
28
29
30

```bash
cd /path of wvpd.py/

python wvpd.py
```

Shanyu Zhou's avatar
Shanyu Zhou committed
31
32
33
34
35
36
37
38
39
40
41
Output should be like:
```bash
Converting prisma_almeria_2021_jan_vnswir_subset.hdr to Worldview-3
Converted data saved in ~/example/simulated_wv3/
start classifying ~/example/simulated_wv3/prisma_almeria_2021_jan_vnswir_subset_wv3.hdr
----------start classification-----------
processing time:  2.42  sec
----------finish classification-----------
end processing
```

Shanyu Zhou's avatar
Shanyu Zhou committed
42
43
## Usage

Shanyu Zhou's avatar
Shanyu Zhou committed
44
45
The [wv3cfg](https://git.gfz-potsdam.de/plastic/wv3plastic/-/tree/main/wv3cfg) folder contains the Spectral Response Function (SRF)
 
Shanyu Zhou's avatar
Shanyu Zhou committed
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
This tool is tested with 'Bottom-of-atmosphere' reflectance, please make sure the atmospheric correction has been accomplished before apply it

It allows batch processing when there are several dataset in the target folder

It can be modified as below:

```python
# Get the path of wvpd.py
bpath = os.getcwd()

# Input can be hyperspectral data, e.g. the example data was recorded by PRISMA
# Path here could be replaced by other paths containing your own dataset 
# Must add '/' in the end of the string
path =bpath+'/example/'

# This line is only used on hyperspectral data for spectral resampling to WV3 configuration
# Please mute this line if directly use WV-3 dataset
path = multispecim(path)

# This line is for the classication using default setting in the paper
# Please change the setting in the function on demands
multiclassification(path)
```

## License

Shanyu Zhou's avatar
Shanyu Zhou committed
72
73
74
APACHE LICENSE, VERSION 2.0

Please see details in the [LICENSE](https://git.gfz-potsdam.de/plastic/wv3plastic/-/blob/main/LICENSE) file
Shanyu Zhou's avatar
Shanyu Zhou committed
75
76
77

## Citation

Shanyu Zhou's avatar
Shanyu Zhou committed
78
The tool has been used for the publication of the following paper.
Shanyu Zhou's avatar
Shanyu Zhou committed
79
80
81
82
83
84

Zhou, S., Kuester, T., Bochow, M., Bohn, N., Brell, M., Kaufmann, H., 2021. A knowledge-based, validated classifier for the identification of aliphatic and aromatic plastics by WorldView-3 satellite data. Remote Sensing of Environment 264, 112598. https://doi.org/10.1016/j.rse.2021.112598

If you use it for processing your own data, please cite my article when publishing your findings, thank you.


Shanyu Zhou's avatar
Shanyu Zhou committed
85