shredx.utils.plots.plot_timestep

shredx.utils.plots.plot_timestep(tensor: Float[Tensor, 'rows cols dim'], title: str = '', save: bool = False, fname: str = 'plot.pdf', sensors: list[tuple[int, int]] | None = None) → None

Plot the input tensor.

Parameters:

tensorFloat[torch.Tensor, “rows cols dim”]

The tensor to plot.

titlestr, optional

The title of the plot.

savebool, optional

Whether to save the plot. Default is False.

fnamestr, optional

The name of the file to save the plot to. Default is “plot.pdf”.

sensorslist of (row, col) tuples, optional

If provided, red dots are drawn at each (row, col) coordinate on every dimension subplot. Same convention as generate_static_sensors_from_mask.