DfsuModelResult

DfsuModelResult(
    self,
    data,
    *,
    name=None,
    item=None,
    quantity=None,
    aux_items=None,
)

Construct a DfsuModelResult from a dfsu file or mikeio.Dataset/DataArray.

Parameters

Name	Type	Description	Default
data	types.UnstructuredType	the input data or file path	required
name	Optional[str]	The name of the model result, by default None (will be set to file name or item name)	None
item	str | int | None	If multiple items/arrays are present in the input an item must be given (as either an index or a string), by default None	None
quantity	Quantity	Model quantity, for MIKE files this is inferred from the EUM information	None
aux_items	Optional[list[int | str]]	Auxiliary items, by default None	None

Methods

Name	Description
extract	Extract ModelResult at observation positions

extract

DfsuModelResult.extract(observation, spatial_method=None)

Extract ModelResult at observation positions

Note: this method is typically not called directly, but by the match() method.

Parameters

Name	Type	Description	Default
observation	or	positions (and times) at which modelresult should be extracted	required
spatial_method	Optional[str]	spatial selection/interpolation method, ‘contained’ (=isel), ‘nearest’, ‘inverse_distance’ (with 5 nearest points), by default None = ‘inverse_distance’	None

Returns

Name	Type	Description
	PointModelResult or TrackModelResult	extracted modelresult with the same geometry as the observation