sibi-dst 2025.1.12__py3-none-any.whl → 2025.1.13__py3-none-any.whl

sibi_dst/osmnx_helper/__init__.py

@@ -2,5 +2,6 @@ from .base_osm_map import BaseOsmMap
 from .utils import PBFHandler
 __all__ = [
     "BaseOsmMap",
+    #"MapConfig",
     "PBFHandler",
 ]

sibi_dst/osmnx_helper/basemaps/route_map_plotter.py

@@ -0,0 +1,203 @@
+import folium
+import math
+import networkx as nx
+import pandas as pd
+from datetime import datetime
+from folium.plugins import AntPath, PolyLineTextPath
+from geopy.distance import geodesic
+from pydantic import BaseModel, Field
+from typing import Optional, Dict, List, Tuple
+
+def get_default_action_colors() -> Dict[str, str]:
+    """Provides a default dictionary for action colors."""
+    return {
+        "Reporte Posición": "blue", "Acceso o Salida": "lightblue",
+        "Producto para Reintentar": "orange", "Formalización iniciada": "purple",
+        "Producto Formalizado": "green", "Esfuerzo Registrado": "darkblue",
+        "Abandona Formalización": "lightred", "Producto Rechazado": "red",
+        "Producto Devuelto": "darkred",
+    }
+
+class RouteMapPlotterSettings(BaseModel):
+    """Manages all configuration settings for the RouteMapPlotter."""
+    use_antpath: bool = Field(True, description="If True, use animated AntPath; otherwise, use a static PolyLine.")
+    zoom_start: int = Field(14, description="Initial zoom level for the map.")
+    forward_color: str = Field("blue", description="Color for the outbound portion of the route.")
+    return_color: str = Field("red", description="Color for the return portion of the route.")
+    return_offset_m: float = Field(2.5, description="Meters to offset the return path for visibility.")
+    antpath_delay: int = Field(800, description="Delay in ms for the AntPath animation.")
+    antpath_weight: int = Field(5, description="Weight of the AntPath line.")
+    antpath_dash_array: List[int] = Field(default=[10, 20], description="Dash pattern for the AntPath.")
+    antpath_pulse_color: str = Field("white", description="Pulse color for the AntPath animation.")
+    marker_origin_color: str = Field("green", description="Color for the start marker.")
+    marker_end_color: str = Field("red", description="Color for the finish marker.")
+    furthest_marker_color: str = Field("orange", description="Color for the furthest point marker.")
+    arrow_color: str = Field("black", description="Color for direction arrows on static PolyLines.")
+    marker_radius: int = Field(6, description="Radius of the event circle markers.")
+    default_tile: str = Field("OpenStreetMap", description="The default map tile layer to display.")
+    arrow_spacing: int = Field(75, description="Spacing in pixels between arrows on static PolyLines.")
+    action_colors: Dict[str, str] = Field(default_factory=get_default_action_colors)
+    date_field: str = Field("date_time", description="Name of the date/time field in the DataFrame.")
+    lat_col: str = Field("latitude", description="Name of the latitude field in the DataFrame.")
+    lon_col: str = Field("longitude", description="Name of the longitude field in the DataFrame.")
+
+class RouteDataPoint(BaseModel):
+    """Defines the data schema for a single row in the input DataFrame."""
+    latitude: float
+    longitude: float
+    date_time: datetime
+    origin_node: int
+    dest_node: int
+    path_nodes: List[int]
+    action: Optional[str] = None
+
+class RouteMapPlotter:
+    def __init__(
+        self,
+        graph: nx.Graph,
+        settings: Optional[RouteMapPlotterSettings] = None,
+    ):
+        if not isinstance(graph, nx.Graph) or not graph.nodes:
+            raise ValueError("A valid NetworkX graph with nodes is required.")
+        self.graph = graph
+        self.settings = settings or RouteMapPlotterSettings()
+        self.tile_layers = {
+            "OpenStreetMap": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
+            #"CartoDB Positron": "https://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}{r}.png",
+            #"CartoDB Dark Matter": "https://{s}.basemaps.cartocdn.com/dark_all/{z}/{x}/{y}{r}.png",
+        }
+
+    def _compute_distance_time_metrics(self, df: pd.DataFrame) -> pd.DataFrame:
+        df = df.copy().sort_values(self.settings.date_field).reset_index(drop=True)
+        df[self.settings.date_field] = pd.to_datetime(df[self.settings.date_field])
+        df["prev_lat"] = df[self.settings.lat_col].shift(1)
+        df["prev_lon"] = df[self.settings.lon_col].shift(1)
+        df["prev_time"] = df[self.settings.date_field].shift(1)
+
+        valid_points = df["prev_lat"].notna()
+        df.loc[valid_points, "distance_to_prev"] = df[valid_points].apply(
+            lambda r: geodesic((r["prev_lat"], r["prev_lon"]), (r["latitude"], r["longitude"])).meters, axis=1
+        )
+        df["time_elapsed"] = df[self.settings.date_field] - df["prev_time"]
+        df["cumulative_time"] = df["time_elapsed"].cumsum()
+        df.fillna({"distance_to_prev": 0.0, "time_elapsed": pd.Timedelta(0)}, inplace=True)
+        return df.drop(columns=["prev_lat", "prev_lon", "prev_time"])
+
+    def _format_timedelta(self, td: pd.Timedelta) -> str:
+        total_seconds = int(td.total_seconds())
+        hours, remainder = divmod(total_seconds, 3600)
+        minutes, seconds = divmod(remainder, 60)
+        return f"{hours:02d}:{minutes:02d}:{seconds:02d}"
+
+    def _get_midpoint(self, df: pd.DataFrame) -> Tuple[float, float]:
+        all_nodes = [node for path in df["path_nodes"] if path for node in path]
+        if not all_nodes:
+            return (df[self.settings.lat_col].mean(), df[self.settings.lon_col].mean())
+        avg_lat = sum(self.graph.nodes[n]["y"] for n in all_nodes) / len(all_nodes)
+        avg_lon = sum(self.graph.nodes[n]["x"] for n in all_nodes) / len(all_nodes)
+        return (avg_lat, avg_lon)
+
+    def _offset_coordinates(self, coords: List[Tuple[float, float]], offset_m: float) -> List[Tuple[float, float]]:
+        if len(coords) < 2 or offset_m == 0: return coords
+        offset_coords = []
+        for i, (lat, lon) in enumerate(coords):
+            if i == 0: p_prev, p_next = coords[i], coords[i + 1]
+            elif i == len(coords) - 1: p_prev, p_next = coords[i - 1], coords[i]
+            else: p_prev, p_next = coords[i - 1], coords[i + 1]
+            normal_angle = math.atan2(p_next[0] - p_prev[0], p_next[1] - p_prev[1]) + math.pi / 2
+            offset_lat = offset_m / 111111
+            offset_lon = offset_m / (111111 * math.cos(math.radians(lat)))
+            new_lat = lat + offset_lat * math.sin(normal_angle)
+            new_lon = lon + offset_lon * math.cos(normal_angle)
+            offset_coords.append((new_lat, new_lon))
+        return offset_coords
+
+    def _find_furthest_point(self, df: pd.DataFrame) -> Tuple[Optional[int], Optional[int], Optional[pd.Series]]:
+        if df["origin_node"].isnull().all(): return None, None, None
+        start_node = df["origin_node"].iloc[0]
+        start_lat, start_lon = self.graph.nodes[start_node]["y"], self.graph.nodes[start_node]["x"]
+        max_dist, furthest_node, furthest_idx, furthest_row = -1, None, None, None
+        for idx, row in df.iterrows():
+            if not row["path_nodes"]: continue
+            for n in row["path_nodes"]:
+                lat, lon = self.graph.nodes[n]["y"], self.graph.nodes[n]["x"]
+                dist = geodesic((start_lat, start_lon), (lat, lon)).meters
+                if dist > max_dist:
+                    max_dist, furthest_node, furthest_idx, furthest_row = dist, n, idx, row
+        return furthest_node, furthest_idx, furthest_row
+
+    def _plot_path(self, m: folium.Map, coords: List[Tuple[float, float]], color: str):
+        if self.settings.use_antpath:
+            AntPath(locations=coords, color=color, weight=self.settings.antpath_weight,
+                    delay=self.settings.antpath_delay, dash_array=self.settings.antpath_dash_array,
+                    pulse_color=self.settings.antpath_pulse_color, opacity=0.8).add_to(m)
+        else:
+            polyline = folium.PolyLine(coords, color=color, weight=4, opacity=0.6).add_to(m)
+            PolyLineTextPath(polyline, "▶", repeat=True, offset=8, spacing=self.settings.arrow_spacing,
+                             attributes={"fill": self.settings.arrow_color, "font-weight": "bold"}).add_to(m)
+
+    def _add_flag_marker(self, m: folium.Map, lat: float, lon: float, color: str, tooltip: str):
+        icon = folium.Icon(color=color, icon="flag", prefix="fa")
+        folium.Marker(location=(lat, lon), icon=icon, tooltip=tooltip).add_to(m)
+
+    def _add_point_markers(self, m: folium.Map, df: pd.DataFrame):
+        action_colors = self.settings.action_colors
+        action_layers = {action: folium.FeatureGroup(name=action) for action in action_colors}
+        action_layers["Others"] = folium.FeatureGroup(name="Others")
+        for idx, row in df.iterrows():
+            action = row.get("action", "Unknown")
+            tooltip = (f"<b>#{idx + 1} {action}</b><br>"
+                       f"Time: {row['date_time'].strftime('%H:%M:%S')}<br>"
+                       f"Dist from prev: {row['distance_to_prev']:.1f} m<br>"
+                       f"Time since prev: {self._format_timedelta(row['time_elapsed'])}")
+            color = action_colors.get(action, "gray")
+            target_layer = action_layers.get(action, action_layers["Others"])
+            folium.CircleMarker(location=(row[self.settings.lat_col], row[self.settings.lon_col]), radius=self.settings.marker_radius,
+                                color=color, fill=True, fill_opacity=0.9, tooltip=tooltip).add_to(target_layer)
+        for layer in action_layers.values(): layer.add_to(m)
+
+    # --- MAIN PLOT METHOD ---
+
+    def plot(self, df: pd.DataFrame) -> folium.Map:
+        try:
+            df_dict = df.iloc[0].to_dict()
+            df_dict[self.settings.date_field] = pd.to_datetime(df_dict[self.settings.date_field])
+            RouteDataPoint.model_validate(df_dict)
+        except Exception as e:
+            raise ValueError(f"DataFrame does not match required schema. Error: {e}")
+
+        processed_df = self._compute_distance_time_metrics(df)
+        midpoint = self._get_midpoint(processed_df)
+
+        m = folium.Map(location=midpoint, zoom_start=self.settings.zoom_start,
+                       tiles=self.settings.default_tile)
+        for name, url in self.tile_layers.items():
+            if name != self.settings.default_tile:
+                folium.TileLayer(tiles=url, name=name, attr=name).add_to(m)
+
+        furthest_node, furthest_idx, furthest_row = self._find_furthest_point(processed_df)
+
+        if furthest_idx is not None:
+            for idx, row in processed_df.iterrows():
+                if not row["path_nodes"]: continue
+                coords = [(self.graph.nodes[n]["y"], self.graph.nodes[n]["x"]) for n in row["path_nodes"]]
+                is_forward = idx <= furthest_idx
+                path_color = self.settings.forward_color if is_forward else self.settings.return_color
+                path_coords = coords if is_forward else self._offset_coordinates(coords, self.settings.return_offset_m)
+                self._plot_path(m, path_coords, path_color)
+
+        start_node = processed_df["origin_node"].iloc[0]
+        self._add_flag_marker(m, self.graph.nodes[start_node]["y"], self.graph.nodes[start_node]["x"],
+                              self.settings.marker_origin_color, f"Start<br>{processed_df[self.settings.date_field].iloc[0].strftime('%H:%M:%S')}")
+
+        end_node = processed_df["dest_node"].iloc[-1]
+        self._add_flag_marker(m, self.graph.nodes[end_node]["y"], self.graph.nodes[end_node]["x"],
+                              self.settings.marker_end_color, f"Finish<br>{processed_df[self.settings.date_field].iloc[-1].strftime('%H:%M:%S')}")
+
+        if furthest_node:
+            self._add_flag_marker(m, self.graph.nodes[furthest_node]["y"], self.graph.nodes[furthest_node]["x"],
+                                  self.settings.furthest_marker_color, f"Furthest Point<br>{furthest_row[self.settings.date_field].strftime('%H:%M:%S')}")
+
+        self._add_point_markers(m, processed_df)
+        folium.LayerControl(collapsed=False).add_to(m)
+        return m

