slmsuite.holography.toolbox.format_shape#

format_shape(shape, expected_dimension=2)[source]#

Helper function to format a shape tuple.

Parameters:
  • shape ((int, int) OR tuple of int) – The shape to format.

  • expected_dimension (int OR None) – The expected number of dimensions. Ignored if None.

Returns:

The formatted shape.

Return type:

tuple