Export column identifiers in all (#374)

* Add column identifiers to be directly exported in pedpy module

* Update usages of column_identifier on the website

Author: schroedtert

notebooks/getting_started.ipynb

@@ -524,8 +524,7 @@
    },
    "outputs": [],
    "source": [
-    "from pedpy.column_identifier import DENSITY_COL\n",
-    "from pedpy import plot_voronoi_cells\n",
+    "from pedpy import plot_voronoi_cells, DENSITY_COL\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
     "plot_voronoi_cells(\n",
@@ -616,7 +615,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.12.4"
   }
  },
  "nbformat": 4,

notebooks/user_guide.ipynb

@@ -940,8 +940,7 @@
    },
    "outputs": [],
    "source": [
-    "from pedpy.column_identifier import ID_COL, FRAME_COL, DENSITY_COL\n",
-    "from pedpy import plot_voronoi_cells\n",
+    "from pedpy import plot_voronoi_cells, ID_COL, FRAME_COL, DENSITY_COL\n",
     "import matplotlib as mpl\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
@@ -4145,7 +4144,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pedpy.column_identifier import *\n",
+    "from pedpy import ID_COL, FRAME_COL, POINT_COL\n",
     "\n",
     "# Access with column identifier\n",
     "traj.data[[ID_COL, FRAME_COL, POINT_COL]]"
@@ -4254,7 +4253,7 @@
    },
    "outputs": [],
    "source": [
-    "from pedpy.column_identifier import SPEED_COL\n",
+    "from pedpy import SPEED_COL\n",
     "\n",
     "data_with_voronoi_cells_speed = data_with_voronoi_cells.merge(\n",
     "    individual_speed[[ID_COL, FRAME_COL, SPEED_COL]], on=[ID_COL, FRAME_COL]\n",
@@ -4338,7 +4337,7 @@
    },
    "outputs": [],
    "source": [
-    "from pedpy.column_identifier import (\n",
+    "from pedpy import (\n",
     "    X_COL,\n",
     "    Y_COL,\n",
     "    DENSITY_COL,\n",

pedpy/__init__.py

@@ -10,6 +10,37 @@
     __version__ = "unknown"
     __commit_hash__ = "unknown"
 
+from .column_identifier import (
+    A_X_COL,
+    A_Y_COL,
+    ACC_COL,
+    COUNT_COL,
+    CROSSING_FRAME_COL,
+    CUMULATED_COL,
+    DENSITY_COL,
+    DISTANCE_COL,
+    END_POSITION_COL,
+    FIRST_FRAME_COL,
+    FLOW_COL,
+    FRAME_COL,
+    ID_COL,
+    INTERSECTION_COL,
+    LAST_FRAME_COL,
+    MEAN_SPEED_COL,
+    MID_FRAME_COL,
+    MID_POSITION_COL,
+    NEIGHBORS_COL,
+    POINT_COL,
+    POLYGON_COL,
+    SPEED_COL,
+    START_POSITION_COL,
+    TIME_COL,
+    V_X_COL,
+    V_Y_COL,
+    WINDOW_SIZE_COL,
+    X_COL,
+    Y_COL,
+)
 from .data.geometry import MeasurementArea, MeasurementLine, WalkableArea
 from .data.trajectory_data import TrajectoryData
 from .io.trajectory_loader import (
@@ -149,5 +180,34 @@
     "plot_voronoi_cells",
     "plot_walkable_area",
     "plot_acceleration",
+    "ID_COL",
+    "FRAME_COL",
+    "X_COL",
+    "Y_COL",
+    "POINT_COL",
+    "DENSITY_COL",
+    "POLYGON_COL",
+    "INTERSECTION_COL",
+    "COUNT_COL",
+    "CUMULATED_COL",
+    "TIME_COL",
+    "SPEED_COL",
+    "V_X_COL",
+    "V_Y_COL",
+    "FLOW_COL",
+    "MEAN_SPEED_COL",
+    "ACC_COL",
+    "A_X_COL",
+    "A_Y_COL",
+    "FIRST_FRAME_COL",
+    "MID_FRAME_COL",
+    "LAST_FRAME_COL",
+    "NEIGHBORS_COL",
+    "DISTANCE_COL",
+    "CROSSING_FRAME_COL",
+    "START_POSITION_COL",
+    "MID_POSITION_COL",
+    "END_POSITION_COL",
+    "WINDOW_SIZE_COL",
     "__version__",
 ]