Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
extract_categorical_map_attributes [2015/10/13 20:18] admin |
extract_categorical_map_attributes [2026/08/28 03:17] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Extract Categorical Map Attributes ===== | + | ====== Extract Categorical Map Attributes ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor calculates basic statistics from a map for each area delimited by a class. The result is returned in a table contains the extracted classes and their corresponding attributes. | + | Calculates basic statistics from a map for each class delimited by a categorical map, returning them as a table indexed jointly by attribute and class. All layers of the map are analyzed together, and the resulting table refers to them jointly. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| Line 9: | Line 9: | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| | Map | [[Map Type]] | Map whose attributes will be extracted. | | | Map | [[Map Type]] | Map whose attributes will be extracted. | | ||
| - | | Categorical Map | [[Categorical Map Type]] | Map whose classes will be used to delimit the calculation areas in the input. | | + | | Categorical Map | [[Categorical Map Type]] | Map of classes used to delimit the calculation area for each class in Map. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ Default Value ^ | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| - | | Extract Statistical Attributes | [[Boolean Value Type]] | If true, [[Extract Map Attributes#Statistical attributes|statistical attributes]] will be calculated. | True | | + | | Extract Statistical Attributes | [[Boolean Value Type]] | If true, statistical attributes (mean, variance, standard deviation, mode, median, unique count) are also extracted. | Yes | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Attributes | [[Table Type]] | Table containing the attributes extracted from a map. | | + | | Attributes | [[Table Type]] | Table of extracted attributes, keyed by attribute and by class. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 27: | Line 27: | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | This functor analyzes all map layers. The resulting table refers to all of them. | + | Attributes has columns "Attribute" (key, the attribute's numeric code) and "Category" (key, the class value from Categorical Map), with the corresponding statistic in the "Value" data column. |
| - | The functor returns a table mapping classes and attributes to their corresponding attribute value. This table has the following format. | + | Each attribute has a predefined name that can be used to retrieve it by name (rather than by numeric key) in [[Calculate Map]], [[Calculate Categorical Map]], [[Calculate Value]], and the lookup table calculators. |
| - | ^ Column Name ^ Key or Data? ^ Column Type ^ Description ^ | + | If an attribute cannot be determined for a class, its entry is omitted from Attributes rather than being filled with a placeholder. Minimum and maximum values are only determined when the class has at least one non-null cell. |
| - | | "Attribute" | Key | Real | The attribute key | | + | |
| - | | "Category" | Key | Real | The map category | | + | |
| - | | "Value" | Data | Real | The attribute from the map | | + | |
| - | Each "Attribute" has a predefined name. This name can be used to retrieve the corresponding attribute in [[Calculate Map]], [[Calculate Categorical Map]], [[Calculate Value]] and [[Calculate Lookup Table]]. | + | Dynamic attributes, computed across all non-null cells of all layers within each class: |
| - | + | ||
| - | If it is not possible to determine any of these attributes, the corresponding entry in the output table is left blank. It determines the maximum and the minimum values only when there is at least one non null cell on the map for the given class. | + | |
| - | + | ||
| - | ==== Dynamic attributes ==== | + | |
| ^ Key ^ Predefined Name ^ Description ^ | ^ Key ^ Predefined Name ^ Description ^ | ||
| | 8 | "nullCells" | number of null cells | | | 8 | "nullCells" | number of null cells | | ||
| - | | 9 | "nonNullCells" | number of non null cells | | + | | 9 | "nonNullCells" | number of non-null cells | |
| | 10 | "minCell" | minimum value (excluding null cells) | | | 10 | "minCell" | minimum value (excluding null cells) | | ||
| | 11 | "maxCell" | maximum value (excluding null cells) | | | 11 | "maxCell" | maximum value (excluding null cells) | | ||
| | 12 | "cellSum" | sum of the values (excluding null cells) | | | 12 | "cellSum" | sum of the values (excluding null cells) | | ||
| - | ==== Statistical attributes ==== | + | Statistical attributes (present only when Extract Statistical Attributes is true), computed across all non-null cells of all layers within each class: |
| ^ Key ^ Predefined Name ^ Description ^ | ^ Key ^ Predefined Name ^ Description ^ | ||
| Line 58: | Line 51: | ||
| | 17 | "medianCell" | median (excluding null cells) | | | 17 | "medianCell" | median (excluding null cells) | | ||
| | 18 | "uniqueCells" | total unique occurrences (excluding null cells) | | | 18 | "uniqueCells" | total unique occurrences (excluding null cells) | | ||
| - | + | ||
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| ExtractCategoricalMapAttributes | ExtractCategoricalMapAttributes | ||