sibi_dst/osmnx_helper/route_path_builder.py

@@ -0,0 +1,98 @@
+import numpy as np
+import pandas as pd
+import networkx as nx
+import osmnx as ox
+from typing import List
+
+class RoutePathBuilder:
+    """
+    Builds shortest paths for consecutive GPS points (origins & destinations) within each associate's track.
+    """
+
+    def __init__(
+        self,
+        graph: nx.MultiDiGraph,
+        lat_col: str = "latitude",
+        lon_col: str = "longitude",
+        grouping_col: str = "associate_id",
+        sort_key=None  # Default sort key for DataFrame
+    ):
+        """
+        :param graph: The OSMnx MultiDiGraph.
+        :param lat_col: Column name for latitude.
+        :param lon_col: Column name for longitude.
+        :param associate_col: Column name for associate/grouping key.
+        """
+        if sort_key is None:
+            sort_key = ["associate_id", "date_time"]
+        self.graph = graph
+        self.lat_col = lat_col
+        self.lon_col = lon_col
+        self.grouping_col = grouping_col
+        self.sort_key = sort_key
+        if self.sort_key is None:
+            self.sort_key = [self.grouping_col, "date_time"]
+
+    @staticmethod
+    def _get_shortest_path(u: int, v: int, graph: nx.MultiDiGraph) -> List[int]:
+        """Return the node sequence for the shortest path from u to v, or [] if none."""
+        try:
+            return nx.shortest_path(graph, u, v, weight="length")
+        except nx.NetworkXNoPath:
+            return []
+
+    @staticmethod
+    def _path_length_from_nodes(node_list: List[int], graph: nx.MultiDiGraph) -> float:
+        """Sum up the 'length' attribute along consecutive node pairs."""
+        if len(node_list) < 2:
+            return np.nan
+        total = 0.0
+        for u, v in zip(node_list[:-1], node_list[1:]):
+            edge_data = graph.get_edge_data(u, v)
+            lengths = [edata.get("length", 0) for edata in edge_data.values()]
+            total += min(lengths) if lengths else 0
+        return total
+
+    def build_routes(self, df: pd.DataFrame) -> pd.DataFrame:
+        """
+        Generate destination coordinates, snap to graph nodes, and compute shortest paths.
+
+        :param df: Input DataFrame containing grouping_col, latitude, and longitude columns.
+        :return: DataFrame with added columns:
+            ['dest_lat', 'dest_lon', 'origin_node', 'dest_node', 'path_nodes', 'path_coords', 'distance_m']
+        """
+        # 1) Build destination coordinates by shifting per grouping column
+        df = df.copy()
+        df["dest_lat"] = df.groupby(self.grouping_col)[self.lat_col].shift(-1)
+        df["dest_lon"] = df.groupby(self.grouping_col)[self.lon_col].shift(-1)
+
+        # Drop tail rows without next point
+        df = df.dropna(subset=["dest_lat", "dest_lon"]).reset_index(drop=True)
+
+        # 2) Snap origin & destination points to graph nodes
+        df["origin_node"] = ox.nearest_nodes(
+            self.graph, X=df[self.lon_col].values, Y=df[self.lat_col].values
+        )
+        df["dest_node"] = ox.nearest_nodes(
+            self.graph, X=df["dest_lon"].values, Y=df["dest_lat"].values
+        )
+
+        # 3) Compute paths, coordinates, and distances
+        df["path_nodes"] = [
+            self._get_shortest_path(u, v, self.graph)
+            for u, v in zip(df["origin_node"], df["dest_node"])
+        ]
+
+        df["path_coords"] = df["path_nodes"].apply(
+            lambda nl: [(self.graph.nodes[n]["y"], self.graph.nodes[n]["x"]) for n in nl]
+        )
+
+        df["distance_m"] = df["path_nodes"].apply(
+            lambda nl: self._path_length_from_nodes(nl, self.graph)
+        )
+        # Ensure NaN distances become 0
+        df["distance_m"] = df["distance_m"].fillna(0)
+        # Remove any legs with no path
+        df = df[df["path_nodes"].str.len() > 0].reset_index(drop=True)
+
+        return df.sort_values(self.sort_key).reset_index(drop=True)

