Skip to content

cluster_orientation

Compute the orientation angle of a GeoDataFrame.

Parameters:

Name Type Description Default
gdf GeoDataFrame

The GeoDataFrame containing the cluster data.

 required
hull_type str

The type of hull to compute. One of: "alpha_shape", "convex_hull", "ellipse".

 'alpha_shape'
normalize bool

Whether to normalize the angle to be within [0, 90].

 True
**kwargs

Additional keyword arguments for the hull computation (e.g., step for alpha shape).

 {}

Raises:

Type Description
ValueError

If an invalid hull type is provided.

Returns:

Name Type Description
float float

The orientation angle of the cluster, in degrees.
Source code in src/histolytics/spatial_clust/clust_metrics.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def cluster_orientation(
    gdf: gpd.GeoDataFrame,
    hull_type: str = "alpha_shape",
    normalize: bool = True,
    **kwargs,
) -> float:
    """Compute the orientation angle of a GeoDataFrame.

    Parameters:
        gdf (gpd.GeoDataFrame):
            The GeoDataFrame containing the cluster data.
        hull_type (str):
            The type of hull to compute. One of: "alpha_shape", "convex_hull", "ellipse".
        normalize (bool):
            Whether to normalize the angle to be within [0, 90].
        **kwargs:
            Additional keyword arguments for the hull computation
            (e.g., `step` for alpha shape).

    Raises:
        ValueError: If an invalid hull type is provided.

    Returns:
        float: The orientation angle of the cluster, in degrees.
    """
    xy = get_centroid_numpy(gdf)
    hull_poly = hull(xy, hull_type=hull_type, **kwargs)

    return axis_angle(hull_poly, normalize=normalize)