spine.vis.particle

Draw truth-particle labels on top of labeled point clouds.

Functions

scatter_particles(cluster_label, particles)

Builds a graph of true particles in the image.
spine.vis.particle.scatter_particles(cluster_label: ndarray, particles: list[Particle], part_col: int = 6, markersize: float = 1, **kwargs: Any) → list[plotly.graph_objs.Scatter3d][source]

Builds a graph of true particles in the image.

Function which returns a graph object per true particle in the particle list, provided that the particle deposited energy in the detector which appears in the cluster_label tensor.

Parameters:

  • cluster_label (np.ndarray) – (N, M) Tensor of pixel coordinates and their associated cluster ID

  • particles (List[Particle]) –

    1. List of true particle objects

  • part_col (int) – Index of the column in the label tensor that contains the particle ID

  • **kwargs (dict, optional) – List of additional arguments to pass to plotly.graph_objs.Scatter3D that make up the output list

Returns:

List of particle traces

Return type:

List[plotly.graph_objs.Scatter3D]