Skip to main content

SpatialCentroid

Updated
globalmapper.SpatialCentroid(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) → GM_Error_t32

The Centroid spatial transform creates a new layer with a point at the geometric center of the given area feature(s). The aGrouping parameter defines whether points should be created for every area in the layer, for feature groups by attribute, or one for the entire layer.

Parameters:

  • aLayer (GM_LayerHandle_t32) – Input layer

  • aParams (GM_SpatialOps_Params_t) – Parameters

  • aGrouping (GM_FeatureGrouping_t8) – Grouping type

  • aStr (str) – The attribute list string; may be an empty string

Returns:

Error Code

Return type:

GM_Error_t32


BEFORE

AFTER
../_images/multShapes.png ../_images/CentroidAfter.png

Example

The following is an example of SpatialCentroid.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/spatial_operations_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, "multShapes.shp"),
    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
spatial_params = gm.GM_SpatialOps_Params_t()
spatial_params.mResultLayerName = "Centroid_Result"
err_SpatialCentroid = gm.SpatialCentroid(
    layers_list[0], spatial_params, gm.GM_GroupingNone, ""
)

### 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_SpatialCentroid
), f"SpatialCentroid: Expected {gm.GM_Error_None}, got {err_SpatialCentroid}"

assert os.path.isdir(import_dir), f"Import directory doesn't exist: {import_dir}"
assert os.path.exists(
    os.path.join(import_dir, "multShapes.shp")
), "Sample data doesn't exist"