Differences

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

Link to this comparison view

Next revision
Previous revision
extract_categorical_map_attributes [2014/04/11 20:52]
admin created
extract_categorical_map_attributes [2015/10/13 20:18]
admin
Line 3: Line 3:
 ===== Description ===== ===== Description =====
  
-This functor ​extracts the attributes and calculates basic statistics from a map and as a result ​creates ​a table that contains the extracted attributes.+This functor calculates basic statistics from a map for each area delimited by class. The result ​is returned in a table contains the extracted ​classes and their corresponding ​attributes.
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Map  | [[Map Type|Map]]  | Map whose attributes will be extracted. ​ | +| Map  | [[Map Type]] ​ | Map whose attributes will be extracted. ​ | 
-| Categorical Map  | [[Categorical Map Type|Categorical Map]]  | Map whose classes will be used to break the input map into subregions.  | +| Categorical Map  | [[Categorical Map Type]] ​ | Map whose classes will be used to delimit the calculation areas in the input. ​ |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  
-| Extract Dynamic Attributes ​ | [[Bool Type|Bool ]]  | If true, the [[Extract Map Attributes#​Dynamic attributes|dynamic attributes]] will be calculated. | True  | +| Extract Statistical Attributes ​ | [[Boolean Value Type]] ​ | If true, [[Extract Map Attributes#​Statistical attributes|statistical attributes]] will be calculated. | True  |
-| Extract Statistical Attributes ​ | [[Bool Type|Bool ]]  | If true, [[Extract Map Attributes#​Statistical attributes|statistical attributes]] will be calculated. | False  |+
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Attributes | [[Lookup ​Table Type|Lookup Table]]  | Table containing the attributes extracted from a map. | +| Attributes | [[Table Type]] ​ | Table containing the attributes extracted from a map. |
-| Layer Attributes | [[Table Type|Table]] ​ | Table containing the layer attributes. |+
  
 ===== Group ===== ===== Group =====
Line 32: Line 29:
 This functor analyzes all map layers. The resulting table refers to all of them. This functor analyzes all map layers. The resulting table refers to all of them.
  
-The functor ​employs ​lookup ​table with keys to the attributesEach key 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]].+The functor ​returns ​a table mapping classes and attributes ​to their corresponding attribute valueThis table has the following format.
  
-If it is not possible to determine any of these attributes, the corresponding entry in the lookup 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.+^ Column Name  ^ Key or Data?  ^ Column Type  ^ Description ​ ^ 
 +| "​Attribute" ​ | Key  | Real  | The attribute key  | 
 +| "​Category" ​ | Key  | Real  | The map category ​ | 
 +| "​Value" ​ | Data  | Real  | The attribute from the map  |
  
-==== Basic Attributes ====+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]].
  
-^ Key  ^ Predefined Name  ^ Description ​ ^ +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.
-| 1  | "​lines" ​ | number ​of lines  | +
-| 2  | "​columns" ​ | number of columns ​ | +
-| 3  | "​cells" ​ | number of cells (number of lines multiplied by the number of columns) ​ | +
-| 4  | "​layers" ​ | number of layers ​ | +
-| 5  | "​cellHeight" ​ | cell height (in meters) ​ | +
-| 6  | "​cellWidth" ​ | cell width (in meters) ​ | +
-| 7  | "​cellArea" ​ | cell area (in hectares) ​ | +
-| 19  | "​cellType" ​ | [[Extract Map Attributes#​Cell Type Codes|cell type code]] ​ | +
-| 20  | "​nullValue" ​ | null value  |+
  
 ==== Dynamic attributes ==== ==== Dynamic attributes ====
Line 67: Line 58:
 | 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) ​ |
- 
-==== Cell Type Codes ==== 
- 
-The codes used to represent all the possible [[cell_type_type|cells types]], corresponding to attribute key 19 ("​cellType"​),​ are listed below. It is possible to convert the corresponding code back into a [[Cell Type Type|Cell Type]]. 
- 
-^ Key  ^ Cell Type  ^  
-| 0  | Unsigned 1 Bit Integer ​ | 
-| 1  | Signed 8 Bit Integer ​ | 
-| 2  | Unsigned 8 Bit Integer ​ | 
-| 3  | Signed 16 Bit Integer ​ | 
-| 4  | Unsigned 16 Bit Integer ​ | 
-| 5  | Signed 32 Bit Integer ​ | 
-| 6  | Unsigned 32 Bit Integer ​ | 
-| 7  | IEEE 754 32 Bit Real  | 
-==== Layer Attributes ==== 
- 
-The layer attributes((Currently,​ only the layer name is the only layer specific attribute returned.)) are returned in a second table. This table has the following format. 
- 
-^ Column Name  ^ Key or Data?  ^ Column Type  ^ Description ​ ^ 
-| "​Layer_Index" ​ | Key  | Real  | The index of the corresponding layer  | 
-| "​Layer_Name" ​ | Key  | String ​ | The name of the corresponding layer  | 
    
 ===== Internal Name ===== ===== Internal Name =====