teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.interiors = interiors(self, position)

DESCRIPTION:
    Returns the specified interior ring of a Geometry type that represents
    an ST_Polygon value.
 
PARAMETERS:
    position:
        Required Argument.
        Specifies a value for the requested interior ring, where the
        position of the first interior ring is 1.
        Types: int, str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    ST_Polygon
    Note:
        This method can be called on 3D geometries (those that include Z
        coordinates). However, the Z coordinate is ignored in method
        calculations. Consequently, any Z coordinates returned by this
        method should be ignored. Teradata recommends using the make_2D()
        method to strip out the Z coordinates of the return value.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn containing ST_LineString Geometry values
 
EXAMPLES:
    from teradataml import GeoDataFrame, load_example_data
    from teradataml import Point, LineString, Polygon, GeometryCollection
    # Load example data.
    load_example_data("geodataframe", "sample_shapes")
    # Create a GeoDataFrame.
    geodf = GeoDataFrame("sample_shapes")
    print(geodf)
 
    # Example 1: Get the interior ring specified at 1st index for polygons.
    # Filter the data to select few rows and couple of columns (skey and polygons).
    polygons = geodf.select(["skey", "polygons"])[geodf.skey.isin([1002, 1004])]
    geo_interiors = polygons.geometry.interiors(position=1)
    polygons.assign(res = geo_interiors)
 
    # Example 2: Filter the rows where the interior ring specified at 1st index for polygons
    #            is same as the specified LineString GeometryType object.
    # Create an object of LineString GeometryType.
    l1 = LineString([(5, 5), (5, 10), (10, 10), (10, 5), (5, 5)])
    # Execute the interiors() function on 'polygons' column.
    geo_interiors = polygons.geometry.interiors(position=1)
    polygons[geo_interiors == l1]