add more colormaps (#641)

* add more colormaps * update tests
cogeotiff · Sep 27, 2023 · 1fe63d3 · 1fe63d3
1 parent 7bed9de
commit 1fe63d3
Show file tree

Hide file tree

Showing 80 changed files with 3,531 additions and 1,895 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -31,6 +31,22 @@
 
 * add `rio_tiler.utils.get_coverage_array` method to create a `coverage %` array
 
+* add `cmocean` colormaps
+
+    <img src="https://raw.githubusercontent.com/cogeotiff/rio-tiler/main/docs/src/img/colormaps_for_oceanography.png" style="max-width: 500px;"></a>
+
+* allow uppercase in `cmap.get` method
+
+    ```python
+    from rio_tiler.colormap import cmap
+
+    # Before
+    cm = cmap.get("greys")
+
+    # Now
+    cm = cmap.get("Greys")
+    ```
+
 # 6.1.0 (2023-09-15)
 
 * add `width`, `height` and `count` properties in `MosaicMethodBase`

diff --git a/docs/scripts/colormap_thumb.py b/docs/scripts/colormap_thumb.py
@@ -21,7 +21,6 @@
     (
         "Sequential",
         [
-            "Greys",
             "Purples",
             "Blues",
             "Greens",
@@ -118,6 +117,32 @@
             "gist_ncar",
         ],
     ),
+    (
+        "Colormaps for oceanography",
+        [
+            "thermal",
+            "haline",
+            "solar",
+            "ice",
+            "oxy",
+            "deep",
+            "dense",
+            "algae",
+            "matter",
+            "turbid",
+            "speed",
+            "amp",
+            "tempo",
+            "rain",
+            "phase",
+            "topo",
+            "balance",
+            "delta",
+            "curl",
+            "diff",
+            "tarn",
+        ],
+    ),
 ]
 
 
@@ -170,6 +195,7 @@ def main():
         out_path = (
             Path(__file__).parents[0]
             / ".."
+            / "src"
             / "img"
             / (cmap_category.replace(" ", "_").lower() + ".png")
         )

diff --git a/docs/src/api/rio_tiler/errors.md b/docs/src/api/rio_tiler/errors.md
@@ -41,6 +41,44 @@ def with_traceback(
 ```
 
 
+Exception.with_traceback(tb) --
+
+set self.__traceback__ to tb and return self.
+
+### AssetAsBandError
+
+```python3
+class AssetAsBandError(
+    /,
+    *args,
+    **kwargs
+)
+```
+
+#### Ancestors (in MRO)
+
+* rio_tiler.errors.RioTilerError
+* builtins.Exception
+* builtins.BaseException
+
+#### Class variables
+
+```python3
+args
+```
+
+#### Methods
+
+
+#### with_traceback
+
+```python3
+def with_traceback(
+    ...
+)
+```
+
+
 Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
@@ -160,10 +198,10 @@ Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
 
-### IncorrectTileBuffer
+### InvalidAssetName
 
 ```python3
-class IncorrectTileBuffer(
+class InvalidAssetName(
     /,
     *args,
     **kwargs
@@ -198,10 +236,10 @@ Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
 
-### InvalidAssetName
+### InvalidBandName
 
 ```python3
-class InvalidAssetName(
+class InvalidBandName(
     /,
     *args,
     **kwargs
@@ -236,10 +274,10 @@ Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
 
-### InvalidBandName
+### InvalidBufferSize
 
 ```python3
-class InvalidBandName(
+class InvalidBufferSize(
     /,
     *args,
     **kwargs
@@ -385,6 +423,44 @@ def with_traceback(
 ```
 
 
+Exception.with_traceback(tb) --
+
+set self.__traceback__ to tb and return self.
+
+### InvalidExpression
+
+```python3
+class InvalidExpression(
+    /,
+    *args,
+    **kwargs
+)
+```
+
+#### Ancestors (in MRO)
+
+* rio_tiler.errors.RioTilerError
+* builtins.Exception
+* builtins.BaseException
+
+#### Class variables
+
+```python3
+args
+```
+
+#### Methods
+
+
+#### with_traceback
+
+```python3
+def with_traceback(
+    ...
+)
+```
+
+
 Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
@@ -461,6 +537,44 @@ def with_traceback(
 ```
 
 
+Exception.with_traceback(tb) --
+
+set self.__traceback__ to tb and return self.
+
+### InvalidPointDataError
+
+```python3
+class InvalidPointDataError(
+    /,
+    *args,
+    **kwargs
+)
+```
+
+#### Ancestors (in MRO)
+
+* rio_tiler.errors.RioTilerError
+* builtins.Exception
+* builtins.BaseException
+
+#### Class variables
+
+```python3
+args
+```
+
+#### Methods
+
+
+#### with_traceback
+
+```python3
+def with_traceback(
+    ...
+)
+```
+
+
 Exception.with_traceback(tb) --
 
 set self.__traceback__ to tb and return self.
@@ -637,17 +751,20 @@ class RioTilerError(
 
 * rio_tiler.errors.InvalidFormat
 * rio_tiler.errors.TileOutsideBounds
-* rio_tiler.errors.IncorrectTileBuffer
+* rio_tiler.errors.InvalidBufferSize
 * rio_tiler.errors.PointOutsideBounds
 * rio_tiler.errors.InvalidBandName
 * rio_tiler.errors.InvalidColorMapName
 * rio_tiler.errors.InvalidAssetName
+* rio_tiler.errors.InvalidExpression
 * rio_tiler.errors.MissingAssets
 * rio_tiler.errors.MissingBands
 * rio_tiler.errors.InvalidMosaicMethod
 * rio_tiler.errors.ColorMapAlreadyRegistered
 * rio_tiler.errors.EmptyMosaicError
 * rio_tiler.errors.InvalidColorFormat
+* rio_tiler.errors.AssetAsBandError
+* rio_tiler.errors.InvalidPointDataError
 
 #### Class variables
 

diff --git a/docs/src/api/rio_tiler/expression.md b/docs/src/api/rio_tiler/expression.md
@@ -12,9 +12,9 @@ None
 ```python3
 def apply_expression(
     blocks: Sequence[str],
-    bands: Sequence[Union[str, int]],
+    bands: Sequence[str],
     data: numpy.ndarray
-) -> numpy.ndarray
+) -> numpy.ma.core.MaskedArray
 ```