Merge pull request #55 from geo-engine/rv-band-names

column names for raster vector join
geo-engine · Mar 22, 2024 · 551467e · 551467e
2 parents 6e25999 + 90b2c9e
commit 551467e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 7 deletions.
diff --git a/src/operators/rasterstacker.md b/src/operators/rasterstacker.md
@@ -9,6 +9,9 @@ All inputs must have the same data type and spatial reference.
 
 ## Parameters
 
+| Parameter   | Type          | Description                                                 | Example Value                          |
+| ----------- | ------------- | ----------------------------------------------------------- | -------------------------------------- |
+| renameBands | `RenameBands` | Specification of how to rename the bands to avoid conflicts | <pre><code>{ "type": "default" }</pre> |
 | Parameter   | Type          | Description                                                 | Example Value                          |
 | ----------- | ------------- | ----------------------------------------------------------- | -------------------------------------- |
 | renameBands | `RenameBands` | Specification of how to rename the bands to avoid conflicts | <pre><code>{ "type": "default" }</pre> |

diff --git a/src/operators/rastervectorjoin.md b/src/operators/rastervectorjoin.md
@@ -30,13 +30,25 @@ The `RasterVectorJoin` operator expects one _vector_ input and one or more _rast
 
 The `RasterVectorJoin` operator has the following parameters:
 
-| Parameter                         | Type                      | Description                                                                         | Example Value                      |
-| --------------------------------- | ------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------- |
-| `names`                           | `Array<String>`           | Each name reflects the output column of the join result.                            | <pre>"["NDVI", "Elevation"]"</pre> |
-| `featureAggregation`              | `first` or `mean`         | The aggregation function to use for features covering multiple pixels.              | <pre>"first"</pre>                 |
-| `featureAggregationIgnoreNoData`  | (optional) `boolean`      | Whether to ignore no data values in the aggregation. Defaults to `false`            | <pre>false</pre>                   |
-| `temporalAggregation`             | `none`, `first` or `mean` | The aggregation function to use for features covering multiple (raster) time steps. | <pre>"none"</pre>                  |
-| `temporalAggregationIgnoreNoData` | (optional) `boolean`      | Whether to ignore no data values in the aggregation. Defaults to `false`            | <pre>false</pre>                   |
+| Parameter                         | Type                      | Description                                                                         | Example Value                   |
+| --------------------------------- | ------------------------- | ----------------------------------------------------------------------------------- | ------------------------------- |
+| `names`                           | `ColumnNames`             | Specify how the new column names are derived from the raster band names.            | <pre>"{"type": "default}"</pre> |
+| `featureAggregation`              | `first` or `mean`         | The aggregation function to use for features covering multiple pixels.              | <pre>"first"</pre>              |
+| `featureAggregationIgnoreNoData`  | (optional) `boolean`      | Whether to ignore no data values in the aggregation. Defaults to `false`            | <pre>false</pre>                |
+| `temporalAggregation`             | `none`, `first` or `mean` | The aggregation function to use for features covering multiple (raster) time steps. | <pre>"none"</pre>               |
+| `temporalAggregationIgnoreNoData` | (optional) `boolean`      | Whether to ignore no data values in the aggregation. Defaults to `false`            | <pre>false</pre>                |
+
+## Types
+
+### ColumnNames
+
+The `ColumnNames` type is used to specify how the new column names are derived from the raster band names.
+
+| Value                                    | Description                                                                  |
+| ---------------------------------------- | ---------------------------------------------------------------------------- |
+| `{"type": "default"}`                    | Appends " (n)" to the band name with the smallest `n` that avoids a conflict |
+| `{"type": "suffix", "values": [string]}` | Specifies a suffix for each input, to be appended to the band names          |
+| `{"type": "rename", "values": [string]}` | A list of names for each new column                                          |
 
 ## Errors