Differences

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

Link to this comparison view

Next revision 		Previous revision
extract_map_values [2011/07/31 15:48]
hermann created 		extract_map_values [2026/08/28 03:18] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Extract Map Values ====== ​+====== Extract Map Values ======
  
 ===== Description ===== ===== 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 ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Map  | [[ Map Type| Map  ​]]  | The input map.   ​|+| Map  | [[Map Type]] ​ | Input map.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Use Map Values As Keys  | [[Bool Type|Bool  ​]]  | If true, the map values are used to identify the cells in the output ​tables. Each cell value must be unique; otherwise, a unique key will be automatically generated to represent each cell.  | False  |+| 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, cells whose value equals Map's null value are also included ​in the output ​table.  | No  |
  
 ===== Outputs ===== ===== Outputs =====
  
-| Value Table  | [[ Lookup Table Type| Lookup Table  ]]  |  The resulting table containing the corresponding values. ​ | +^ Name  ^ Type  ​^ Description ​ ^ 
-| Line Table  | [[Lookup ​Table Type|Lookup Table  ​]]  | The resulting ​table containing the corresponding lines (Y coordinates). The upper line uses 1 as the line number. ​ | +| Cells  | [[Table Type]] ​ | Resulting ​table of cell values and coordinates. ​ |
-| Column Table  | [[Lookup Table Type|Lookup Table  ]]  | The resulting table containing the corresponding columns (X coordinates). The leftmost column uses 1 as the column number.  |+
  
 ===== Group ===== ===== Group =====
Line 27: Line 27:
 ===== Notes ===== ===== Notes =====
  
-===== Internal Name ===== +Cells has the following format: 
 + 
 +^ Column Name  ^ Key or Data?  ^ Column Type  ^ Description ​ ^ 
 +| "​Id" ​ | Key  | Real  | Unique row identifier, generated as determined by Keys Type.  | 
 +| "​Value" ​ | Data  | Real  | The cell's value. ​ | 
 +| "​Line" ​ | Data  | Real  | The cell's line, with the topmost line indexed as 1.  | 
 +| "​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. 
 + 
 +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 ExtractMapValues