Interface TPoint
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
TGeogPoint,TGeomPoint
- All Known Implementing Classes:
TGeogPointInst,TGeogPointSeq,TGeogPointSeqSet,TGeomPointInst,TGeomPointSeq,TGeomPointSeqSet,TPointInst,TPointSeq,TPointSeqSet
- Author:
- ARIJIT SAMAL
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Map<AbstractMap.SimpleEntry<Integer, Integer>, jnr.ffi.Pointer> Returns a new :class:`TPoint` of the same subclass of ``self`` transformed to another SRID Args: srid: The desired SRID Returns: A new :class:`TPoint` instance MEOS Functions: tpoint_transform -
Method Summary
Modifier and TypeMethodDescriptiondefault TFloatSeqSetReturns the angular_difference of the temporal point.default Stringas_ewkt(int decimals) Returns the temporal point as an EWKT string.default Stringas_geojson(int option, int precision, String srs) Returns the trajectory of the temporal point as a GeoJSON string.default Stringas_wkt(int decimals) Returns the temporal point as a WKT string.default TPointReturns a new temporal object with the values of "this" restricted to "other".default TFloatSeqSetazimuth()Returns the temporal azimuth of the temporal point.default TFloatReturns the temporal bearing between the temporal point and "other".default STBoxReturns the bounding box of the "this".private jnr.ffi.PointercreateEmptyPointerArray(jnr.ffi.Runtime runtime, int length) Splits `self` into fragments with respect to space buckets Args: xsize: Size of the x dimension.default TFloatReturns the cumulative length of the trajectory.default TFloatSeqSetReturns the azimuth of the temporal point between the start and end locations.default TBoolReturns a new temporal boolean indicating whether the temporal point intersects "other".default TFloatReturns the temporal distance between the temporal point and "other".default org.locationtech.jts.geom.Pointend_value(int precision) Returns the end value of the temporal point.default booleanever_intersects(Object other) Returns whether the temporal point ever intersects "other".default booleanever_touches(Object other) Returns whether the temporal point ever touches "other".default STBoxexpand(float other) Expands "this" with "other".jnr.ffi.Pointerdefault booleanhas_z()Returns whether the temporal point has a z coordinate.default TBoolintersects(Object other) Returns a new temporal boolean indicating whether the temporal point intersects "other".default booleanis_above(TemporalObject other) Returns whether the bounding box of "this" is above to the bounding box of "other".default booleanis_behind(TemporalObject other) Returns whether the bounding box of "this" is behind to the bounding box of "other".default booleanis_below(TemporalObject other) Returns whether the bounding box of "this" is below to the bounding box of "other".default booleanis_ever_contained_in(Object other) Returns whether the temporal point is ever contained by "other".default booleanis_ever_disjoint(Object other) Returns whether the temporal point is ever disjoint from "other".default booleanis_ever_within_distance(Object other, float distance) Returns whether the temporal point is ever within "distance" of "other".default booleanis_front(TemporalObject other) Returns whether the bounding box of "this" is front to the bounding box of "other".default booleanis_left(TemporalObject other) Returns whether the bounding box of "this" is left to the bounding box of "other".default booleanis_over_or_above(TemporalObject other) Returns whether the bounding box of "this" is over or above to the bounding box of "other".default booleanis_over_or_behind(TemporalObject other) Returns whether the bounding box of "this" is over or behind to the bounding box of "other".default booleanis_over_or_below(TemporalObject other) Returns whether the bounding box of "this" is over or below to the bounding box of "other".default booleanis_over_or_front(TemporalObject other) Returns whether the bounding box of "this" is over or front to the bounding box of "other".default booleanis_over_or_left(TemporalObject other) Returns whether the bounding box of "this" is over or left to the bounding box of "other".default booleanis_over_or_right(TemporalObject other) Returns whether the bounding box of "this" is over or right to the bounding box of "other".default booleanis_right(TemporalObject other) Returns whether the bounding box of "this" is right to the bounding box of "other".default booleanReturns whether the temporal point is simple.default TBoolis_spatially_contained_in(Object other) Returns a new temporal boolean indicating whether the temporal point is contained by "other".default floatlength()Returns the length of the trajectory.Split the temporal point into a collection of simple temporal points.default TPointReturns a new temporal object with the values of "this" restricted to the complement of "other".default floatnearest_approach_distance(Object other) Returns the nearest approach distance between the temporal point and "other".default TInstantnearest_approach_instant(Object other) Returns the nearest approach instant between the temporal point and "other".default TPointround(int max_decimals) Round the coordinate values to a number of decimal places.default TPointset_srid(int srid) Returns a new TPoint with the given SRID.default org.locationtech.jts.geom.Geometryshortest_line(Object other) Returns the shortest line between the temporal point and `other`.space_split(Float xsize, Float ysize, Float zsize, org.locationtech.jts.geom.Geometry origin, boolean bitmatrix, boolean include_border) space_time_split(Float xsize, Object duration, Float ysize, Float zsize, org.locationtech.jts.geom.Geometry origin, Object time_start, boolean bitmatrix, boolean include_border) Splits `self` into fragments with respect to space and tstzspan buckets.default TFloatspeed()Returns the speed of the temporal point.default intsrid()Returns the SRID.default org.locationtech.jts.geom.Pointstart_value(int precision) Returns the start value of the temporal point.stboxes()Returns a collection of :class:`STBox`es representing the bounding boxes of the segments of the temporal point.default org.locationtech.jts.geom.Pointtime_weighted_centroid(int precision) Returns the time weighted centroid of the temporal point.default org.locationtech.jts.geom.Geometryto_shapely_geometry(int precision) Returns the trajectory of the temporal point as a Shapely geometry.default StringReturns the string representation of the temporal point.default TBoolReturns a new temporal boolean indicating whether the temporal point touches "other".default TPointtransform(int srid) default org.locationtech.jts.geom.Pointvalue_at_timestamp(LocalDateTime ts, int precision) Returns the value of the temporal point at the given timestamp.values(int precision) Returns the values of the temporal point.default TBoolwithin_distance(Object other, float distance) Returns a new temporal boolean indicating whether the temporal point is within "distance" of "other".default TFloatx()Returns the x coordinate of the temporal point.default TFloaty()Returns the y coordinate of the temporal point.default TFloatz()Returns the z coordinate of the temporal point.
-
Field Details
-
projectionCache
Returns a new :class:`TPoint` of the same subclass of ``self`` transformed to another SRID Args: srid: The desired SRID Returns: A new :class:`TPoint` instance MEOS Functions: tpoint_transform
-
-
Method Details
-
getPointInner
jnr.ffi.Pointer getPointInner() -
getCustomType
String getCustomType() -
getTemporalType
TemporalType getTemporalType() -
to_string
Returns the string representation of the temporal point.MEOS Functions:
- tpoint_out
- Returns:
- A new
Stringrepresenting the temporal point.
-
as_wkt
Returns the temporal point as a WKT string.MEOS Functions:
- tpoint_out
- Parameters:
decimals- The precision of the returned geometry.- Returns:
- A new
Stringrepresenting the temporal point.
-
as_ewkt
Returns the temporal point as an EWKT string.MEOS Functions:
- tpoint_as_ewkt
- Parameters:
decimals- The precision of the returned geometry.- Returns:
- A new
Stringrepresenting the temporal point.
-
as_geojson
Returns the trajectory of the temporal point as a GeoJSON string.MEOS Functions:
- gserialized_as_geojson
- Parameters:
option- The option to use when serializing the trajectory.precision- The precision of the returned geometry.srs- The spatial reference system of the returned geometry.- Returns:
- A new GeoJSON string representing the trajectory of the temporal point.
-
to_shapely_geometry
default org.locationtech.jts.geom.Geometry to_shapely_geometry(int precision) throws org.locationtech.jts.io.ParseException Returns the trajectory of the temporal point as a Shapely geometry.MEOS Functions:
- gserialized_to_shapely_geometry
- Parameters:
precision- The precision of the returned geometry.- Returns:
- A new
Geometryrepresenting the * trajectory. - Throws:
org.locationtech.jts.io.ParseException
-
bounding_box_point
Returns the bounding box of the "this".MEOS Functions:
- tpoint_to_stbox
- Returns:
- An
STBoxrepresenting the bounding box.
-
values
Returns the values of the temporal point. Returns: A :class:`list` of :class:`~shapely.geometry.Point` with the values. MEOS Functions: temporal_instants -
start_value
default org.locationtech.jts.geom.Point start_value(int precision) throws org.locationtech.jts.io.ParseException Returns the start value of the temporal point.MEOS Functions:
- tpoint_start_value
- Parameters:
precision- The precision of the returned point.- Returns:
- A
Pointwith the start value. - Throws:
org.locationtech.jts.io.ParseException
-
end_value
default org.locationtech.jts.geom.Point end_value(int precision) throws org.locationtech.jts.io.ParseException Returns the end value of the temporal point.MEOS Functions:
- tpoint_end_value
- Parameters:
precision- The precision of the returned point.- Returns:
- A
Pointwith the end value. - Throws:
org.locationtech.jts.io.ParseException
-
value_at_timestamp
default org.locationtech.jts.geom.Point value_at_timestamp(LocalDateTime ts, int precision) throws org.locationtech.jts.io.ParseException Returns the value of the temporal point at the given timestamp. Args: timestamp: A :class:`datetime` representing the timestamp. precision: An :class:`int` representing the precision of the coordinates. Returns: A :class:`~shapely.geometry.Point` with the value. MEOS Functions: tpoint_value_at_timestamp- Throws:
org.locationtech.jts.io.ParseException
-
length
default float length()Returns the length of the trajectory.MEOS Functions:
- tpoint_length
- Returns:
- A
Floatwith the length of the trajectory.
-
cumulative_length
Returns the cumulative length of the trajectory.MEOS Functions:
- tpoint_cumulative_length
- Returns:
- A
TFloatwith the cumulative length of the trajectory.
-
speed
Returns the speed of the temporal point.MEOS Functions:
- tpoint_speed
- Returns:
- A
TFloatwith the speed of the temporal point.
-
x
Returns the x coordinate of the temporal point.MEOS Functions:
- tpoint_get_x
- Returns:
- A
TFloatwith the x coordinate of the temporal point.
-
y
Returns the y coordinate of the temporal point.MEOS Functions:
- tpoint_get_y
- Returns:
- A
TFloatwith the y coordinate of the temporal point.
-
z
Returns the z coordinate of the temporal point.MEOS Functions:
- tpoint_get_z
- Returns:
- A
TFloatwith the z coordinate of the temporal point.
-
has_z
default boolean has_z()Returns whether the temporal point has a z coordinate.MEOS Functions:
- tpoint_start_value
- Returns:
- A
Booleanindicating whether the temporal point has a z coordinate.
-
stboxes
Returns a collection of :class:`STBox`es representing the bounding boxes of the segments of the temporal point. Returns: A :class:`list` of :class:`STBox`es. MEOS Functions: tpoint_stboxes -
is_simple
default boolean is_simple()Returns whether the temporal point is simple. That is, whether it does not self-intersect.MEOS Functions:
- tpoint_is_simple
- Returns:
- A
Booleanindicating whether the temporal point is simple.
-
bearing
Returns the temporal bearing between the temporal point and "other".MEOS Functions:
- bearing_tpoint_point
- bearing_tpoint_tpoint
- Parameters:
other- An object to check the bearing to.- Returns:
- A new
TFloatindicating the temporal bearing between the temporal point and "other".
-
direction
Returns the azimuth of the temporal point between the start and end locations.MEOS Functions:
- tpoint_direction
- Returns:
- A new
TFloatSeqSetindicating the direction of the temporal point.
-
azimuth
Returns the temporal azimuth of the temporal point.MEOS Functions:
- tpoint_azimuth
- Returns:
- A new
TFloatSeqSetindicating the temporal azimuth of the temporal point.
-
angular_difference
Returns the angular_difference of the temporal point.MEOS Functions:
- tpoint_angular_difference
- Returns:
- A new
TFloatSeqSetindicating the temporal angular_difference of the temporal point.
-
time_weighted_centroid
default org.locationtech.jts.geom.Point time_weighted_centroid(int precision) throws org.locationtech.jts.io.ParseException Returns the time weighted centroid of the temporal point.MEOS Functions:
- tpoint_twcentroid
- Parameters:
precision- The precision of the returned geometry.- Returns:
- A new
Geometryindicating the time weighted centroid of the temporal point. - Throws:
org.locationtech.jts.io.ParseException
-
srid
default int srid()Returns the SRID.MEOS Functions:
- tpoint_srid
- Returns:
- An
Integerrepresenting the SRID.
-
set_srid
Returns a new TPoint with the given SRID.MEOS Functions:
- tpoint_set_srid
- Parameters:
srid- int value- Returns:
- Returns a new TPoint with the given SRID.
-
round
Round the coordinate values to a number of decimal places.MEOS Functions:
- tpoint_round
- Parameters:
max_decimals- number of decimals- Returns:
- A new
TPointobject.
-
make_simple
Split the temporal point into a collection of simple temporal points. Returns: A :class:`list` of :class:`TPoint`es. MEOS Functions: tpoint_make_simple -
expand
Expands "this" with "other". The result is equal to "this" but with the spatial dimensions expanded by "other" in all directions.MEOS Functions:
- tpoint_expand_space
- Parameters:
other- The object to expand "this" with.- Returns:
- A new
STBoxinstance.
-
transform
-
at
Returns a new temporal object with the values of "this" restricted to "other".MEOS Functions:
- tpoint_at_value
- tpoint_at_stbox
- temporal_at_values
- temporal_at_timestamp
- temporal_at_timestampset
- temporal_at_tstzset
- temporal_at_tstzsetset
- Parameters:
other- An object to restrict the values of "this" to.- Returns:
- A new
TPointwith the values of "this" restricted to "other". - Throws:
OperationNotSupportedException
-
minus
Returns a new temporal object with the values of "this" restricted to the complement of "other".MEOS Functions:
- tpoint_minus_value
- tpoint_minus_stbox
- temporal_minus_values
- temporal_minus_timestamp
- temporal_minus_timestampset
- temporal_minus_tstzset
- temporal_minus_tstzsetset
- Parameters:
other- An object to restrict the values of "this" to the complement of.- Returns:
- A
TPointwith the values of "this" restricted to the complement of "other". - Throws:
OperationNotSupportedException
-
is_left
Returns whether the bounding box of "this" is left to the bounding box of "other".See Also:
tstzset.is_before(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if left, False otherwise.
-
is_over_or_left
Returns whether the bounding box of "this" is over or left to the bounding box of "other".- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or left, False otherwise.
-
is_right
Returns whether the bounding box of "this" is right to the bounding box of "other".See Also:
tstzset.is_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if right, False otherwise.
-
is_over_or_right
Returns whether the bounding box of "this" is over or right to the bounding box of "other".See Also:
tstzset.is_over_or_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or right, False otherwise.
-
is_below
Returns whether the bounding box of "this" is below to the bounding box of "other".See Also:
tstzset.is_before(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if below, False otherwise.
-
is_over_or_below
Returns whether the bounding box of "this" is over or below to the bounding box of "other".- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or below, False otherwise.
-
is_above
Returns whether the bounding box of "this" is above to the bounding box of "other".See Also:
tstzset.is_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if above, False otherwise.
-
is_over_or_above
Returns whether the bounding box of "this" is over or above to the bounding box of "other".See Also:
tstzset.is_over_or_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or above, False otherwise.
-
is_front
Returns whether the bounding box of "this" is front to the bounding box of "other".See Also:
tstzset.is_before(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if front, False otherwise.
-
is_over_or_front
Returns whether the bounding box of "this" is over or front to the bounding box of "other".- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or front, False otherwise.
-
is_behind
Returns whether the bounding box of "this" is behind to the bounding box of "other".See Also:
tstzset.is_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if behind, False otherwise.
-
is_over_or_behind
Returns whether the bounding box of "this" is over or behind to the bounding box of "other".See Also:
tstzset.is_over_or_after(TemporalObject)- Parameters:
other- A box or a temporal object to compare to "this".- Returns:
- True if over or behind, False otherwise.
-
is_ever_contained_in
Returns whether the temporal point is ever contained by "other".MEOS Functions:
- econtains_geo_tpoint
- Parameters:
other- An object to check for containing "this".- Returns:
- A
Booleanindicating whether the temporal point is ever contained by "other". - Throws:
OperationNotSupportedException
-
is_ever_disjoint
Returns whether the temporal point is ever disjoint from "other".MEOS Functions:
- edisjoint_tpoint_geo
- edisjoint_tpoint_tpoint
- Parameters:
other- An object to check for disjointness with.- Returns:
- A
Booleanindicating whether the temporal point is ever disjoint from "other". - Throws:
OperationNotSupportedException
-
is_ever_within_distance
default boolean is_ever_within_distance(Object other, float distance) throws OperationNotSupportedException Returns whether the temporal point is ever within "distance" of "other".MEOS Functions:
- edwithin_tpoint_geo
- edwithin_tpoint_tpoint
- Parameters:
other- An object to check the distance to.distance- The distance to check in units of the spatial reference system.- Returns:
- A
Booleanindicating whether the temporal point is ever within "distance" of "other". - Throws:
OperationNotSupportedException
-
ever_intersects
Returns whether the temporal point ever intersects "other".MEOS Functions:
- eintersects_tpoint_geo
- eintersects_tpoint_tpoint
- Parameters:
other- An object to check for intersection with.- Returns:
- A
Booleanindicating whether the temporal point ever intersects "other". - Throws:
OperationNotSupportedException
-
ever_touches
Returns whether the temporal point ever touches "other".MEOS Functions:
- etouches_tpoint_geo
- Parameters:
other- An object to check for touching with.- Returns:
- A
Booleanindicating whether the temporal point ever touches "other". - Throws:
OperationNotSupportedException
-
is_spatially_contained_in
Returns a new temporal boolean indicating whether the temporal point is contained by "other".MEOS Functions:
- tcontains_geo_tpoint
- Parameters:
other- An object to check for containing "this".- Returns:
- A
TBoolindicating whether the temporal point is contained by "other". - Throws:
OperationNotSupportedException
-
disjoint
Returns a new temporal boolean indicating whether the temporal point intersects "other".MEOS Functions:
- tdisjoint_tpoint_geo
- Parameters:
other- An object to check for intersection with.- Returns:
- A
TBoolindicating whether the temporal point intersects "other". - Throws:
OperationNotSupportedException
-
within_distance
Returns a new temporal boolean indicating whether the temporal point is within "distance" of "other".MEOS Functions:
- tdwithin_tpoint_geo
- tdwithin_tpoint_tpoint
- Parameters:
other- An object to check the distance to.distance- The distance to check in units of the spatial reference system.- Returns:
- A
TBoolindicating whether the temporal point is within "distance" of "other". - Throws:
OperationNotSupportedException
-
intersects
Returns a new temporal boolean indicating whether the temporal point intersects "other".MEOS Functions:
- tintersects_tpoint_geo
- Parameters:
other- An object to check for intersection with.- Returns:
- A
TBoolindicating whether the temporal point intersects "other". - Throws:
OperationNotSupportedException
-
touches
Returns a new temporal boolean indicating whether the temporal point touches "other".MEOS Functions:
- ttouches_tpoint_geo
- Parameters:
other- An object to check for touching with.- Returns:
- A
TBoolindicating whether the temporal point touches "other". - Throws:
OperationNotSupportedException
-
distance
Returns the temporal distance between the temporal point and "other".MEOS Functions:
- distance_tpoint_point
- distance_tpoint_tpoint
- Parameters:
other- An object to check the distance to.- Returns:
- A new
TFloatindicating the temporal distance between the temporal point and "other". - Throws:
OperationNotSupportedException
-
nearest_approach_distance
Returns the nearest approach distance between the temporal point and "other".MEOS Functions:
- nad_tpoint_geo
- nad_tpoint_stbox
- nad_tpoint_tpoint
- Parameters:
other- An object to check the nearest approach distance to.- Returns:
- A
Floatindicating the nearest approach distance between the temporal point and "other". - Throws:
OperationNotSupportedException
-
nearest_approach_instant
Returns the nearest approach instant between the temporal point and "other".MEOS Functions:
- nai_tpoint_geo
- nai_tpoint_tpoint
- Parameters:
other- An object to check the nearest approach instant to.- Returns:
- A new temporal instant indicating the nearest approach instant between the temporal point and "other".
- Throws:
OperationNotSupportedException
-
shortest_line
default org.locationtech.jts.geom.Geometry shortest_line(Object other) throws OperationNotSupportedException, org.locationtech.jts.io.ParseException Returns the shortest line between the temporal point and `other`. Args: other: An object to check the shortest line to. Returns: A new :class:`~shapely.geometry.base.BaseGeometry` indicating the shortest line between the temporal point and `other`. MEOS Functions: shortestline_tpoint_geo, shortestline_tpoint_tpoint- Throws:
OperationNotSupportedExceptionorg.locationtech.jts.io.ParseException
-
createEmptyPointerArray
private jnr.ffi.Pointer createEmptyPointerArray(jnr.ffi.Runtime runtime, int length) Splits `self` into fragments with respect to space buckets Args: xsize: Size of the x dimension. ysize: Size of the y dimension. zsize: Size of the z dimension. origin: The origin of the spatial tiling. If not provided, the origin will be (0, 0, 0). bitmatrix: If True, use a bitmatrix to speed up the process. include_border: If True, include the upper border in the box. Returns: A list of temporal points. MEOS Functions: tpoint_value_split -
space_split
-
space_time_split
default List<Temporal> space_time_split(Float xsize, Object duration, Float ysize, Float zsize, org.locationtech.jts.geom.Geometry origin, Object time_start, boolean bitmatrix, boolean include_border) Splits `self` into fragments with respect to space and tstzspan buckets. Args: xsize: Size of the x dimension. ysize: Size of the y dimension. zsize: Size of the z dimension. duration: Duration of the tstzspan buckets. origin: The origin of the spatial tiling. If not provided, the origin will be (0, 0, 0). time_start: Start time of the first tstzspan bucket. If None, the start time used by default is Monday, January 3, 2000. bitmatrix: If True, use a bitmatrix to speed up the process. include_border: If True, include the upper border in the box. Returns: A list of temporal floats. MEOS Functions: tfloat_value_time_split
-