pytuflow.GPKGRL.ids

Contents

pytuflow.GPKGRL.ids#

GPKGRL.ids(filter_by=None)#

Returns all the available IDs for the given filter.

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

  • None: default - returns all available times

  • point:

  • line:

  • polygon: (or region)

  • [data_type]: returns only IDs for the given data type. Shorthand data type names can be used.

Parameters:

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

Returns:

The available IDs.

Return type:

list[str]

Examples

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

>>> res = GPKGRL('/path/to/plot_results_RL.gpkg')
>>> res.ids()
['rl_point', 'rl_line', 'rl_polygon']

Return only line IDs:

>>> res.ids('line')
['rl_line']

Return IDs that have water level results:

>>> res.ids('h')
['rl_point']
Contents