added Readme

Author: darius-lam

README.md

@@ -0,0 +1,5 @@
+## xView Data Utilities
+
+This repository contains data processing scripts for the xView dataset.  The script 'process_wv.py' is runnable and processes a folder containing xView imagery along with a groundtruth geojson file to create a TFRecord containing shuffled, chipped, and augmented xView patches in JPEG format.  We provide several augmentation functions in 'aug_util.py' for rotating and shifting images and bounding boxes, as well as noise injecting techniques like salt-and-pepper and gaussian blurring.  Additionally in 'wv_util.py' we provide several functions for loading, processing, and chipping xView data.
+
+The Jupyter Notebook provided in this repository interactively illustrates an example xView processing pipeline using the provided utility functions.

process_wv.py

@@ -32,7 +32,7 @@
 import csv
 
 """
-  A script that processes WorldView 3 imagery from Digital Globe.  
+  A script that processes xView imagery. 
 
   Args:
       image_folder: A folder path to the directory storing xView .tif files

wv_util.py

@@ -21,7 +21,7 @@
 from tqdm import tqdm
 
 """
-WorldView3 data processing helper functions for use in data processing.
+xView processing helper functions for use in data processing.
 """
 
 def scale(x,range1=(0,0),range2=(0,0)):