The following tables list properties of teradataml GeoDataFrame. For more details and examples, see Teradata Package for Python Function Reference on VantageCloud Lake.
Generic Usage
from teradataml import GeoDataFrame
geodf = GeoDataFrame("sample_shapes")
geodf.name_of_the_property
Properties inherited from teradataml DataFrame
Property | Purpose | Return |
---|---|---|
columns | Get the column names of GeoDataFrame. | List containing column names |
dtypes | Return a MetaData containing the column names and types. | MetaData containing the column names and Python types |
iloc | Access a group of rows and columns by integer values or a boolean array. | teradataml GeoDataFrame |
index | Return the index_label of the teradataml GeoDataFrame. | str or List of Strings (str) representing the index_label of the GeoDataFrame |
loc | Access a group of rows and columns by labels or a boolean array. | teradataml GeoDataFrame |
shape | Return a tuple representing the dimensionality of the GeoDataFrame. | Tuple representing the dimensionality of this GeoDataFrame |
size | Return a value representing the number of elements in the GeoDataFrame. | Value representing the number of elements in the GeoDataFrame. |
tdtypes | Get the teradataml GeoDataFrame metadata containing column names and corresponding teradatasqlalchemy types. | Metadata containing the column names and Teradata types |
Properties specific to Geospatial Data (All Geometry Types)
Property | Purpose | Return |
---|---|---|
geometry | Return a GeoColumnExpression for a column containing geometry data. This property is used to run any geospatial operation on GeoDataFrame, that is, any geospatial function ran on the geometry column referenced by this property.
|
teradataml GeoDataFrameColumn |
boundary | Return the boundary of the Geometry value. | GeoDataFrame with result column containing Geometry values |
centroid | Return the mathematical centroid of an ST_Polygon or ST_MultiPolygon value. | GeoDataFrame with result column containing Geometry values |
convex_hull | Return the convex hull of the Geometry value. | GeoDataFrame with result column containing Geometry values |
coord_dim | Return the coordinate dimension of a geometry. | GeoDataFrame Resultant column contains:
|
dimension | Return the dimension of the Geometry type. | GeoDataFrame Resultant column contains:
|
geom_type | Return the Geometry type of the Geometry value. | GeoDataFrame Resultant column contains any of the following strings:
|
is_3D | Test if a Geometry value has Z coordinate value. | GeoDataFrame Resultant column contains:
|
is_empty | Test if a Geometry value corresponds to the empty set. | GeoDataFrame Resultant column contains:
|
is_simple | Test if a Geometry value has no anomalous geometric points, such as self intersection tangency. | GeoDataFrame Resultant column contains:
|
is_valid | Test if a Geometry value is well-formed. | GeoDataFrame Resultant column contains:
|
max_x | Return the maximum X coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
max_y | Return the maximum Y coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
max_z | Return the maximum Z coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
min_x | Return the minimum X coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
min_y | Return the minimum Y coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
min_z | Return the minimum Z coordinate of a Geometry value. | GeoDataFrame Resultant column contains a NULL, if the Geometry is an empty set. |
srid | Get the spatial reference system identifier of the Geometry value. | GeoDataFrame |
Properties for Point Geometry
Property | Purpose | Return |
---|---|---|
x | Get the X coordinate of an ST_Point value. | GeoDataFrame |
y | Get the Y coordinate of an ST_Point value. | GeoDataFrame |
z | Get the Z coordinate of an ST_Point value. | GeoDataFrame |
Properties for LineString Geometry
Property | Purpose | Return |
---|---|---|
is_closed_3D | Test whether a 3D LineString or 3D MultiLineString is closed, taking into account the Z coordinates in the calculation. | GeoDataFrame Resultant column contains:
|
is_closed | Test if a Geometry type that represents an ST_LineString, GeoSequence, or ST_MultiLineString value is closed. | GeoDataFrame Resultant column contains:
|
is_ring | Test if a Geometry type that represents an ST_LineString or a GeoSequence value is a ring. | GeoDataFrame 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. | GeoDataFrame |
exterior | Get the exterior ring of a Geometry type that represents an ST_Polygon value. | GeoDataFrame 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. | GeoDataFrame |