result_network.ResultGridPoint

result_network.ResultGridPoint(
    self,
    reach,
    gridpoint,
    data_items,
    result_reach,
    res1d,
    tag='',
)

Class for wrapping a single ResultData grid point.

Parameters

Name	Type	Description	Default
reach	IRes1DReach	MIKE 1D IRes1DReach object.	required
gridpoint	IRes1DGridPoint	MIKE 1D IRes1DGridPoint object.	required
data_items	list of IDataItem objects	A list of IDataItem objects (vector data object) the gridpoint has values defined on.	required
result_reach	ResultReach	Instance of ResultReach that this ResultGridPoint belongs to.	required
res1d	Res1D	Res1D object the grid point belongs to.	required
tag	str	Tag for reach location span where grid point belongs to.	`''`

Attributes

Name	Description
bottom_level	Bottom level of the gridpoint.
chainage	Chainage of the gridpoint.
derived_quantities	A list of available derived quantities.
gridpoint	IRes1DGridPoint corresponding to this result location.
group	The TimeSeriesIdGroup assosciated with this location.
quantities	A list of available quantities.
reach	Instance of ResultReach that this ResultGridPoint belongs to.
reach_name	Name of reach the gridpoint is on.
res1d	The Res1D instance that this location belongs to.
res1d_gridpoint	DHI.Mike1D.ResultDataAccess.IRes1DGridPoint corresponding to this result location.
res1d_reach	DHI.Mike1D.ResultDataAccess.IRes1DReach corresponding to this result location.
result_reach	Instance of ResultReach that this ResultGridPoint belongs to.
xcoord	X coordinate of the gridpoint.
ycoord	Y coordinate of the gridpoint.

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 ResultGridPoint.
get_query	Get a QueryDataReach 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.ResultGridPoint.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.ResultGridPoint.add_query(data_item)

Add a query to ResultNetwork.queries list.

get_m1d_dataset

result_network.ResultGridPoint.get_m1d_dataset(m1d_dataitem=None)

Get IRes1DDataSet object associated with ResultGridPoint.

This is the reach IRes1DDataSet object because grid points do not have a corresponding IRes1DDataSet object.

Parameters

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

Returns

Name	Type	Description
	IRes1DDataSet	IRes1DDataSet object associated with ResultGridPoint.

get_query

result_network.ResultGridPoint.get_query(data_item)

Get a QueryDataReach for given data item.

Returns

Name	Type	Description
	QueryDataReach	Query for the data item at this grid point.

plot

result_network.ResultGridPoint.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.ResultGridPoint.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.ResultGridPoint.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.ResultGridPoint.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.ResultGridPoint.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.ResultGridPoint.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`