spateo.tdr.models.morpho_models.line_model#

Module Contents#

Functions#

_construct_line(, end_point, tuple, ...)

Create a 3D line model.

construct_line(→ pyvista.PolyData)

Create a 3D line model.

construct_lines(→ pyvista.PolyData)

Create 3D lines model.

generate_edges(→ Tuple[numpy.ndarray, numpy.ndarray])

construct_align_lines(→ pyvista.PolyData)

Construct alignment lines between models after model alignment.

construct_axis_line(→ pyvista.PolyData)

Construct axis line.
spateo.tdr.models.morpho_models.line_model._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[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.morpho_models.line_model.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) → 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.

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.

spateo.tdr.models.morpho_models.line_model.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) → pyvista.PolyData[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.

spateo.tdr.models.morpho_models.line_model.generate_edges(points1: numpy.ndarray, points2: numpy.ndarray) → Tuple[numpy.ndarray, numpy.ndarray][source]#
spateo.tdr.models.morpho_models.line_model.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) → pyvista.PolyData[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.

spateo.tdr.models.morpho_models.line_model.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) → pyvista.PolyData[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.