pytuflow.DATCrossSections.data_types

DATCrossSections.data_types(filter_by=None)

Returns the cross-section types. The filter_by argument is mostly not used. It can be used to pass in a plotting type e.g. "timeseries" to return an empty list ("section" will return the standard types). This is useful if called from an application that wants to check if this result supports a given plot type.

Parameters:

filter_by (str, optional) – Mostly not used. It can be used to pass in a plotting type e.g. "timeseries" to return an empty list ("section" will return the standard types). This is useful if called from an application that wants to check if this result supports a given plot type.

Returns:

List of types.

Return type:

list[str]

Examples

Return all the cross-section types in the layer:

>>> xs = DATCrossSections('/path/to/model.dat')
>>> xs.data_types()
['xz', 'manning n']