**IBM Streams 4.2**

# Functions: com.ibm.streams.geospatial 3.0.2

## Functions

- area(T)
- Computes the area of the provided geometry, is always 0.0 for 0-d and 1-d objects. Area is computed on the spherical earth model for 2-d geometries. In case of an exception, -1 will be returned and the exception logged.
- azimuth(Metric.metricType, PointPropertyType.point128, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
- azimuth(Metric.metricType, PointPropertyType.point32, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
- azimuth(Metric.metricType, PointPropertyType.point64, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::azimuth instead. This function computes the distance between the two points using the algorithm provided in the metric type
- azimuth(T, T)
- Computes the azimuth between two points expressed in WGS84 coordinates, the input points are in WKT format.
- base32GeohashToBinary(T)
- Converts a geohash in base32 format to a binary string.
- binaryGeohashToBase32(T)
- Converts a geohash in binary format to a base32 string.
- containingGeohash(T, float64)
- Provides a utility method to do spatial aggregation on point geometry data, where the input geometry is expected to be a point (in WGS84 coordinates) in WKT format and a boxSize in meters.
- contains(T, T)
- Determines if the first geometry contains the second geometry, geometries are specified in WKT format.
- createLineSegment128( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment128
- createLineSegment32( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment32
- createLineSegment64( com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::lineSegment instead. This function creates a lineSegment64
- createLineString128( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment128>)
- Deprecated as of Streams version 4.0. This function creates a list of lineSegment128
- createLineString32( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment32>)
- Deprecated as of Streams version 4.0. This function creates a list of lineSegment32
- createLineString64( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment64>)
- Deprecated as of Streams version 4.0. This function creates a list of lineSegment64
- createLinearSimplePolygon128( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.ext::orientedPolygon instead. This function creates a linear simple polygon128
- createLinearSimplePolygon32( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.orientedPolygon instead. This function creates a linear simple polygon32
- createLinearSimplePolygon64( list<com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::polygon or com.ibm.streams.geospatial.ext::orientedPolygon instead. This function creates a linear simple polygon64
- createPoint128(float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point128
- createPoint32(float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point32
- createPoint64(float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::point instead. This function creates a point64
- destinationPoint(T, float64, float64)
- Computes the destination point given a point, the heading/azimuth, and the distance in meters, the input point is in WKT format with WGS84 coordinates, the output point is in WKT WGS84 format.
- destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
- destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
- destinationPoint( com.ibm.streams.geospatial.twodimension.geometry::Metric.metricType, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, float64, float64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::destinationPoint instead. This function computes the distance between the two points using the algorithm provided in the metric type
- distance(Metric.metricType, PointPropertyType.point128, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
- distance(Metric.metricType, PointPropertyType.point32, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
- distance(Metric.metricType, PointPropertyType.point64, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the algorithm provided in the metric type
- distance(T, T)
- Computes the shortest distance in meters between given geometries in WKT format on the spherical earth model.
- distanceEllipsoidal(PointPropertyType.point128, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
- distanceEllipsoidal(PointPropertyType.point32, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
- distanceEllipsoidal(PointPropertyType.point64, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the Haversine Formula
- distanceGreatCircle(PointPropertyType.point128, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
- distanceGreatCircle(PointPropertyType.point32, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
- distanceGreatCircle(PointPropertyType.point64, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::distance instead. This function computes the distance between the two points using the GreatCircle Formula
- distanceHaversine(PointPropertyType.point128, PointPropertyType.point128)
- distanceHaversine(PointPropertyType.point32, PointPropertyType.point32)
- distanceHaversine(PointPropertyType.point64, PointPropertyType.point64)
- feetAndInchesToMeters(int32, int32)
- Deprecated since Streams version 4.0.
- feetAndInchesToMeters(int64, int64)
- Deprecated since Streams version 4.0.
- feetToMeters(float32)
- Deprecated since Streams version 4.0.
- feetToMeters(float64)
- Deprecated since Streams version 4.0.
- feetToMeters(int32)
- Deprecated since Streams version 4.0.
- feetToMeters(int64)
- Deprecated since Streams version 4.0.
- geohashDecode(T)
- Decodes a given geohash to its corresponding geometry in WKT format.
- geohashDistanceEncode(T, float64)
- Encodes the input geometry as a bit representation geohash.
- geohashEncode(T)
- Encodes the provided geometry as a geohash in bit representation.
- geohashStringDecode(T)
- Decodes a given base 32 encoded geohash to its corresponding point geometry in WKT format.
- geohashStringEncode(T)
- Encodes the provided point as a base 32 encoded string.
- getLatitude(PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. This function computes the latitude from a point
- getLatitude(PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. This function computes the latitude from a point
- getLatitude(PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLatitude instead. his function computes the latitude from a point
- getLatitude(T)
- Extract latitude from WKT point geometry
- getLongitude(PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
- getLongitude(PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
- getLongitude(PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.ext::getLongitude instead. This function computes the Longitude from a point
- getLongitude(T)
- Extract longitude from WKT point geometry
- inchesToMeters(float32)
- Deprecated since Streams version 4.0.
- inchesToMeters(float64)
- Deprecated since Streams version 4.0.
- inchesToMeters(int32)
- Deprecated since Streams version 4.0.
- inchesToMeters(int64)
- Deprecated since Streams version 4.0.
- intersects(T, T)
- Computes if the two geometries intersect, resulting in either true/false as the output.
- isContained(CurvePropertyType.lineSegment128, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment128 contains a point128
- isContained(CurvePropertyType.lineSegment32, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment32 contains a point32
- isContained(CurvePropertyType.lineSegment64, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a lineSegment64 contains a point64
- isContained(list<PointPropertyType.point128>, PointPropertyType.point128)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon128 contains a linearsimplepolygon128
- isContained(list<PointPropertyType.point128>, list<PointPropertyType.point128>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon128 contains a linearsimplepolygon128
- isContained(list<PointPropertyType.point32>, PointPropertyType.point32)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon32 contains a linearsimplepolygon32
- isContained(list<PointPropertyType.point32>, list<PointPropertyType.point32>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon32 contains a linearsimplepolygon32
- isContained(list<PointPropertyType.point64>, PointPropertyType.point64)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon64 contains a linearsimplepolygon64
- isContained(list<PointPropertyType.point64>, list<PointPropertyType.point64>)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::contains instead. This function checks if a linearsimplepolygon64 contains a linearsimplepolygon64
- isValid(T)
- Validates the given input geometry, the input is in WKT format and the output is a true/false
- kilometersToMeters(float32)
- Deprecated since Streams version 4.0.
- kilometersToMeters(float64)
- Deprecated since Streams version 4.0.
- kilometersToMeters(int32)
- Deprecated since Streams version 4.0.
- kilometersToMeters(int64)
- Deprecated since Streams version 4.0.
- lineSegment(float64, float64, float64, float64)
- Constructs a line segment from four doubles, the order is specified as 'startlongitude, startlatitude, endlongitude, endlatitude' and the output is a WKT formatted geometry
- mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment128>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point128, R)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides with the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
- mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment32>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point32, R)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
- mapPointToLineString( list<com.ibm.streams.geospatial.twodimension.geometry::CurvePropertyType.lineSegment64>, com.ibm.streams.geospatial.twodimension.geometry::PointPropertyType.point64, R)
- Deprecated as of Streams version 4.0. Use com.ibm.streams.geospatial.st::nearestPoint instead. This functions provides the ability to (a) find coordinates of a point Q on a given line string route (e.g., route traveled by the bus) that is closest to a given point P (e.g., a position on the diverted route taken by the bus); (b) compute distance between point P and Q (e.g., to determine how far the bus has taken diversion from the original route) which is returned in variable crossTrackDistance, and (c) compute distance along the line string from start (first point) of line string (route) and point Q which is returned in the variable alongTrackDistance.
- milesToMeters(float32)
- Deprecated since Streams version 4.0.
- milesToMeters(float64)
- Deprecated since Streams version 4.0.
- milesToMeters(int32)
- Deprecated since Streams version 4.0.
- milesToMeters(int64)
- Deprecated since Streams version 4.0.
- nearestPoint(T, T)
- Finds the nearest point on a linestring from a given point, where both geometries are specified in WKT format and WGS84 coordinates.
- orientedPolygon(T)
- Constructs a polygon that has its orientation specified, the polygon is a simple polygon and specified as a string with comma separated longitude, latitude values (in WGS84 decimal degrees).
- point(float64, float64)
- Constructs a point geometry from a longitude and a latitude, both specified in decimal degrees in WGS84 Datum.
- polygon(T)
- Constructs a polygon from a String representation, where the polygon is a simple polygon (without any holes) and is specified as follows: 'longitude_1, latitude_1, longitude_2, latitude_2, ... , longitude_n, latitude_n', where n is the number of points. This constructor will re-orient the polygon so that it always constructs the 'smaller' polygon. The output format is a WKT geometry
- timeBoxesForPeriod(int64, int64, int32)
- Computes the discrete time period covered by the start and end.
- timeBoxesForPeriod(uint64, uint64, uint32)
- Computes the discrete time period covered by the start and end.
- toGeoJSON(T)
- Convert the given WKT formatted geometry to a GeoJSON format.
- within(T, T)
- Returns true if the first geometry is within the second.
- withinDistance(T, T, float64)
- Returns true if the first geometry and the second geometry are within the specified distance in meters.
- yardsToMeters(float32)
- Deprecated since Streams version 4.0.
- yardsToMeters(float64)
- Deprecated since Streams version 4.0.
- yardsToMeters(int32)
- Deprecated since Streams version 4.0.
- yardsToMeters(int64)
- Deprecated since Streams version 4.0.