Differences

This shows you the differences between two versions of the page.

--- extract_map_values [2020/04/29 12:39]
argemiro
+++ extract_map_values [2026/08/28 03:18] (current)
hermann Sync from local documentation review
@@ Line 1: / Line 1: @@
 ====== Extract Map Values ======
 ===== Description =====
-This functor extracts map values and geographic coordinates and stores them in lookup tables.
+Extracts every cell value of a map, together with its coordinates, into a single table with one row per cell.
 ===== Inputs =====
 ^ Name  ^ Type  ^ Description  ^
-| Map  | [[Map Type]]  | The input map.   |
+| Map  | [[Map Type]]  | Input map.  |
 ===== Optional Inputs =====
 ^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| keys Type  | [[Boolean Value Type]]  | Behavior of id into map.
+| Keys Type  | [[Enum Type]]  | Determines how each output row's unique "Id" is generated. With Default, the id is assigned randomly when execution is parallel, or sequentially otherwise. With Use Map Values As Keys, the cell's own value is used as its id. With Use Coordinate Indexes as Keys, the cell's coordinate index (row-major position) is used as its id.  | Default  |
-| include Null Values  | [[Boolean Value Type]]  | If true, the null values will be included into output table.
+| Include Null Values  | [[Boolean Value Type]]  | If true, cells whose value equals Map's null value are also included in the output table.  | No  |
 ===== Outputs =====
 ^ Name  ^ Type  ^ Description  ^
-| Cells  | [[Table Type]]  | The resulting table containing the corresponding values and coordinates. The table has columns "Id" (key corresponding to a unique identifier), "Value" (cell value), "Line" and "Column" (corresponding to the cell line and column). The upper line is indexed using 1 as the line number. The leftmost column is indexed using 1 as the column number.With Default, the id will be a unique sequentially random if the execution is parallel, or simply sequentially otherwise. With the Use Map Values As keys, the map values will be used to identify the cells in the output table. With the Use Coordinate indexes as Keys, the indexes of map coordinates will be used to identify the cells in the output table.
+| Cells  | [[Table Type]]  | Resulting table of cell values and coordinates.  |
 ===== Group =====
@@ Line 27: / Line 27: @@
 ===== Notes =====
-The table containing the resulting cells has the following format.
+Cells has the following format:
 ^ Column Name  ^ Key or Data?  ^ Column Type  ^ Description  ^
-| "Id"  | Key  | Real  | Unique identifier. If the flag "Use Map Values As Keys" is set, the cell value is used as the unique identifier.  |
+| "Id"  | Key  | Real  | Unique row identifier, generated as determined by Keys Type.  |
-| "Value"  | Data  | Real  | Cell value  |
+| "Value"  | Data  | Real  | The cell's value.  |
-| "Line"  | Data  | Real  | Cell line. The upper line is indexed using 1 as the line number.  |
+| "Line"  | Data  | Real  | The cell's line, with the topmost line indexed as 1.  |
-| "Column"  | Data  | Real  | Cell column. The leftmost column is indexed using 1 as the column number.  |
+| "Column"  | Data  | Real  | The cell's column, with the leftmost column indexed as 1.  |
+By default, cells equal to Map's null value are skipped, unless Include Null Values is true.
-===== Internal Name =====
+Raises an error if Keys Type is Use Map Values As Keys and Map has more than one layer, since a cell value would then no longer be unique across layers.
+===== Internal Name =====
 ExtractMapValues