Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
create_categorical_map [2015/10/11 23:09] admin |
create_categorical_map [2026/08/28 03:14] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Create Categorical Map ====== | + | ====== Create Categorical Map ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor creates an empty map of classes or categories using the given parameters. | + | Creates an empty categorical map with the given dimensions, cell type, categorization, projection, and georeferencing. Every cell of the resulting map is initialized with the specified null value. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Lines | [[Positive Integer Value Type|Positive Integer Value]] | Number of lines. | | + | | Lines | [[Positive Integer Value Type]] | Number of lines of the map. | |
| - | | Columns | [[Positive Integer Value Type|Positive Integer Value]] | Number of columns. | | + | | Columns | [[Positive Integer Value Type]] | Number of columns of the map. | |
| - | | Cell Type | [[Cell Type Type|Cell Type]] | Data cell type. | | + | | Cell Type | [[Cell Type Type]] | Cell type of the map. | |
| - | | Null Value | [[Null Value Type|Null Value]] | Null value. | | + | | Null Value | [[Null Value Type]] | Null value of the map. | |
| - | | Categories | [[Categorization Type|Categorization]] | Map categories. | | + | | Categories | [[Categorization Type]] | Categorization of the map. | |
| - | | Projection | [[Projection Type|Projection]] | Map projection. | | + | | Projection | [[Projection Type]] | Projection assigned to the map. | |
| - | | Cell Width | [[Real Value Type|Real Value]] | Cell width. | | + | | Cell Width | [[Real Value Type]] | Width of a cell. The unit depends on the assigned projection. | |
| - | | Cell Height | [[Real Value Type|Real Value]] | Cell height. | | + | | Cell Height | [[Real Value Type]] | Height of a cell. The unit depends on the assigned projection. | |
| - | | Registration Coordinate Y | [[Real Value Type|Real Value]] | The registration coordinate Y. The unit used to represent the registration coordinate is based on the projection assigned. Corresponds to Northing or Latitude. | | + | | Registration Coordinate Y | [[Real Value Type]] | Y registration coordinate of the map (Northing or Latitude). The unit depends on the assigned projection. | |
| - | | Registration Coordinate X | [[Real Value Type|Real Value]] | The registration coordinate X. The unit used to represent the registration coordinate is based on the projection assigned. Corresponds to Easting or Longitude. | | + | | Registration Coordinate X | [[Real Value Type]] | X registration coordinate of the map (Easting or Longitude). The unit depends on the assigned projection. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Registration Cell Y | [[Positive Integer Value Type|Positive Integer Value]] | The line of the registered coordinate. The line 1 is the topmost line. | 1 | | + | | Registration Cell Y | [[Positive Integer Value Type]] | Line index of the cell to which the registration coordinate corresponds. Line 1 is the topmost line. This is an advanced port. | 1 | |
| - | | Registration Cell X | [[Positive Integer Value Type|Positive Integer Value]] | The column of the registered coordinate. The column 1 is the leftmost column. | 1 | | + | | Registration Cell X | [[Positive Integer Value Type]] | Column index of the cell to which the registration coordinate corresponds. Column 1 is the leftmost column. This is an advanced port. | 1 | |
| - | | Create As Sparse | [[Boolean Value Type|Boolean Value]] | If true, this flag forces the map to be created as a sparse raster set. Sparse raster set stores only non-null value cells, minimizing storage memory in detriment of access time. | False | | + | | Create As Sparse | [[Boolean Value Type]] | If true, forces the map to be created as a sparse raster set, which stores only non-null cells, trading slower access time for reduced storage. This is an advanced port. | Yes | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Map | [[Categorical Map Type|Categorical Map]] | The output map of classes or categories. | | + | | Map | [[Categorical Map Type]] | Created map. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 36: | Line 37: | ||
| ===== Notes ===== | ===== Notes ===== | ||
| - | All map cells are initialized with the specified null value. | + | All cells of the created map are initialized with the specified null value. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| CreateCategoricalMap | CreateCategoricalMap | ||