Skip to main content

GetLocationColor

Updated
globalmapper.GetLocationColor(GM_LayerHandle_t32 aLayer, float aXCoord, float aYCoord) → GM_Error_t32, GM_Color_t

Retrieves the color at a given location from a provided layer or from the list of currently loaded raster and elevation layers (topmost layer first).

Parameters:

  • aLayer (GM_LayerHandle_t32) – Layer to get color from or gm.NULL for topmost

  • aXCoord (float) – X coord in current projection

  • aYCoord (float) – Y coord in current projection

Returns:

Error Code

Return type:

GM_Error_t32

Returns:

Color of pixel at location

Return type:

GM_Color_t

Example

The following is an example of GetLocationColor.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/single_function_sample_data/"
# Close all layers that may be open
layers_are_open = gm.GetLoadedLayerList()
if layers_are_open:
    arr_ptr, arr_size = layers_are_open
    initial_layers = gm.GM_LayerHandle_array_frompointer(arr_ptr)
    for i in range(arr_size):
        gm.CloseLayer(initial_layers[i])

err_LoadLayerList, array_pointer, array_size_param = gm.LoadLayerList(
    os.path.join(import_dir, "Gardiner_DRG.tif"),
    gm.GM_LoadFlags_HideAllPrompts,
)

# Get handle for the loaded layers
arr_ptr, arr_size = gm.GetLoadedLayerList()
layers_array = gm.GM_LayerHandle_array_frompointer(arr_ptr)
layers_list = gm.carray_to_list(layers_array, arr_size)

### START SAMPLE
err_GetLocationColor, location_color = gm.GetLocationColor(
    gm.NULL, 433305, 4894203
)

### END SAMPLE

assert (
    gm.GM_Error_None == err_LoadLayerList
), f"LoadLayerList: Expected {gm.GM_Error_None}, got {err_LoadLayerList}"
assert (
    gm.GM_Error_None == err_GetLocationColor
), f"GetLocationColor: Expected {gm.GM_Error_None}, got {err_GetLocationColor}"