Update README.md

README.md

@@ -1,3 +1,73 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+task_categories:
+- image-classification
+tags:
+- climate
+- remote-sensing
+---
+
+# So2Sat-LCZ42
+
+A copy of the [Fourth version](https://mediatum.ub.tum.de/1836598) of the So2Sat-LCZ42 dataset, pairing the [second version](https://mediatum.ub.tum.de/1459256?show_id=1483140) (culture-10) with geolocation:
+
+	Training: 	42 cities around the world
+	Validation:	western half of 10 other cities covering 10 cultural zones
+	Testing:	eastern half of the 10 other cities	
+
+## Description of the files
+training.h5:	training data containing SEN1, SEN2 patches and label
+
+	sen1:	N*32*32*8	
+	sen2:	N*32*32*10
+	label:	N*17 (one-hot coding)
+	
+validation.h5:  validation data containing similar SEN1, SEN2, and label
+
+	sen1:  	M*32*32*8 	
+	sen2:  	M*32*32*10	
+	label: 	M*17 (one-hot coding)
+	
+testing.h5:	testing data containing SEN1 and SEN2 patches and label
+
+	sen1:  	L*32*32*8
+	sen2:  	L*32*32*10
+	label:  L*17 (one-hot coding)
+
+training_geo.h5: geolocation for the training data
+
+	coord:  N*6 # UTM X, UTM Y, SEN1 row number, SEN1 col number, SEN2 row number, SEN2 col number
+	epsg:   N*1 # EPSG code
+	tfw:    N*6 # six parameters used to generate a TFW file
+  
+validation_geo.h5: geolocation for the validation data
+
+	coord:  M*6
+	epsg:   M*1
+	tfw:    M*6
+
+testing_geo.h5: geolocation for the testing data
+
+	coord:  L*6
+	epsg:   L*1
+	tfw:    L*6
+
+read_file.py:	a demo python script to read in the files, and visualize a pair of patches
+		Required python packages: h5py, numpy, and matplotlib.
+
+Please visit https://github.com/zhu-xlab/So2Sat-LCZ42 for more details, including a demo notebook to generate geotiffs from h5 files.
+
+
+## Citation
+```bibtex
+@ARTICLE{Zhu2020So2Sat,
+  author={Zhu, Xiao Xiang and Hu, Jingliang and Qiu, Chunping and Shi, Yilei and Kang, Jian and Mou, Lichao and Bagheri, Hossein and Haberle, Matthias and Hua, Yuansheng and Huang, Rong and Hughes, Lloyd and Li, Hao and Sun, Yao and Zhang, Guichen and Han, Shiyao and Schmitt, Michael and Wang, Yuanyuan},
+  journal={IEEE Geoscience and Remote Sensing Magazine}, 
+  title={So2Sat LCZ42: A Benchmark Data Set for the Classification of Global Local Climate Zones [Software and Data Sets]}, 
+  year={2020},
+  volume={8},
+  number={3},
+  pages={76-89},
+  doi={10.1109/MGRS.2020.2964708}}
+```
+