pytuflow.INFO.data_types

pytuflow.INFO.data_types#

INFO.data_types(filter_by=None)#

Returns all the available data types (result types) for the given filter.

The filter_by is an optional input that can be used to filter the return further. Available filters for the INFO class are:

  • None: default - returns all timeseries data types

  • 1d: same as None as class only contains 1D data

  • node

  • channel

  • timeseries: returns only IDs that have time series data.

  • section: returns only IDs that have section data (i.e. long plot data).

  • [id]: returns only data types for the given ID.

Parameters:

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

Returns:

The available data types.

Return type:

list[str]

Examples

The below examples demonstrate how to use the filter argument to filter the returned data types. The first example returns all data types:

>>> res = ...  # Assume res is loaded result class
>>> res.data_types()
['water level', 'flow', 'velocity']

Returning only the node data types:

>>> res.data_types('node')
['water level']

Return only data types for the channel FC01.1_R:

>>> res.data_types('FC01.1_R')
['flow', 'velocity']

Return data types that are available for plotting section data:

>>> res.data_types('section')
['bed level', 'pipes', 'pits', 'water level', 'max water level']
Contents