Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
load_categorical_map [2015/10/13 18:50] admin |
load_categorical_map [2025/10/01 15:52] (current) admin |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Load Categorical Map ====== | + | ====== Load Categorical Map ====== |
| ===== Description ===== | ===== Description ===== | ||
| Line 15: | Line 15: | ||
| | 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 | | | 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 | | ||
| | 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 | | | 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 | | ||
| - | | Suffix Digits | [[Non Negative Integer Value Type]] | Number of digits used to represent the image file name suffix. | 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 | |
| + | | 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 | | ||
| + | | 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 | | ||
| + | | 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 | | | 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 | | | Workdir | [[Workdir Type]] | Workdir folder path. | None | | ||
| Line 28: | 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 do not represent categories. | See also [[Load Map]] for loading maps whose cells do not represent categories. | ||
| Line 38: | Line 42: | ||
| 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. | 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. | ||
| - | ===== Internal Name ===== | + | 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. |
| - | LoadCategoricalMap | + | ===== Internal Name ===== |
| + | LoadCategoricalMap | ||