Differences

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

Link to this comparison view

Next revision 		Previous revision
insert_map_layer [2012/11/09 14:22]
bruno created 		insert_map_layer [2026/08/28 03:25] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Insert ​Layer Map ====== ​+====== Insert Map Layer ======
  
 ===== Description ===== ===== Description =====
  
-This functor inserts ​a layer in a map in a certain ​position ​with a given name.+Inserts or replaces ​a layer of a map at a given position.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Source ​ | [[Map Type|Map]] ​ | Map whose non-null cells correspond to an occurrence ​of a category.   ​|+| Map  | [[Map Type]]  ​| Map the new layer is inserted into.  | 
 +| Layer  | [[Map Type]]  | Map whose first layer will be inserted into Map. Any further layers are ignored. ​ | 
 +| Layer Position ​ | [[Non Negative Integer Value Type]] ​ | Position where the layer is inserted. A value of zero, or one greater than Map's current number of layers, appends the new layer at the end.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Initial Patch Label  | [[Int Type|Int]]  | Initial number used to label the first patch found on the map.  | 1  | +| Layer Name  | [[Name Type]] ​ | Name the layer receives inside Map. If the layer is being replaced and no name is given, the replaced layer'​s original name is kept; if the layer is being added and no name is given, a unique name is generated automatically.  | .none  | 
-| Only Orthogonals Are Allowed ​ | [[Bool Type|Bool]] ​ | If true, only orthogonal cells will be considered first order neighbors. ​ | False  | +| Replace Layer  | [[Boolean ​Value Type]] ​ | If true, the layer at Layer Position ​is replaced by the new layer. If false, ​the layer currently at that position, and every layer after it, is shifted forward to make room for the new layer. This flag has no effect when the new layer is appended at the end.  | No  |
-| Window Lines  | [[Positive Int Type|Positive Int]]  | Number of lines of the neighbor search window.  | 3  | +
-| Window Columns ​ | [[Positive Int Type|Positive Int]]  | Number of columns of the neighbor search window.  | 3  | +
-| Cell Type  | [[Cell Type Type|Cell Type]] ​ | Data cell type.  | Signed 32 Bit Integer ​ | +
-| Null Value  | [[Int Type|Int]] ​ | Null value. ​ | 3  | +
-| Patch Labels Are Sparse ​ | [[Bool Type|Bool]]  | If true, the map is loaded as a sparse image. Sparse images have the advantage of storing only the cells containing non-null values, but they have diminished access time.  | False  |+
  
-===== Output ​=====+===== Outputs ​=====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Patch Labels ​ | [[Categorical ​Map Type|Categorical Map]]  | Map showing each group of cells as a patch identified by a label. It has the same dimensions as the source map.  |+| Map  | [[Map Type]] ​ | Map containing ​the new layer alongside ​the layers it already had.  |
  
 ===== Group ===== ===== Group =====
  
-[[Functor List#Map Algebra|Map Algebra]]+[[Functor List#Map Algebra | Map Algebra]]
  
 ===== Notes ===== ===== Notes =====
  
-The use of windows bigger than 3x3 allows disjoint cells to be considered ​as neighbors.+Only the first layer of Layer is used; any further layers it has are ignored. 
 + 
 +Layer must already ​be in the same format ​as Map; no conversion is performed.
  
 ===== Internal Name ===== ===== Internal Name =====
  
-CalcPatchLabelMap+InsertMapLayer