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
load_categorical_map [2012/09/04 01:54]
admin 		load_categorical_map [2025/10/01 15:52] (current)
admin
Line 1: Line 1:
-====== Load Categorical Map ====== ​+====== Load Categorical Map ======
  
 ===== Description ===== ===== Description =====
Line 8: Line 8:
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
-| Filename ​ | [[Map Filename Type|Map Filename]]  | Name of the file that contains the map to be loaded. Dinamica automatically determines the file format from a selected file extension. ​ |+| Filename ​ | [[Map Filename Type]] ​ | Name of the file that contains the map to be loaded. Dinamica automatically determines the file format from a selected file extension. ​ |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Load As 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 diminshed ​access time. | False  | +| Null Value  | [[Null Value Type]] ​ | Additional value used to represent null cells. Cells with such value are also treated as null cells. This is particularly useful for assigning a null value to image files that do not have this definition. ​ | None  | 
-| Define Null Value  | [[Bool Type|Bool]]  | This flag forces ​the cells with the same value of the "​Null ​Value" parameter to be treated as a null cell. This is particularly useful for assigning a missing null value to a GeoTiff data.  | False  | +| Load As Sparse ​ | [[Boolean Value Type]] ​ | 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 worse access time.  | False  | 
-| Null Value  | [[Int Type|Int]]  | Value used to represent null cell. The "​Define Null Value" flag must be set in order to define a null value. ​This is particularly useful for assigning a missing ​null value to a GeoTiff data.  | 0  | +| Suffix Digits ​ | [[Non Negative Integer Value Type]] ​ | Number of digits in the suffix that will be used to represent ​the step to which the file corresponds. If a greater number of digits is needed than this value, the step itself is used without modifications. If the number ​of digits is zero, no suffix is added to the file name. This is an advanced port.  | 0  | 
-| Suffix Digits ​ | [[Non Negative Int Type|Non Negative Int]]  | Number ​of digits used to represent ​the image file name suffix.  | 0  | +| First Window Coordinate X  | [[Real ​Value Type]] ​ | X coordinate of the upper-left corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping ​is applied ​to all layers of the map.  | None  | 
-| step  | [[Non Negative ​Int Type|Non Negative Int]]  | Current step or model iteration. Files with the same name and numbered suffixes will be loaded sequentially according to the model step.  | None  | +| First Window Coordinate Y  | [[Real Value Type]] ​ | Y coordinate of the upper-left corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded ​in its entirety. The defined clipping is applied ​to all layers of the map.  | None  | 
-| Workdir ​ | [[Workdir Type|Workdir]]  | Workdir folder path.  | None  |+| Second Window Coordinate X  | [[Real Value Type]] ​ | X coordinate of the lower-right corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied ​to all layers of the map.  | None  | 
 +| Second Window Coordinate Y  | [[Real Value Type]] ​ | Y coordinate ​of the lower-right corner of the clipping window, expressed in the map projection units. The value must be within the map extent, otherwise the operation will fail. If null, the clipping window will not be defined and the map must be loaded in its entirety. The defined clipping is applied ​to all layers of the map.  | None  | 
 +| Step  | [[Non Negative ​Integer Value Type]] ​ | Current step or model iteration. Files with the same name and numbered suffixes will be loaded sequentially according to the model step.  | None  | 
 +| Workdir ​ | [[Workdir Type]] ​ | Workdir folder path.  | None  |
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Map  | [[Categorical Map Type|Categorical Map]]  | The map loaded by the functor. ​ |+| Map  | [[Categorical Map Type]] ​ | The map loaded by the functor. ​ |
  
 ===== Group ===== ===== Group =====
Line 29: Line 32:
 [[Functor List#​Input/​Output | Input/​Output]] [[Functor List#​Input/​Output | Input/​Output]]
  
-===== Notes ===== +===== Notes =====
  
-See also [[Load Map]] for loading maps whose cells represent categories.+See also [[Load Map]] for loading maps whose cells do not represent categories.
  
-For a list of file formats that Load Categorical Map can load, the supported [[wp>​Map_projection|projections]] and [[wp>​Datum_(geodesy)|datums]], check the [[supported map formats]].+If the "Null Value" parameter is specified, any cell corresponding to the original null value of the map, if provided, is converted to the new null value. This ensures that values originally represented by null value still representing null values, even if the null value definition changes. Any non-null value corresponding to the newly defined null value is also promoted to new null value.
  
-===== Internal Name ===== +For a list of file formats that Load Categorical Map can load, the supported [[wp>​Map_projection|projections]] and [[wp>​Datum_(geodesy)|datums]],​ check the [[supported map formats#​map_formats_supported_for_reading|supported map formats]].
  
-LoadCategoricalMap+It is possible to load maps from [[wp>​zip_(file_format)|Zip]] archives. See [[useful_tips#​loading_files_from_zip_files|this useful tip]] to know how to do it.
  
 +The clipping window parameters allow loading only a specific rectangular region of the map instead of the entire map. When all four window coordinate parameters are null (default), the entire map is loaded. To use the clipping window feature, all four coordinates (First Window Coordinate X, First Window Coordinate Y, Second Window Coordinate X, and Second Window Coordinate Y) must be defined together.
 +
 +===== Internal Name =====
 +
 +LoadCategoricalMap