spateo.tdr.models.models_migration.line_model#
Module Contents#
Functions#
|
Create a 3D line model. |
|
Create a 3D line model. |
|
Create 3D lines model. |
|
|
|
Construct alignment lines between models after model alignment. |
|
Construct axis line. |
- spateo.tdr.models.models_migration.line_model._construct_line(start_point: list | tuple | numpy.ndarray = (-0.5, 0.0, 0.0), end_point: list | tuple | numpy.ndarray = (0.5, 0.0, 0.0)) pyvista.PolyData[source]#
Create a 3D line model.
- Parameters:
- start_point
Start location in [x, y, z] of the line.
- end_point
End location in [x, y, z] of the line.
- Returns:
Line model.
- spateo.tdr.models.models_migration.line_model.construct_line(start_point: list | tuple | numpy.ndarray, end_point: list | tuple | numpy.ndarray, key_added: str | None = 'line', label: str = 'line', color: str = 'gainsboro', alpha: float = 1.0) Tuple[pyvista.PolyData, str | None][source]#
Create a 3D line model.
- Parameters:
- start_point
Start location in [x, y, z] of the line.
- end_point
End location in [x, y, z] of the line.
- key_added
The key under which to add the labels.
- label
The label of line model.
- color
Color to use for plotting model.
- alpha
The opacity of the color to use for plotting model.
- Returns:
Line model. plot_cmap: Recommended colormap parameter values for plotting.
- Return type:
model
- spateo.tdr.models.models_migration.line_model.construct_lines(points: numpy.ndarray, edges: numpy.ndarray, key_added: str | None = 'line', label: str | list | numpy.ndarray = 'lines', color: str | list | dict = 'gainsboro', alpha: float | int | list | dict = 1.0) Tuple[pyvista.PolyData, str | None][source]#
Create 3D lines model.
- Parameters:
- points
List of points.
- edges
The edges between points.
- key_added
The key under which to add the labels.
- label
The label of lines model.
- color
Color to use for plotting model.
- alpha
The opacity of the color to use for plotting model.
- Returns:
Lines model. plot_cmap: Recommended colormap parameter values for plotting.
- Return type:
model
- spateo.tdr.models.models_migration.line_model.generate_edges(points1: numpy.ndarray, points2: numpy.ndarray) Tuple[numpy.ndarray, numpy.ndarray][source]#
- spateo.tdr.models.models_migration.line_model.construct_align_lines(model1_points: numpy.ndarray, model2_points: numpy.ndarray, key_added: str = 'check_alignment', label: str | list | numpy.ndarray = 'align_mapping', color: str | list | dict | numpy.ndarray = 'gainsboro', alpha: float | int | list | dict | numpy.ndarray = 1.0) Tuple[pyvista.PolyData, str | None][source]#
Construct alignment lines between models after model alignment.
- Parameters:
- model1_points
Start location in model1 of the line.
- model2_points
End location in model2 of the line.
- key_added
The key under which to add the labels.
- label
The label of alignment lines model.
- color
Color to use for plotting model.
- alpha
The opacity of the color to use for plotting model.
- Returns:
Alignment lines model. plot_cmap: Recommended colormap parameter values for plotting.
- Return type:
model
- spateo.tdr.models.models_migration.line_model.construct_axis_line(axis_points: numpy.ndarray, key_added: str = 'axis', label: str = 'axis_line', color: str = 'gainsboro', alpha: float | int | list | dict | numpy.ndarray = 1.0) Tuple[pyvista.PolyData, str | None][source]#
Construct axis line.
- Parameters:
- axis_points
List of points defining an axis.
- key_added
The key under which to add the labels.
- label
The label of axis line model.
- color
Color to use for plotting model.
- alpha
The opacity of the color to use for plotting model.
- Returns:
Axis line model. plot_cmap: Recommended colormap parameter values for plotting.
- Return type:
axis_line