pytuflow.DAT.data_types

Contents

pytuflow.DAT.data_types#

DAT.data_types(filter_by=None)#

Return the available data types for the given filter.

The available filters are:

  • None - no filter, return all available data types

  • scalar/vector - filter by scalar or vector data types

  • max/min - filter by data types that have maximum or minimum values

  • static/temporal - filter by static or temporal data types

  • 2d/3d - filter by 2D or 3D data types

Filters can be combined by delimiting with a forward slash, e.g. 'scalar/max'.

Parameters:

filter_by (str, optional) – The filter to apply to the data types.

Returns:

The list of data types available.

Return type:

list[str]

Examples

>>> mesh = ... # Assume mesh is a loaded Mesh result
>>> mesh.data_types()
['bed level', 'depth', 'vector velocity', 'velocity', 'water level', 'time of peak h']

Return only the data types that have maximum values:

>>> mesh.data_types('max')
['depth', 'vector velocity', 'velocity', 'water level']
Contents