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_map [2013/03/04 18:03]
admin [Notes]
load_map [2015/10/12 16:32] (current)
admin
Line 8: Line 8:
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Filename | [[Map Filename Type|Map Filename  ​]] | Name and path of input map file. File format is automatically selected based on the filename extension. If path is not specified, file location is the same of model script. ​ |+| Filename | [[Map Filename Type]] ​ | Name and path of input map file. File format is automatically selected based on the filename extension. If path is not specified, file location is the same of model script. ​ |
  
 ===== 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 worse 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 null cells. 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 sparse imageSparse 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 ​null valueThis is particularly useful for assigning a missing ​null value to a GeoTiff data.  |  | +| Suffix Digits ​ | [[Non Negative ​Integer Value Type]] ​ | Number of digits used to represent the image file name suffix. ​ | 0  | 
-| Suffix Digits ​ | [[Non Negative ​Int Type|Non Negative Int]]  | Number of digits used to represent the image file name suffix. If the "​step"​ input is unbound, this options is ignored.  | 0  | +| 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 ​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  | +| Workdir ​ | [[Workdir Type]] ​ | Workdir folder path.  | None  |
-| Workdir ​ | [[Workdir Type|Workdir]]  | Workdir folder path.  | None  |+
  
 ===== Output ===== ===== Output =====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Map  | [[Map Type|Map]]  | The map loaded by this functor. ​ |+| Map  | [[Map Type]] ​ | The map loaded by this functor. ​ |
  
 ===== Group ===== ===== Group =====
Line 32: Line 31:
  
 See also [[Load Categorical Map]] for loading maps whose cells represent categories. See also [[Load Categorical Map]] for loading maps whose cells represent categories.
 +
 +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.
  
 For a list of file formats that Load 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]]. For a list of file formats that Load 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]].
 +
 +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 ===== ===== Internal Name =====
  
 LoadMap LoadMap