Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
create_cube_map [2011/07/31 17:32]
hermann [Notes] 		create_cube_map [2026/08/28 03:14] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Create Cube Map ====== ​+====== Create Cube Map ======
  
 ===== Description ===== ===== Description =====
  
-This container assembles ​maps into a raster cube data set (multilayer map). +Assembles the maps connected inside this container ​into a single ​multilayer map (a raster cube), stacking one layer per connected map. Each map is connected through a [[Number And Name Map]] hook, which supplies the name and stacking position of its layer; hooks with position 0 are treated as unordered and are placed, sorted alphabetically by name, below every explicitly positioned layer.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Cell Type  | [[ Cell Type Type|Cell Type  ​]]  |  ​Output map cell type.  | +| Cell Type  | [[Cell Type Type]] ​ | Cell type of the output map.  | 
-| Null Value  | [[Int Type|Int  ​]]  | Output map null value. ​ |+| Null Value  | [[Null Value Type]] ​ | Null value of the output map. Must be compatible with Cell Type.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
 +
 +None.
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Map  | [[ Map Type|Map  ​]]  | The multilayer ​map.  |+| Map  | [[Map Type]] ​ | Multilayer ​map assembled from the connected layers.  |
  
 ===== Group ===== ===== Group =====
Line 22: Line 24:
 [[Functor List#Map Algebra | Map Algebra]] [[Functor List#Map Algebra | Map Algebra]]
  
-===== Notes ===== +===== Notes ===== 
 + 
 +Only [[Number And Name Map]] hooks can be connected inside this container. 
 + 
 +Only the first layer of each connected map is added to the cube; any further layers of that map are ignored. 
 + 
 +Every connected map must share the same dimensions; the first map's spatial format is used to validate the others and to build the output map. 
 + 
 +Categorization data carried by the connected maps is discarded. 
 + 
 +Each connected map's cells are cast to the output Cell Type; a cell whose value cannot be represented without truncation raises an error. Null cells are converted to the output Null Value.
  
-[[Number And Name Map]] functor must be used within ​this container ​to link the input maps.+Raises an error if no map is connected inside ​this container, if two connected maps share the same name, or if two connected ​maps are assigned the same stacking position.
  
-They are used to assign a name and an order to the layers of the output multilayer map. Zero means that the layer position in the output map is not relevant; the zero numbered maps will be sorted by name and stacked at the bottom of the pile.+Raises ​an error if Null Value is not compatible with Cell Type.
  
-===== Internal Name ===== +===== Internal Name =====
  
 CreateCubeMap CreateCubeMap