Skip to content

snap_to_grid

snap_to_grid(value, grid=None, multiple=1)

Snap the value to the current grid.

Args

  • value (float | Sequence[float] | Sequence[Sequence[float]]): Value or sequence of values to snap.
  • grid (float | None): Grid dimension. If None, use current grid.
  • multiple (int): Snap to multiples of the grid. For example, set to 2 to snap the value to multiples of 10 nm on a 5 nm grid.

Returns

float | ndarray: Value snapped to the grid.

See Also

config.grid