Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
crop_map_to_extents [2025/10/01 16:03] admin created |
crop_map_to_extents [2026/08/28 03:17] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor crops an input map, producing as output a crop window defined by the coordinates of two opposite corners (first and second), specified in the map's spatial reference system (CRS). | + | Crops an input map to a rectangular window defined by the coordinates of two opposite corners, expressed in the map's projection. The window can be specified using either pair of opposite corners; the functor determines the correct bounding box regardless of which two corners are given. The cropping is applied to every layer of the map. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| | Map | [[Map Type]] | Input map to be cropped. | | | Map | [[Map Type]] | Input map to be cropped. | | ||
| - | | First Window Coordinate X | [[Real Value Type]] | X coordinate of the first corner of the cropping window, expressed in the map projection units. It is possible to specify the window by either of the two opposite corners. The value must be within the map extent; otherwise, the operation will fail. The cropping is applied to all layers of the map. | | + | | First Window Coordinate X | [[Real Value Type]] | X coordinate of the first corner of the crop window, in the map's projection units. Must lie within the map's extent. | |
| - | | First Window Coordinate Y | [[Real Value Type]] | Y coordinate of the first corner of the cropping window, expressed in the map projection units. It is possible to specify the window by either of the two opposite corners. The value must be within the map extent; otherwise, the operation will fail. The cropping is applied to all layers of the map. | | + | | First Window Coordinate Y | [[Real Value Type]] | Y coordinate of the first corner of the crop window, in the map's projection units. Must lie within the map's extent. | |
| - | | Second Window Coordinate X | [[Real Value Type]] | X coordinate of the second corner of the cropping window, expressed in the map projection units. It is possible to specify the window by either of the two opposite corners. The value must be within the map extent; otherwise, the operation will fail. The cropping is applied to all layers of the map. | | + | | Second Window Coordinate X | [[Real Value Type]] | X coordinate of the second, opposite corner of the crop window, in the map's projection units. Must lie within the map's extent. | |
| - | | Second Window Coordinate Y | [[Real Value Type]] | Y coordinate of the second corner of the cropping window, expressed in the map projection units. It is possible to specify the window by either of the two opposite corners. The value must be within the map extent; otherwise, the operation will fail. The cropping is applied to all layers of the map. | | + | | Second Window Coordinate Y | [[Real Value Type]] | Y coordinate of the second, opposite corner of the crop window, in the map's projection units. Must lie within the map's extent. | |
| - | ===== Output ===== | + | ===== Optional Inputs ===== |
| + | |||
| + | None. | ||
| + | |||
| + | ===== Outputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Output | [[Map Type]] | Resulting map from the cropping operation, corresponding to the defined window. | | + | | Output | [[Map Type]] | Cropped map, corresponding to the defined window. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Input/Output | Input/Output]] | + | [[Functor List#Map Algebra | Map Algebra]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | The cropping window can be defined by any two opposite corners. The functor will automatically determine the correct bounding box regardless of which corners are specified (e.g., upper-left and lower-right, or upper-right and lower-left). | + | The cropping window can be defined by any two opposite corners; this functor determines the correct bounding box regardless of which corners are given (for example, upper-left and lower-right, or upper-right and lower-left). |
| - | All four coordinate parameters are required and must specify valid coordinates within the map extent. | + | If Map has multiple layers, the cropping is applied to every layer. |
| - | The cropping operation is applied to all layers of the map if the input map contains multiple layers. | + | Raises an error if any of the four window coordinates falls outside the extent of Map. |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| CropMapToExtents | CropMapToExtents | ||
| + | |||