result_network.ResultCatchment

result_network.ResultCatchment(self, catchment, res1d)

Class for wrapping a single ResultData catchment.

Parameters

Name	Type	Description	Default
catchment	IRes1DCatchment	MIKE 1D IRes1DCatchment object.	required
res1d	Res1D	Res1D object the catchment belongs to.	required

Attributes

Name	Description
area	The area of the catchment.
derived_quantities	A list of available derived quantities.
geometry	A geometric representation of the catchment. Requires shapely.
group	The TimeSeriesIdGroup assosciated with this location.
id	The ID of the catchment.
quantities	A list of available quantities.
res1d	The Res1D instance that this location belongs to.
res1d_catchment	DHI.Mike1D.ResultDataAccess.IRes1DCatchment corresponding to this result location.
type	The type of the catchment.

Methods

Name	Description
add	Add quantities at this location to ResultNetwork.queue for reading later.
add_query	Add a query to ResultNetwork.queries list.
get_m1d_dataset	Get IRes1DDataSet object associated with ResultCatchment.
get_query	Get a QueryDataCatchment for given data item.
plot	Plot the time series data for quantities at this location.
read	Read the time series data for quantities at this location into a DataFrame.
to_csv	Extract time series data for quantities at this location into a csv file.
to_dataframe	Read the time series data for quantities at this location into a DataFrame.
to_dfs0	Extract time series data for quantities at this location into a dfs0 file.
to_txt	Extract time series data for quantities at this location into a txt file.

add

result_network.ResultCatchment.add(quantities=None)

Add quantities at this location to ResultNetwork.queue for reading later.

Parameters

Name	Type	Description	Default
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to add. If None, all quantities are added.	`None`

add_query

result_network.ResultCatchment.add_query(data_item)

Add a query to ResultNetwork.queries list.

get_m1d_dataset

result_network.ResultCatchment.get_m1d_dataset(m1d_dataitem=None)

Get IRes1DDataSet object associated with ResultCatchment.

Parameters

Name	Type	Description	Default
m1d_dataitem	IDataItem	Ignored for ResultCatchment.	`None`

Returns

Name	Type	Description
	IRes1DDataSet	IRes1DDataSet object associated with ResultCatchment.

get_query

result_network.ResultCatchment.get_query(data_item)

Get a QueryDataCatchment for given data item.

Returns

Name	Type	Description
	QueryDataCatchment	Query for the given data item at this location.

plot

result_network.ResultCatchment.plot(ax=None, *, quantities=None, **kwargs)

Plot the time series data for quantities at this location.

Parameters

Name	Type	Description	Default
ax	matplotlib.axes.Axes	Axes object to plot on.	`None`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to plot. If None, all quantities are plotted.	`None`
**kwargs		Additional keyword arguments passed to pandas.DataFrame.plot.	`{}`

Returns

Name	Type	Description
	matplotlib.axes.Axes	Axes object with the plot.

read

result_network.ResultCatchment.read(column_mode=None, *, quantities=None)

Read the time series data for quantities at this location into a DataFrame.

Parameters

Name	Type	Description	Default
column_mode	str(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`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to read. If None, all quantities are read.	`None`

Returns

Name	Type	Description
	pd.DataFrame	Time series data with one column per time series.

Raises

Name	Type	Description
	ValueError	If a quantity is not available at this location.

Returns

Name	Type	Description
	pd.DataFrame	Time series data for all quantities at this location.

to_csv

result_network.ResultCatchment.to_csv(
    file_path,
    time_step_skipping_number=1,
    *,
    quantities=None,
)

Extract time series data for quantities at this location into a csv file.

Parameters

Name	Type	Description	Default
file_path	str \| Path	Output file path.	required
time_step_skipping_number	int	Number specifying the time step frequency to output.	`1`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to extract. If None, all quantities are extracted.	`None`

to_dataframe

result_network.ResultCatchment.to_dataframe(
    column_mode=None,
    *,
    quantities=None,
)

Read the time series data for quantities at this location into a DataFrame.

Alias for read() method.

Parameters

Name	Type	Description	Default
column_mode	str(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`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to read. If None, all quantities are read.	`None`

Returns

Name	Type	Description
	pd.DataFrame	Time series data with one column per time series.

to_dfs0

result_network.ResultCatchment.to_dfs0(
    file_path,
    time_step_skipping_number=1,
    *,
    quantities=None,
)

Extract time series data for quantities at this location into a dfs0 file.

Parameters

Name	Type	Description	Default
file_path	str \| Path	Output file path.	required
time_step_skipping_number	int	Number specifying the time step frequency to output.	`1`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to extract. If None, all quantities are extracted.	`None`

to_txt

result_network.ResultCatchment.to_txt(
    file_path,
    time_step_skipping_number=1,
    *,
    quantities=None,
)

Extract time series data for quantities at this location into a txt file.

Parameters

Name	Type	Description	Default
file_path	str \| Path	Output file path.	required
time_step_skipping_number	int	Number specifying the time step frequency to output.	`1`
quantities	str \| list[str] \| None	Quantity id or list of quantity ids to extract. If None, all quantities are extracted.	`None`