Skip to content

GARSPandas module

GARSPandas

Source code in vgridpandas/garspandas.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 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
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@pd.api.extensions.register_dataframe_accessor("gars")
class GARSPandas:
    def __init__(self, df: DataFrame):
        self._df = df

    # gars API
    # These methods simply mirror the Vgrid gars API and apply gars functions to all rows

    def latlon2gars(
        self,
        resolution: int,
        lat_col: str = "lat",
        lon_col: str = "lon",
        set_index: bool = False,
    ) -> AnyDataFrame:
        """Adds gars ID to (Geo)DataFrame.

        pd.DataFrame: uses `lat_col` and `lon_col` (default `lat` and `lon`)
        gpd.GeoDataFrame: uses `geometry`

        Assumes coordinates in epsg=4326.

        Parameters
        ----------
        resolution : int
            gars resolution
        lat_col : str
            Name of the latitude column (if used), default 'lat'
        lon_col : str
            Name of the longitude column (if used), default 'lon'
        set_index : bool
            If True, the columns with gars ID is set as index, default 'True'

        Returns
        -------
        (Geo)DataFrame with gars IDs added
        """

        if isinstance(self._df, gpd.GeoDataFrame):
            lons = self._df.geometry.x
            lats = self._df.geometry.y
        else:
            lons = self._df[lon_col]
            lats = self._df[lat_col]

        gars_ids = [
            latlon_to_gars(lat, lon, resolution) for lat, lon in zip(lats, lons)
        ]

        gars_col = GARS_COL
        assign_arg = {gars_col: gars_ids, f"{gars_col}_res": resolution}
        df = self._df.assign(**assign_arg)
        if set_index:
            return df.set_index(gars_col)
        return df

    def gars2geo(self, gars_col: str = None) -> GeoDataFrame:
        """Add geometry with GARS geometry to the DataFrame."""
        if gars_col is not None:
            if gars_col not in self._df.columns:
                raise ValueError(f"Column '{gars_col}' not found in DataFrame")
            ids = self._df[gars_col]
        else:
            if GARS_COL not in self._df.columns:
                raise ValueError(f"Column '{GARS_COL}' not found in DataFrame")
            ids = self._df[GARS_COL]
        return dggs_ids_to_geodataframe(self._df, ids, gars_to_geo)

    def linetrace(self, resolution: int, explode: bool = False) -> AnyDataFrame:
        """GARS cell representation of a (Multi)LineString traced along its vertices.

        Uses the same walk as ``vgrid.conversion.vector2dggs.vector2gars.polyline2gars``.
        """
        result = self._df.apply(
            lambda row: list(linetrace(row.geometry, resolution)), axis=1
        )
        if not explode:
            return self._df.assign(**{GARS_COL: result})
        result = result.explode().to_frame(GARS_COL)
        return self._df.join(result)

    def garsbin(
        self,
        resolution: int,
        agg: str = "count",
        numeric_col: str = None,
        category_col: str = None,
        lat_col: str = "lat",
        lon_col: str = "lon",
    ) -> GeoDataFrame:
        """
        Bin points into gars cells and compute statistics.
        """
        gars_col = GARS_COL
        df = self.latlon2gars(resolution, lat_col, lon_col)
        result = aggregate_bin(df, gars_col, agg, numeric_col, category_col)
        return result.gars.gars2geo(gars_col=gars_col)

gars2geo(gars_col=None)

Add geometry with GARS geometry to the DataFrame.

Source code in vgridpandas/garspandas.py 
81
82
83
84
85
86
87
88
89
90
91
def gars2geo(self, gars_col: str = None) -> GeoDataFrame:
    """Add geometry with GARS geometry to the DataFrame."""
    if gars_col is not None:
        if gars_col not in self._df.columns:
            raise ValueError(f"Column '{gars_col}' not found in DataFrame")
        ids = self._df[gars_col]
    else:
        if GARS_COL not in self._df.columns:
            raise ValueError(f"Column '{GARS_COL}' not found in DataFrame")
        ids = self._df[GARS_COL]
    return dggs_ids_to_geodataframe(self._df, ids, gars_to_geo)

