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
assign_map_categories [2011/07/25 14:51]
hermann [Optional Inputs] 		assign_map_categories [2026/08/28 03:09] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Assign Map Categories ====== ​+====== Assign Map Categories ======
  
 ===== Description ===== ===== Description =====
  
-This functor ​assigns a set of categories to a map. The functor also allows combination ​or replacement of the existing map categories with a given set of categories.+Copies an input map to the output and assigns ​it a given categorization,​ either replacing the map's existing categorization ​or combining ​the two.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name             ​^ Type                                    ^ Description ​                                                  ​^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Input Map        | [[Map Type|Categorical Map ]]           ​| The map that receives the new categories. ​                    | +| Input Map  | [[Map Type]] ​ | Map that receives the new categorization.  |
-| Input Categories | [[Categorization Type|Categorization ]] | Categorization set (classes) to be assigned to the input map. |+
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name               ​^ Type                ^ Description ​                                                                                                                                                                          ​^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Combine ​Categories | [[Bool Type|Bool ]] | If true, the functor will combine the categories of the input map with the given category set. Otherwise, the categories in the input map will be replaced by the given category set. | False         |+| Input Categories ​ | [[Categorization ​Type]]  ​| Categorization to assign to the output map. If not specified, the categorization is automatically generated from the image values. ​ | None  | 
 +| Combine Categories ​ | [[Boolean Value Type]]  | If true, combines Input Categories with the input map's own categorization. If false, the input map's categorization is replaced by Input Categories.  | No  ​|
  
-===== Output ​=====+===== Outputs ​=====
  
-^ Name       ​^ Type              ^ Description ​                                       ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Output Map | [[Map Type|Map ]] | A copy of the input map with a new categorization. |+| Output Map  | [[Categorical ​Map Type]] ​ | Copy of the input map with the new categorization. ​ |
  
 ===== Group ===== ===== Group =====
Line 27: Line 27:
 ===== Notes ===== ===== Notes =====
  
-When "Combine Categories" ​is set, the functor combines the category sets, one from the input port and other from the input map. The main one is that passed as a parameter, thus, if both have an identical ​name or value, the category ​from the map will be replaced ​with the new one.+When Combine Categories is true, categories ​from Input Categories take priority over the input map's own categorization: ​if both define a category under the same name or value, the input map'​s ​category ​is replaced ​by the one from Input Categories.
  
 ===== Internal Name ===== ===== Internal Name =====