pytuflow.LP2D.data_types

pytuflow.LP2D.data_types#

LP2D.data_types(filter_by=None)#

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

2d_lp outputs will typically have bed level and maximum values recorded along with the given result type.

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

  • None: default - returns all available data types

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

  • node / point: returns only node data types. Won’t have much affect as line and point data types will be the same.

  • nodestring / line: returns only nodestring data types. Won’t have much affect as line and point data types will be the same.

  • static / temporal returns static or temporal result types.

  • passing an ID string: 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

>>> lp = LP2D('/path/to/model_LP_NAME_H.csv')
>>> lp.data_types()
['bed level', 'water level', 'max water level']