Skip to content

MGRSPandas module

MGRSPandas

Source code in vgridpandas/mgrspandas.py 
15
16
17
18
19
20
21
22
23
24
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
@pd.api.extensions.register_dataframe_accessor("mgrs")
class MGRSPandas:
    def __init__(self, df: DataFrame):
        self._df = df

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

    def latlon2mgrs(
        self,
        resolution: int,
        lat_col: str = "lat",
        lon_col: str = "lon",
        set_index: bool = False,
    ) -> AnyDataFrame:
        """Adds MGRS 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
            MGRS 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 mgrs ID is set as index, default 'True'

        Returns
        -------
        (Geo)DataFrame with mgrs 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]

        mgrs_ids = [
            latlon_to_mgrs(lat, lon, resolution) for lat, lon in zip(lats, lons)
        ]

        # mgrs_col = self._format_resolution(resolution)
        mgrs_col = MGRS_COL
        assign_arg = {mgrs_col: mgrs_ids, f"{mgrs_col}_res": resolution}
        df = self._df.assign(**assign_arg)
        if set_index:
            return df.set_index(mgrs_col)
        return df

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

    def mgrsbin(
        self,
        resolution: int,
        stats: str = "count",
        numeric_col: str = None,
        category_col: str = None,
        lat_col: str = "lat",
        lon_col: str = "lon",
    ) -> GeoDataFrame:
        """
        Bin points into mgrs cells and compute statistics.
        """
        mgrs_col = MGRS_COL
        df = self.latlon2mgrs(resolution, lat_col, lon_col)
        result = aggregate_bin(df, mgrs_col, stats, numeric_col, category_col)
        return result.mgrs.mgrs2geo(mgrs_col=mgrs_col)

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

Adds MGRS 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 MGRS 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 mgrs ID is set as index, default 'True'

Returns

(Geo)DataFrame with mgrs IDs added

Source code in vgridpandas/mgrspandas.py 
23
24
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
def latlon2mgrs(
    self,
    resolution: int,
    lat_col: str = "lat",
    lon_col: str = "lon",
    set_index: bool = False,
) -> AnyDataFrame:
    """Adds MGRS 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
        MGRS 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 mgrs ID is set as index, default 'True'

    Returns
    -------
    (Geo)DataFrame with mgrs 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]

    mgrs_ids = [
        latlon_to_mgrs(lat, lon, resolution) for lat, lon in zip(lats, lons)
    ]

    # mgrs_col = self._format_resolution(resolution)
    mgrs_col = MGRS_COL
    assign_arg = {mgrs_col: mgrs_ids, f"{mgrs_col}_res": resolution}
    df = self._df.assign(**assign_arg)
    if set_index:
        return df.set_index(mgrs_col)
    return df

mgrs2geo(mgrs_col=None)

Add geometry with MGRS geometry to the DataFrame.

Source code in vgridpandas/mgrspandas.py 
72
73
74
75
76
77
78
79
80
81
82
def mgrs2geo(self, mgrs_col: str = None) -> GeoDataFrame:
    """Add geometry with MGRS geometry to the DataFrame."""
    if mgrs_col is not None:
        if mgrs_col not in self._df.columns:
            raise ValueError(f"Column '{mgrs_col}' not found in DataFrame")
        ids = self._df[mgrs_col]
    else:
        if MGRS_COL not in self._df.columns:
            raise ValueError(f"Column '{MGRS_COL}' not found in DataFrame")
        ids = self._df[MGRS_COL]
    return dggs_ids_to_geodataframe(self._df, ids, mgrs_to_geo)

mgrsbin(resolution, stats='count', numeric_col=None, category_col=None, lat_col='lat', lon_col='lon')

Bin points into mgrs cells and compute statistics.

Source code in vgridpandas/mgrspandas.py 
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def mgrsbin(
    self,
    resolution: int,
    stats: str = "count",
    numeric_col: str = None,
    category_col: str = None,
    lat_col: str = "lat",
    lon_col: str = "lon",
) -> GeoDataFrame:
    """
    Bin points into mgrs cells and compute statistics.
    """
    mgrs_col = MGRS_COL
    df = self.latlon2mgrs(resolution, lat_col, lon_col)
    result = aggregate_bin(df, mgrs_col, stats, numeric_col, category_col)
    return result.mgrs.mgrs2geo(mgrs_col=mgrs_col)