pyUSID.io.dimension.validate_dimensions

pyUSID.io.dimension.validate_dimensions(dimensions, dim_type='Position')[source]

Checks if the provided object is an iterable with pyUSID.Dimension objects. If it is not full of Dimension objects, Exceptions are raised.

Parameters:
  • dimensions (iterable or pyUSID.Dimension) – Iterable containing pyUSID.Dimension objects

  • dim_type (str, Optional. Default = "Position") – Type of Dimensions in the iterable. Set to “Spectroscopic” if not Position dimensions. This string is only used for more descriptive Exceptions

Returns:

List containing pyUSID.Dimension objects

Return type:

list