Differences

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

Link to this comparison view

Both sides previous revision Previous revision
get_map_categories [2016/07/11 16:36]
hermann 		get_map_categories [2026/08/28 03:20] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Get Map Categories ====== ​+====== Get Map Categories ======
  
 ===== Description ===== ===== Description =====
  
-This functor extracts the set of categories from the input map. +Extracts a copy of the categorization of a map.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Categorical Map  | [[Map Type]] ​ | Map with the required categories.  |+| Categorical Map  | [[Map Type]] ​ | Map whose categorization will be extracted.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
 +
 +None.
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Categories | [[Categorization Type]] ​ | The category set of the input map.  |+| Categories ​ | [[Categorization Type]] ​ | Categorization extracted from Categorical Map.  |
  
 ===== Group ===== ===== Group =====
Line 23: Line 25:
 ===== Notes ===== ===== Notes =====
  
-An error is always reported, ​if the input map does not provide the definition of any categories, an error is reported. +Raises an error if Categorical Map has no categorization defined. If this is expected to happen, use a [[Skip All On Error]] to intercept the error, and a [[Calculate Categorical Map]] to derive ​the categories from the map's values instead.
- +
-If necessary, use a [[Skip All On Error]] to intercept ​and trap the error and a [[Calculate Categorical Map]] to generate ​the map categories from the input map.+
  
-===== Internal Name ===== +===== Internal Name =====
  
 GetMapCategories GetMapCategories