result_network.ResultLocation
result_network.ResultLocation(self)A base class for a network location (node, reach) or a catchment wrapper class.
Attributes
| Name | Description |
|---|---|
| derived_quantities | A list of available derived quantities. |
| group | The TimeSeriesIdGroup assosciated with this location. |
| quantities | A list of available quantities. |
| res1d | The Res1D instance that this location belongs to. |
Methods
| Name | Description |
|---|---|
| add_query | Add a query to ResultNetwork.queries list. |
| get_m1d_dataset | Get IRes1DDataSet object associated with ResultLocation. |
| get_query | Create a query for given data item. |
| read | Read the time series data for all quantities at this location into a DataFrame. |
add_query
result_network.ResultLocation.add_query(data_item)Add a query to ResultNetwork.queries list.
get_m1d_dataset
result_network.ResultLocation.get_m1d_dataset(m1d_dataitem=None)Get IRes1DDataSet object associated with ResultLocation.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| m1d_dataitem | IDataItem | Usually ignored, except for ResultReach. | None |
Returns
| Name | Type | Description |
|---|---|---|
| IRes1DDataSet | IRes1DDataSet object associated with ResultLocation. |
get_query
result_network.ResultLocation.get_query(data_item)Create a query for given data item.
read
result_network.ResultLocation.read(column_mode=None)Read the time series data for all quantities at this location into a DataFrame.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| column_mode | str | ColumnMode(optional) | Specifies the type of column index of returned DataFrame. ‘all’ - column MultiIndex with levels matching TimeSeriesId objects. ‘compact’ - same as ‘all’, but removes levels with default values. ‘timeseries’ - column index of TimeSeriesId objects | None |