spateo.tdr.models.models_migration.line_model
=============================================

.. py:module:: spateo.tdr.models.models_migration.line_model


Functions
---------

.. autoapisummary::

   spateo.tdr.models.models_migration.line_model._construct_line
   spateo.tdr.models.models_migration.line_model.construct_line
   spateo.tdr.models.models_migration.line_model.construct_lines
   spateo.tdr.models.models_migration.line_model.generate_edges
   spateo.tdr.models.models_migration.line_model.construct_align_lines
   spateo.tdr.models.models_migration.line_model.construct_axis_line


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

.. py:function:: _construct_line(start_point: Union[list, tuple, numpy.ndarray] = (-0.5, 0.0, 0.0), end_point: Union[list, tuple, numpy.ndarray] = (0.5, 0.0, 0.0)) -> pyvista.PolyData

   Create a 3D line model.

   :param start_point: Start location in [x, y, z] of the line.
   :param end_point: End location in [x, y, z] of the line.

   :returns: Line model.


.. py:function:: construct_line(start_point: Union[list, tuple, numpy.ndarray], end_point: Union[list, tuple, numpy.ndarray], key_added: Optional[str] = 'line', label: str = 'line', color: str = 'gainsboro', alpha: float = 1.0) -> Tuple[pyvista.PolyData, Optional[str]]

   Create a 3D line model.

   :param start_point: Start location in [x, y, z] of the line.
   :param end_point: End location in [x, y, z] of the line.
   :param key_added: The key under which to add the labels.
   :param label: The label of line model.
   :param color: Color to use for plotting model.
   :param alpha: The opacity of the color to use for plotting model.

   :returns: Line model.
             plot_cmap: Recommended colormap parameter values for plotting.
   :rtype: model


.. py:function:: construct_lines(points: numpy.ndarray, edges: numpy.ndarray, key_added: Optional[str] = 'line', label: Union[str, list, numpy.ndarray] = 'lines', color: Union[str, list, dict] = 'gainsboro', alpha: Union[float, int, list, dict] = 1.0) -> Tuple[pyvista.PolyData, Optional[str]]

   Create 3D lines model.

   :param points: List of points.
   :param edges: The edges between points.
   :param key_added: The key under which to add the labels.
   :param label: The label of lines model.
   :param color: Color to use for plotting model.
   :param alpha: The opacity of the color to use for plotting model.

   :returns: Lines model.
             plot_cmap: Recommended colormap parameter values for plotting.
   :rtype: model


.. py:function:: generate_edges(points1: numpy.ndarray, points2: numpy.ndarray) -> Tuple[numpy.ndarray, numpy.ndarray]

.. py:function:: construct_align_lines(model1_points: numpy.ndarray, model2_points: numpy.ndarray, key_added: str = 'check_alignment', label: Union[str, list, numpy.ndarray] = 'align_mapping', color: Union[str, list, dict, numpy.ndarray] = 'gainsboro', alpha: Union[float, int, list, dict, numpy.ndarray] = 1.0) -> Tuple[pyvista.PolyData, Optional[str]]

   Construct alignment lines between models after model alignment.

   :param model1_points: Start location in model1 of the line.
   :param model2_points: End location in model2 of the line.
   :param key_added: The key under which to add the labels.
   :param label: The label of alignment lines model.
   :param color: Color to use for plotting model.
   :param alpha: The opacity of the color to use for plotting model.

   :returns: Alignment lines model.
             plot_cmap: Recommended colormap parameter values for plotting.
   :rtype: model


.. py:function:: construct_axis_line(axis_points: numpy.ndarray, key_added: str = 'axis', label: str = 'axis_line', color: str = 'gainsboro', alpha: Union[float, int, list, dict, numpy.ndarray] = 1.0) -> Tuple[pyvista.PolyData, Optional[str]]

   Construct axis line.

   :param axis_points: List of points defining an axis.
   :param key_added: The key under which to add the labels.
   :param label: The label of axis line model.
   :param color: Color to use for plotting model.
   :param alpha: The opacity of the color to use for plotting model.

   :returns: Axis line model.
             plot_cmap: Recommended colormap parameter values for plotting.
   :rtype: axis_line