derive_stbnode properties | IBM Cloud Pak for Data as a Service

derive_stbnode properties

Space-Time-Boxes node icon The Space-Time-Boxes node derives Space-Time-Boxes from latitude, longitude, and timestamp fields. You can also identify frequent Space-Time-Boxes as hangouts.

Example

node = modeler.script.stream().createAt("derive_stb", "My node", 96, 96)

# Individual Records mode
node.setPropertyValue("mode", "IndividualRecords")
node.setPropertyValue("latitude_field", "Latitude")
node.setPropertyValue("longitude_field", "Longitude")
node.setPropertyValue("timestamp_field", "OccurredAt")
node.setPropertyValue("densities", ["STB_GH7_1HOUR", "STB_GH7_30MINS"])
node.setPropertyValue("add_extension_as", "Prefix")
node.setPropertyValue("name_extension", "stb_")

# Hangouts mode
node.setPropertyValue("mode", "Hangouts")
node.setPropertyValue("hangout_density", "STB_GH7_30MINS")
node.setPropertyValue("id_field", "Event")
node.setPropertyValue("qualifying_duration", "30MINUTES")
node.setPropertyValue("min_events", 4)
node.setPropertyValue("qualifying_pct", 65)

Table 1. Space-Time-Boxes node properties
`derive_stbnode` properties	Data type	Property description
`mode`	`IndividualRecords` `Hangouts`
`latitude_field`	field
`longitude_field`	field
`timestamp_field`	field
`hangout_density`	density	A single density. See `densities` for valid density values.
`densities`	[density,density,..., density]	Each density is a string (for example, `STB_GH8_1DAY`). Note that there are limits to which densities are valid. For the geohash, you can use values from `GH1` to `GH15`. For the temporal part, you can use the following values: `EVER` `1YEAR` `1MONTH` `1DAY` `12HOURS` `8HOURS` `6HOURS` `4HOURS` `3HOURS` `2HOURS` `1HOUR` `30MIN` `15MIN` `10MIN` `5MIN` `2MIN` `1MIN` `30SECS` `15SECS` `10SECS` `5SECS` `2SECS` `1SEC`
`id_field`	field
`qualifying_duration`	`1DAY` `12HOURS` `8HOURS` `6HOURS` `4HOURS` `3HOURS` `2HOURS` `1HOUR` `30MIN` `15MIN` `10MIN` `5MIN` `2MIN` `1MIN` `30SECS` `15SECS` `10SECS` `5SECS` `2SECS` `1SECS`	Must be a string.
`min_events`	integer	Minimum valid integer value is 2.
`qualifying_pct`	integer	Must be in the range of 1 and 100.
`add_extension_as`	`Prefix` `Suffix`
`name_extension`	string
`span_stb_boundaries`	boolean	Allow hangouts to span STB boundaries.