pytuflow.HydTablesCheck.data_types

pytuflow.HydTablesCheck.data_types#

HydTablesCheck.data_types(filter_by=None)#

Returns all the available data types for the given filter.

The argument filter_by can be used to add a filter to the returned IDs. Available filters for the HydTablesCheck class are:

  • None - returns all data types

Process step filters:

  • xs - returns the available data types for the raw cross-sections

  • processed - returns the data types available for the processed cross-sections

  • channel - returns the data types available for the processed channels

Type filters:

  • [type] - returns the available data types that match the given cross-section type (e.g. “XZ” or “HW”)

Data type filters:

  • [id] - returns the available data types for the given ID

Combine filters:

  • [filter1]/[filter2] …: (use / to delim).

Parameters:

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

Returns:

The available data types.

Return type:

list[str]

Examples

Return all data types for the processed cross-sections:

>>> hyd_tables = HydTablesCheck('/path/to/1d_ta_tables_check.csv')
>>> hyd_tables.data_types('processed')
['depth', 'width', 'effective width', 'effective area',
'effective wetted perimeter', 'radius', 'vertex resistance factor', 'k ']

Returns all data types for a given channel ID:

>>> hyd_tables.data_types('FC01.39')
['depth', 'storage width', 'flow width', 'area', 'wetted perimeter',
'radius', 'vertex resistance factor', 'k ']
Contents