The following tables list properties of teradataml GeoDataFrameColumn. For more details and examples, see Teradata Package for Python Function Reference.
Properties inherited from teradataml DataFrameColumn
| Property | Purpose | Return |
|---|---|---|
| name | Get the name of the GeoDataFrameColumn. | string |
| type | Get the Teradata type of the GeoDataFrameColumn. | teradatasqlalchemy type |
Properties specific to Geospatial Data (All Geometry Types)
| Property | Purpose | Return |
|---|---|---|
| boundary | Return the boundary of the Geometry value. | GeoDataFrameColumn with result column containing Geometry values |
| centroid | Return the mathematical centroid of an ST_Polygon or ST_MultiPolygon value. | GeoDataFrameColumn with result column containing Geometry values |
| convex_hull | Return the convex hull of the Geometry value. | GeoDataFrameColumn with result column containing Geometry values |
| coord_dim | Return the coordinate dimension of a geometry. | GeoDataFrameColumn Resultant column contains:
|
| dimension | Return the dimension of the Geometry type. | GeoDataFrameColumn Resultant column contains:
|
| geom_type | Return the Geometry type of the Geometry value. | GeoDataFrameColumn Resultant column contains any of the following strings:
|
| is_3D | Test if a Geometry value has Z coordinate value. | GeoDataFrameColumn Resultant column contains:
|
| is_empty | Test if a Geometry value corresponds to the empty set. | GeoDataFrameColumn Resultant column contains:
|
| is_simple | Test if a Geometry value has no anomalous geometric points, such as self intersection tangency. | GeoDataFrameColumn Resultant column contains:
|
| is_valid | Test if a Geometry value is well-formed. | GeoDataFrameColumn Resultant column contains:
|
| max_x | Return the maximum X coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| max_y | Return the maximum Y coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| max_z | Return the maximum Z coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| min_x | Return the minimum X coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| min_y | Return the minimum Y coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| min_z | Return the minimum Z coordinate of a Geometry value. | GeoDataFrameColumn Resultant column contains a NULL, if the Geometry is an empty set. |
| srid | Get the spatial reference system identifier of the Geometry value. | GeoDataFrameColumn |
Properties for Point Geometry
| Property | Purpose | Return |
|---|---|---|
| x | Get the X coordinate of an ST_Point value. | GeoDataFrameColumn |
| y | Get the Y coordinate of an ST_Point value. | GeoDataFrameColumn |
| z | Get the Z coordinate of an ST_Point value. | GeoDataFrameColumn |
Properties for LineString Geometry
| Property | Purpose | Return |
|---|---|---|
| is_closed_3D | Tests whether a 3D LineString or 3D MultiLineString is closed, taking into account the Z coordinates in the calculation. | GeoDataFrameColumn Resultant column contains:
|
| is_closed | Tests if a Geometry type that represents an ST_LineString, GeoSequence, or ST_MultiLineString value is closed. | GeoDataFrameColumn Resultant column contains:
|
| is_ring | Tests if a Geometry type that represents an ST_LineString or a GeoSequence value is a ring. | GeoDataFrameColumn Resultant column contains:
|
Properties for Polygon Geometry
| Property | Purpose | Return |
|---|---|---|
| area | Return the area measurement of an ST_Polygon or ST_MultiPolygon. For ST_MultiPolygon, returns the sum of the area measurements of the component polygons. | GeoDataFrameColumn |
| exterior | Get the exterior ring of a Geometry type that represents an ST_Polygon value. | GeoDataFrameColumn with result column containing ST_LineString Geometry values |
| perimeter | Return the boundary length of an ST_Polygon, or the sum of the boundary lengths of the component polygons of an ST_MultiPolygon. | GeoDataFrameColumn |