garsbin(resolution, agg='count', numeric_col=None, category_col=None, lat_col='lat', lon_col='lon')

Bin points into gars cells and compute statistics.

Source code in vgridpandas/garspandas.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def garsbin(
    self,
    resolution: int,
    agg: str = "count",
    numeric_col: str = None,
    category_col: str = None,
    lat_col: str = "lat",
    lon_col: str = "lon",
) -> GeoDataFrame:
    """
    Bin points into gars cells and compute statistics.
    """
    gars_col = GARS_COL
    df = self.latlon2gars(resolution, lat_col, lon_col)
    result = aggregate_bin(df, gars_col, agg, numeric_col, category_col)
    return result.gars.gars2geo(gars_col=gars_col)

latlon2gars(resolution, lat_col='lat', lon_col='lon', set_index=False)

Adds gars ID to (Geo)DataFrame.

pd.DataFrame: uses lat_col and lon_col (default lat and lon) gpd.GeoDataFrame: uses geometry

Assumes coordinates in epsg=4326.

Parameters

resolution : int gars resolution lat_col : str Name of the latitude column (if used), default 'lat' lon_col : str Name of the longitude column (if used), default 'lon' set_index : bool If True, the columns with gars ID is set as index, default 'True'

Returns

(Geo)DataFrame with gars IDs added

Source code in vgridpandas/garspandas.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
79
def latlon2gars(
    self,
    resolution: int,
    lat_col: str = "lat",
    lon_col: str = "lon",
    set_index: bool = False,
) -> AnyDataFrame:
    """Adds gars ID to (Geo)DataFrame.

    pd.DataFrame: uses `lat_col` and `lon_col` (default `lat` and `lon`)
    gpd.GeoDataFrame: uses `geometry`

    Assumes coordinates in epsg=4326.

    Parameters
    ----------
    resolution : int
        gars resolution
    lat_col : str
        Name of the latitude column (if used), default 'lat'
    lon_col : str
        Name of the longitude column (if used), default 'lon'
    set_index : bool
        If True, the columns with gars ID is set as index, default 'True'

    Returns
    -------
    (Geo)DataFrame with gars IDs added
    """

    if isinstance(self._df, gpd.GeoDataFrame):
        lons = self._df.geometry.x
        lats = self._df.geometry.y
    else:
        lons = self._df[lon_col]
        lats = self._df[lat_col]

    gars_ids = [
        latlon_to_gars(lat, lon, resolution) for lat, lon in zip(lats, lons)
    ]

    gars_col = GARS_COL
    assign_arg = {gars_col: gars_ids, f"{gars_col}_res": resolution}
    df = self._df.assign(**assign_arg)
    if set_index:
        return df.set_index(gars_col)
    return df

linetrace(resolution, explode=False)

GARS cell representation of a (Multi)LineString traced along its vertices.

Uses the same walk as vgrid.conversion.vector2dggs.vector2gars.polyline2gars.

Source code in vgridpandas/garspandas.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def linetrace(self, resolution: int, explode: bool = False) -> AnyDataFrame:
    """GARS cell representation of a (Multi)LineString traced along its vertices.

    Uses the same walk as ``vgrid.conversion.vector2dggs.vector2gars.polyline2gars``.
    """
    result = self._df.apply(
        lambda row: list(linetrace(row.geometry, resolution)), axis=1
    )
    if not explode:
        return self._df.assign(**{GARS_COL: result})
    result = result.explode().to_frame(GARS_COL)
    return self._df.join(result)

linetrace(geometry, resolution)

Trace a (Multi)LineString with GARS cells (same walk as polyline2gars).

Source code in vgridpandas/garspandas.py 
18
19
20
21
22
def linetrace(geometry: MultiLineOrLine, resolution: int) -> Iterator[str]:
    """Trace a (Multi)LineString with GARS cells (same walk as ``polyline2gars``)."""
    rows = polyline2gars(geometry, resolution, include_properties=False)
    for row in rows:
        yield row[GARS_COL]