Search Reference

geom

Description

The geom command adds a field, named "geom", to each event. This field contains geographic data structures for polygon geometry in JSON. These geographic data structures are used to create choropleth map visualizations.

For more information about choropleth maps, see "Mapping data" in the Dashboards and Visualizations manual.

Syntax

geom [<featureCollection>] [featureIdField=<string>] [gen=<double>] [min_x=<double>] [min_y=<double>] [max_x=<double>] [max_y=<double>]

Optional arguments

featureCollection

Syntax: <geo_lookup>

Description: Specifies the geographic lookup file that you want to use. Two geographic lookup files are included with Splunk platform: geo_us_states and geo_countries. You can install your own geographic lookups from KMZ files. See Usage for more information.

featureIdField

Syntax: featureIdField = <field>

Description: If the event contains the featureId in a field named something other than "featureId", use this option to specify the field name.

gen

Syntax: gen=<double>.

Description: Specifies generalization, in the units of the data. For example, gen=0.1 generalizes (reduces the size of) the geometry by running the Douglass Puiker Ramer algorithm on the polygons with a parameter of 0.1 degrees.

Default: 0.1

min_x

Syntax: min_x=<double>

Description: The X coordinate for the bottom-left corner of the bounding box for the geometric shape. The range for the coordinate is -180 to 180. See Usage for more information.

Default: -180

min_y

Syntax: min_y=<double>

Description: The Y coordinate for the bottom-left corner of the bounding box for the geometric shape. The range for the coordinate is -90 to 90.

Default: -90

max_x

Syntax: max_x=<double>

Description: The X coordinate for the upper-right corner of the bounding box for the geometric shape. The range for the coordinate -180 to 180.

Default: 180

max_y

Syntax: max_y=<double>

Description: The Y coordinate for the upper-right corner of the bounding box for the geometric shape. The range is -90 to 90.

Default: 90

Usage

To use your own lookup, you must define the lookup in the transforms.conf file. You specify the name of the lookup stanza in the transforms.conf file for the featureCollection argument. Set external_type=geo in the stanza. See Configure geospatial lookups in the Knowledge Manager Manual.

When no arguments are provided, the geom command looks for a field named featureCollection and a column named featureIdField in the event. These fields are present in the default output from a geoindex lookup.

The min_x, min_y, max_x, and max_y arguments are used to clip the geometry. Use these arguments to define a bounding box for the geometric shape. You can specify the minimum rectangle corner (min_x, min_y) and the maximum rectangle corner (max_x, max_y). By specifying the coordinates, you are by definition returning only the data within those coordinates.

Examples

Example 1:

lookup geo_countries latitude as lat, longitude as long | stats count by featureIdField as country | geom geo_countries featureIdField="country"

Example 2:

... | geom geo_us_states featureIdField="state" gen=0.1 min_x=-130.5 min_y=37.6 max_x=-130.1 max_y=37.7

See also

geomfilter

Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has about using the geom command.