:orphan:

:py:mod:`traccuracy.loaders._point`
===================================

.. py:module:: traccuracy.loaders._point


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   traccuracy.loaders._point.load_point_data



.. py:function:: load_point_data(path: str | None = None, df: Optional[pandas.DataFrame] = None, parent_column: str = 'parent', id_column: str = 'node_id', pos_columns: tuple[str, Ellipsis] = ('z', 'y', 'x'), time_column: str = 't', seg_id_column: str | None = None, name: str | None = None, sep: str | None = None) -> traccuracy._tracking_graph.TrackingGraph

   Load point-based tracking data into a TrackingGraph from a csv-like file

   Assumes each row contains:

   - time
   - position, e.g. three columns 'z', 'y', 'x'
   - parent, a reference to the node in the previous time frame.
     A node without a parent can be indicated by -1

   :param path: Path to the csv-like file to load. Defaults to None.
   :type path: str | None, optional
   :param df: A dataframe that has already been loaded.
              Defaults to None.
   :type df: pd.DataFrame | None, optional
   :param parent_column: A reference to the parent node in the previous
                         time frame. Defaults to "parent".
   :type parent_column: str | None, optional
   :param id_column: Column used to specify node ids. Node IDs should
                     be unique positive integers.
                     Defaults to 'node_id'
   :type id_column: str, optional
   :param pos_columns: A tuple of columns to use for position.
                       Defaults to ("z", "y", "x").
   :type pos_columns: tuple[str], optional
   :param time_column: The column to use for time. Defaults to "t".
   :type time_column: str, optional
   :param seg_id_column: Name of an optional column containing a segmentation
                         label id. Defaults to None.
   :type seg_id_column: str | None, optional
   :param name: Optional string to name/describe the dataset. Defaults to None.
   :type name: str | None, optional
   :param sep: Passed to pd.read_csv to set the sep kwarg. Defaults to None.
   :type sep: str | None, optional

   :raises ValueError: Must provide either a path or a dataframe
   :raises ValueError: parent_column not present in data
   :raises ValueError: id_column not present in data
   :raises ValueError: id_column does not contain positive integers
   :raises ValueError: id_column does not contain unique values
   :raises ValueError: pos_columns not present in data
   :raises ValueError: time_column not present in data
   :raises ValueError: seg_id_column not present in data

   :returns: TrackingGraph