Add metrics to docs, fix docstring and test bug (r-earthengine#31)

aazuspan · Jan 18, 2022 · 7c0dc6e · 7c0dc6e
1 parent 6502def
commit 7c0dc6e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/docs/modules/QA.rst b/docs/modules/QA.rst
@@ -13,4 +13,25 @@ Extra.QA
 .. autosummary::
    :toctree: stubs
 
-   preprocess
+   preprocess
+
+Metrics
+-------
+
+.. currentmodule:: ee_extra.QA.metrics
+
+.. autosummary::
+   :toctree: stubs
+
+   listMetrics
+   getMetrics
+   MSE
+   RMSE
+   RASE
+   ERGAS
+   DIV
+   bias
+   CC
+   CML
+   CMC
+   UIQI
diff --git a/ee_extra/QA/metrics.py b/ee_extra/QA/metrics.py
@@ -205,7 +205,7 @@ class ERGAS(Metric):
         >>> bands = ["B4", "B3", "B2"]
         >>> img1 = ee.Image("COPERNICUS/S2_SR/20210703T170849_20210703T171938_T14SPG").select(bands)
         >>> img2 = ee.Image("COPERNICUS/S2_SR/20210708T170851_20210708T171925_T14SPG").select(bands)
-        >>> metrics.ERGAS(img1, img2, bestEffort=True).getInfo()
+        >>> metrics.ERGAS(img1, img2, h=10, l=10, bestEffort=True).getInfo()
         3774.9270912567363
     """
 

diff --git a/tests/test_QA.py b/tests/test_QA.py
@@ -33,4 +33,4 @@ def test_all_metrics(self):
                 value = metric(img, modified, h=30, l=30)
             else:
                 value = metric(img, modified)
-                self.assertIsInstance(value, (ee.Number, ee.Dictionary))
+            self.assertIsInstance(value, (ee.Number, ee.Dictionary))