sibi_dst/osmnx_helper/utils.py

@@ -442,6 +442,8 @@ def get_graph(**options):
              - The list or collection of edges that describe relationships
                between nodes in the graph
     """
+    if not options:
+        raise ValueError("No options provided to PBFHandler for graph creation.")
     handler = PBFHandler(**options)
     handler.load()
     return handler.graph, handler.nodes, handler.edges

{sibi_dst-2025.1.12.dist-info → sibi_dst-2025.1.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sibi-dst
-Version: 2025.1.12
+Version: 2025.1.13
 Summary: Data Science Toolkit
 Author: Luis Valverde
 Author-email: lvalverdeb@gmail.com

{sibi_dst-2025.1.12.dist-info → sibi_dst-2025.1.13.dist-info}/RECORD

@@ -24,12 +24,14 @@ sibi_dst/df_helper/data_cleaner.py,sha256=lkxQoXLvGzXCicFUimnA5nen5qkrO1oxgl_p2B
 sibi_dst/geopy_helper/__init__.py,sha256=Q1RJiUZIOlV0QNNLjxZ_2IZS5LqIe5jRbeQkfD1Vm60,112
 sibi_dst/geopy_helper/geo_location_service.py,sha256=1ArI980QF_gRw096ZsABHwJt-m55jrfOlB8tPwL1BvY,2959
 sibi_dst/geopy_helper/utils.py,sha256=Sb7qfSqIyWh-AZ4GBdB9-z5FrQPWtrdtQLLcNjph0yw,3351
-sibi_dst/osmnx_helper/__init__.py,sha256=eHM2XenOdI-Rc1deeUCVoT_OidtPJRMcveKenqxzCJM,116
+sibi_dst/osmnx_helper/__init__.py,sha256=On2_pD13HmzZjP-YrXV9BA9uFK-z26QkQE-MliGdv5w,134
 sibi_dst/osmnx_helper/base_osm_map.py,sha256=L7g3VBiayHX41BcCBTOCS0iJOKzp2ZZYcrp8N-mnU90,19392
 sibi_dst/osmnx_helper/basemaps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sibi_dst/osmnx_helper/basemaps/calendar_html.py,sha256=UArt6FDgoCgoRte45Xo3IHqd-RNzW0YgitgZYfOFasY,4031
+sibi_dst/osmnx_helper/basemaps/route_map_plotter.py,sha256=rsJidieojcqIoe0kBanZbrxcelrS6nWoAyWoQXWdPiQ,11849
 sibi_dst/osmnx_helper/basemaps/router_plotter.py,sha256=UAiijn-J-jjX4YnL0_P9SFqTadrxMx-YK4djYhqPqfQ,10941
-sibi_dst/osmnx_helper/utils.py,sha256=BzuY8CtYnBAAO8UAr_M7EOk6CP1zcifNLs8pkdFZEFg,20577
+sibi_dst/osmnx_helper/route_path_builder.py,sha256=mDV4mn0yZOCFghOiyiOgHggooh8i2Wqz95iEj-Ar6s4,3815
+sibi_dst/osmnx_helper/utils.py,sha256=HfxrmXVPq3akf68SiwncbAp7XI1ER-zp8YN_doh7YaY,20679
 sibi_dst/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sibi_dst/tests/test_data_wrapper_class.py,sha256=6uFmZR2DxnxQz49L5jT2ehlKvlLnpUHMLFB_PqqUq7k,3336
 sibi_dst/utils/__init__.py,sha256=PQsG188_lnqgSFljkCc15Nyv933HnvmQ7XYs02m77Vc,1217
@@ -71,6 +73,6 @@ sibi_dst/v2/df_helper/core/_params_config.py,sha256=DYx2drDz3uF-lSPzizPkchhy-kxR
 sibi_dst/v2/df_helper/core/_query_config.py,sha256=Y8LVSyaKuVkrPluRDkQoOwuXHQxner1pFWG3HPfnDHM,441
 sibi_dst/v2/utils/__init__.py,sha256=6H4cvhqTiFufnFPETBF0f8beVVMpfJfvUs6Ne0TQZNY,58
 sibi_dst/v2/utils/log_utils.py,sha256=rfk5VsLAt-FKpv6aPTC1FToIPiyrnHAFFBAkHme24po,4123
-sibi_dst-2025.1.12.dist-info/METADATA,sha256=dkWXdBL5nk_gpqEqwfg8UCKCtsKw1eqLKIn4v0BtDy8,2611
-sibi_dst-2025.1.12.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-sibi_dst-2025.1.12.dist-info/RECORD,,
+sibi_dst-2025.1.13.dist-info/METADATA,sha256=9WnZXk7XMCz34My6z4UCuyUden5wziKHPZ7lhqyB0iA,2611
+sibi_dst-2025.1.13.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+sibi_dst-2025.1.13.dist-info/RECORD,,