Operator FlightPathEncounter

Specialized toolkits - release 4.3.1.0-prod20190605 > com.ibm.streams.geospatial 3.3.2 > com.ibm.streams.geospatial > FlightPathEncounter

Primitive operator image not displayed. Problem loading file: ../../image/tk$com.ibm.streams.geospatial/op$com.ibm.streams.geospatial$FlightPathEncounter.svg

This operator tracks flying objects and calculates possible encounters between the objects in the future.

Each incoming tuple contains the latest observation data for one object. The operator stores that data internally and extrapolates the flight path of the object into the future. Than it calculates intersections of the flight path with the paths of all the other objects stored in the operator. For each object that comes close to the input object an output tuple is generated that contains the two objects, their latest observation data and the timestamp in the future when the encounter will happen. In addition the distance between the objects at the calculated time is also included in the output.

The conditions for detecting an encounter can be configured via operator parameters searchRadius and altitudeSearchRadius.The observations contain a unique identifier for each object as well as several parameters like longitude,latitude,altitude,heading and speed. Also each observation contains a timestamp.

For reference of the fields see the preconfigured type Observation3D in FlightPathEncounterTypes .

Consistent region behaviour

The operator cannot be part of a consistent region.

Summary

Ports
This operator has 1 input port and 1 output port.
Windowing
This operator does not accept any windowing configurations.
Parameters
This operator supports 15 parameters.

Required: altitudeSearchRadius, eastLongitude, northLatitude, numLatitudeDivs, numLongitudeDivs, searchRadius, southLatitude, timeSearchInterval, westLongitude

Optional: cleanupInterval, encounterAttribute, encounterDistanceAttribute, encounterTimeAttribute, filterByBoundingBox, observationAttribute

Metrics
This operator does not report any metrics.

Properties

Implementation
Java

Input Ports

Ports (0)

The schema for this port needs to contain a TUPLE attribute for the flying object observations. See FlightPathEncounterTypes for reference. You can use the preconfigured type EncounterEvent for convenience.

Properties

Output Ports

Assignments
Java operators do not support output assignments.
Ports (0)

The output port contains data related to possible encounters of the flying objects.For each encounter a separate tuple is submitted. You can use the preconfigured type EncounterEvent for convenience.

Properties

Parameters

This operator supports 15 parameters.

Required: altitudeSearchRadius, eastLongitude, northLatitude, numLatitudeDivs, numLongitudeDivs, searchRadius, southLatitude, timeSearchInterval, westLongitude

Optional: cleanupInterval, encounterAttribute, encounterDistanceAttribute, encounterTimeAttribute, filterByBoundingBox, observationAttribute

altitudeSearchRadius

The altitiude distance around the flying objects path, searched for collosions with other objects. Given in meters.

Properties
cleanupInterval

The flying objects are periodically cleaned up from the internal data tables. During cleanup objects are removed whose last observation is older than the current observation minus the 'cleanupInterval'. If not specified the interval defaults to 3 times the value of the 'timeSearchInterval' parameter. Given in milliseconds. The cleanup is not performed on each incoming tuple, instead it is performed when the timestamp of the incoming observation is newer than the timesatmp of the last cleanup plus a third of the 'cleanupInterval' parameter. For example if the 'cleanupInterval' is set to 15 minutes (900000 milliseconds), the operation is invoked roughly every 5 minutes.

Properties
eastLongitude

The longitude of the east border of the bounding box for the spatial index used by the Encounter detector. Given in degrees. Must be between 0 (greenwich median) and 360.

Properties
encounterAttribute

The name of an output attribute of type TUPLE that will contains the data for a detected encounter. The Tuple must be of type com.ibm.streams.geospatial.FlightPathEncounterTypes.Observation3D. See FlightPathEncounterTypes for reference.

Properties
encounterDistanceAttribute

The name of an output attribute that will hold the closest lat/lon distance in meters between the objects this encounter was detected for.

Properties
encounterTimeAttribute

The name of an output attribute that will hold the time in milliseconds relative to the timestamp of the observation for this encounter.

Properties
filterByBoundingBox

Set this parameter to 'true' if observations whith locations outside the bounding box of the detectors spatial index shall be ignored. The bounding box of the detector is specified by the southLatitude,northLatitude,westLongitude and eastLongitude parameters. The default is 'false' so all observations are processed. Note that processing observations outside of the box may decrease the spatial index performance.

Properties
northLatitude

The latitude of the north border of the bounding box for the spatial index used by the Encounter detector. Given in degrees. Must be between -90 (south pole) and 90 (north pole).

Properties
numLatitudeDivs

Number of latitude divisions (rows) for the spatial index used by the Encounter detector. Must be greater than one.

Properties
numLongitudeDivs

Number of longitude divisions (columns) for the spatial index used by the Encounter detector. Must be greater than one.

Properties
observationAttribute

The name of an input attribute of type TUPLE that contains the data for the observation to process.The Tuple must be of type com.ibm.streams.geospatial.FlightPathEncounterTypes.Observation3D. See FlightPathEncounterTypes for reference.

Properties
searchRadius

The radius around the flying objects path, searched for other objects for potential collisions. Given in meters.

Properties
southLatitude

The latitude of the south border of the bounding box for the spatial index used by the Encounter detector. Given in degrees. Must be between -90 (south pole) and 90 (north pole).

Properties
timeSearchInterval

The time interval the flight path is extrapolated and searched for collisions with other objects. Given in milliseconds. Must be greater than one second.

Properties
westLongitude

The longitude of the west border of the bounding box for the spatial index used by the Encounter detector. Given in degrees. Must be between 0 (greenwich median) and 360.

Properties

Libraries

Operator class library
Library Path: ../../impl/lib/SpatialNativeFunctions.jar