Merge pull request #55 from descarteslabs/feat/fractions

Adding fraction(s) arguments to metadata

Author: samskillman

descarteslabs/__init__.py

@@ -14,7 +14,7 @@
 
 # flake8: noqa
 
-__version__ = "0.1.6"
+__version__ = "0.2.0"
 from .auth import Auth
 descartes_auth = Auth()
 

descarteslabs/scripts/places

@@ -24,7 +24,7 @@ if __name__ == "__main__":
 
     parser = argparse.ArgumentParser()
 
-    parser.add_argument('command', choices=['find', 'place', 'prefix', 'placetypes'],
+    parser.add_argument('command', choices=['find', 'shape', 'prefix', 'placetypes'],
                         help='The action to take.')
     parser.add_argument('argument', nargs='?')
 

descarteslabs/services/metadata.py

@@ -49,9 +49,9 @@ def sources(self):
 
         return r.json()
 
-    def summary(self, const_id=None, sat_id=None, date='acquired', part='day',
-                place=None, geom=None, start_time=None, end_time=None,
-                params=None, bbox=False):
+    def summary(self, const_id=None, sat_id=None, date='acquired', part=None,
+                place=None, geom=None, start_time=None, end_time=None, cloud_fraction=None,
+                cloud_fraction_0=None, fill_fraction=None, params=None, bbox=False):
         """Get a summary of the results for the specified spatio-temporal query.
 
         :param list(str) const_id: Constellation identifier(s).
@@ -62,6 +62,9 @@ def summary(self, const_id=None, sat_id=None, date='acquired', part='day',
         :param str geom: A GeoJSON or WKT region of interest.
         :param str start_time: Desired starting date and time (inclusive).
         :param str end_time: Desired ending date and time (inclusive).
+        :param float cloud_fraction: Maximum cloud fraction, calculated by data provider.
+        :param float cloud_fraction_0: Maximum cloud fraction, calculated by cloud mask pixels.
+        :param float fill_fraction: Minimum scene fill fraction, calculated as valid/total pixels.
         :param bool bbox: If true, query by the bounding box of the region of interest.
         :param str params: JSON of additional query parameters.
 
@@ -135,6 +138,15 @@ def summary(self, const_id=None, sat_id=None, date='acquired', part='day',
         if end_time:
             kwargs['end_time'] = end_time
 
+        if cloud_fraction:
+            kwargs['cloud_fraction'] = cloud_fraction
+
+        if cloud_fraction_0:
+            kwargs['cloud_fraction_0'] = cloud_fraction_0
+
+        if fill_fraction:
+            kwargs['fill_fraction'] = fill_fraction
+
         if params:
             kwargs['params'] = json.dumps(params)
 
@@ -149,8 +161,9 @@ def summary(self, const_id=None, sat_id=None, date='acquired', part='day',
         return r.json()
 
     def search(self, const_id=None, sat_id=None, date='acquired', place=None,
-               geom=None, start_time=None, end_time=None, params=None,
-               limit=100, offset=0, bbox=True):
+               geom=None, start_time=None, end_time=None, cloud_fraction=None,
+               cloud_fraction_0=None, fill_fraction=None, params=None,
+               limit=100, offset=0, bbox=False):
         """Search metadata given a spatio-temporal query. All parameters are
         optional. Results are paged using limit/offset.
 
@@ -161,6 +174,9 @@ def search(self, const_id=None, sat_id=None, date='acquired', place=None,
         :param str geom: A GeoJSON or WKT region of interest.
         :param str start_time: Desired starting date and time (inclusive).
         :param str end_time: Desired ending date and time (inclusive).
+        :param float cloud_fraction: Maximum cloud fraction, calculated by data provider.
+        :param float cloud_fraction_0: Maximum cloud fraction, calculated by cloud mask pixels.
+        :param float fill_fraction: Minimum scene fill fraction, calculated as valid/total pixels.
         :param bool bbox: If true, query by the bounding box of the region of interest.
         :param str params: JSON of additional query parameters.
         :param int limit: Number of items to return.
@@ -213,6 +229,15 @@ def search(self, const_id=None, sat_id=None, date='acquired', place=None,
         if end_time:
             kwargs['end_time'] = end_time
 
+        if cloud_fraction:
+            kwargs['cloud_fraction'] = cloud_fraction
+
+        if cloud_fraction_0:
+            kwargs['cloud_fraction_0'] = cloud_fraction_0
+
+        if fill_fraction:
+            kwargs['fill_fraction'] = fill_fraction
+
         if params:
             kwargs['params'] = json.dumps(params)
 
@@ -233,7 +258,8 @@ def search(self, const_id=None, sat_id=None, date='acquired', place=None,
         return result
 
     def keys(self, const_id=None, sat_id=None, date='acquired', place=None,
-             geom=None, start_time=None, end_time=None, params=None, limit=100,
+             geom=None, start_time=None, end_time=None, cloud_fraction=None,
+             cloud_fraction_0=None, fill_fraction=None, params=None, limit=100,
              offset=0, bbox=False):
         """Search metadata given a spatio-temporal query. All parameters are
         optional. Results are paged using limit/offset.
@@ -245,6 +271,9 @@ def keys(self, const_id=None, sat_id=None, date='acquired', place=None,
         :param str geom: A GeoJSON or WKT region of interest.
         :param str start_time: Desired starting date and time (inclusive).
         :param str end_time: Desired ending date and time (inclusive).
+        :param float cloud_fraction: Maximum cloud fraction, calculated by data provider.
+        :param float cloud_fraction_0: Maximum cloud fraction, calculated by cloud mask pixels.
+        :param float fill_fraction: Minimum scene fill fraction, calculated as valid/total pixels.
         :param bool bbox: If true, query by the bounding box of the region of interest.
         :param str params: JSON of additional query parameters.
         :param int limit: Number of items to return.
@@ -266,13 +295,15 @@ def keys(self, const_id=None, sat_id=None, date='acquired', place=None,
         """
         result = self.search(sat_id=sat_id, const_id=const_id, date=date,
                              place=place, geom=geom, start_time=start_time,
-                             end_time=end_time, params=params, limit=limit,
-                             offset=offset, bbox=bbox)
+                             end_time=end_time, cloud_fraction=cloud_fraction,
+                             cloud_fraction_0=cloud_fraction_0, fill_fraction=fill_fraction,
+                             params=params, limit=limit, offset=offset, bbox=bbox)
 
         return [feature['id'] for feature in result['features']]
 
     def features(self, const_id=None, sat_id=None, date='acquired', place=None,
-                 geom=None, start_time=None, end_time=None, params=None,
+                 geom=None, start_time=None, end_time=None, cloud_fraction=None,
+                 cloud_fraction_0=None, fill_fraction=None, params=None,
                  limit=100, bbox=False):
         """Generator that combines summary and search to page through results.
 
@@ -282,7 +313,9 @@ def features(self, const_id=None, sat_id=None, date='acquired', place=None,
         """
         result = self.summary(sat_id=sat_id, const_id=const_id, date=date,
                               place=place, geom=geom, start_time=start_time,
-                              end_time=end_time, params=params, bbox=bbox)
+                              end_time=end_time, cloud_fraction=cloud_fraction,
+                              cloud_fraction_0=cloud_fraction_0, fill_fraction=fill_fraction,
+                              params=params, bbox=bbox)
 
         for summary in result:
 
@@ -294,8 +327,10 @@ def features(self, const_id=None, sat_id=None, date='acquired', place=None,
 
                 features = self.search(sat_id=sat_id, const_id=const_id,
                                        date=date, place=place, geom=geom,
-                                       start_time=start_time,
-                                       end_time=end_time, params=params,
+                                       start_time=start_time, end_time=end_time,
+                                       cloud_fraction=cloud_fraction,
+                                       cloud_fraction_0=cloud_fraction_0,
+                                       fill_fraction=fill_fraction, params=params,
                                        limit=limit, offset=offset, bbox=bbox)
 
                 offset = limit + offset

descarteslabs/tests/test_metadata.py

@@ -40,6 +40,13 @@ def test_sat_id(self):
         r = self.instance.search(start_time='2016-09-01', end_time='2016-09-02', sat_id='LANDSAT_8')
         self.assertEqual(100, len(r['features']))
 
+    @unittest.skipIf(is_external_user(), "currently requires internal user")
+    def test_cloud_fraction(self):
+        r = self.instance.search(start_time='2016-09-01', end_time='2016-09-02', sat_id='LANDSAT_8',
+                                 cloud_fraction=0.5)
+        for feature in r['features']:
+            self.assertLess(feature['properties']['cloud_fraction'], 0.5)
+
     @unittest.skipIf(is_external_user(), "currently requires internal user")
     def test_const_id(self):
         r = self.instance.search(start_time='2016-09-01', end_time='2016-09-02', const_id=['L8'])
@@ -58,7 +65,21 @@ def test_place(self):
     @unittest.skipIf(is_external_user(), "currently requires internal user")
     def test_summary(self):
         r = self.instance.summary(start_time='2016-09-01', end_time='2016-09-02', const_id=['L8'])
-        self.assertEqual(1, len(list(r['items'])))
+        self.assertIn('const_id', r)
+        self.assertIn('count', r)
+        self.assertIn('pixels', r)
+        self.assertIn('bytes', r)
+        self.assertGreater(r['count'], 0)
+
+    @unittest.skipIf(is_external_user(), "currently requires internal user")
+    def test_summary_part(self):
+        r = self.instance.summary(start_time='2016-09-01', end_time='2016-09-02', const_id=['L8'], part='year')
+        self.assertIn('const_id', r)
+        self.assertIn('count', r)
+        self.assertIn('pixels', r)
+        self.assertIn('bytes', r)
+        self.assertIn('items', r)
+        self.assertEqual(len(r['items']), 1)
 
 
 if __name__ == '__main__':

setup.py

@@ -19,7 +19,7 @@
 from setuptools import setup, find_packages
 
 
-__version__ = "0.1.6"
+__version__ = "0.2.0"
 
 
 def do_setup():