Read only selected items, by number (0-based), or by name
None
time
Read only selected time steps, by default None (=all)
None
keepdims
When reading a single time step only, should the time-dimension be kept in the returned Dataset? by default: False
False
area
Read only data inside (horizontal) area (spectral area files only) given as a bounding box (tuple with left, lower, right, upper) or as list of coordinates for a polygon, by default None
None
x
Read only data for elements containing the (x,y) points(s), by default None
None
y
Read only data for elements containing the (x,y) points(s), by default None
None
elements
Read only selected element ids (spectral area files only)
None
nodes
Read only selected node ids (spectral line files only)
None
Returns
Type
Description
mikeio.dataset.Dataset
A Dataset with dimensions [t,elements/nodes,frequencies,directions]
Examples
>>> mikeio.read("tests/testdata/line_spectra.dfsu")<mikeio.Dataset>dims: (time:4, node:10, direction:16, frequency:25)time: 2017-10-2700:00:00-2017-10-2705:00:00 (4 records)geometry: DfsuSpectral1D (9 elements, 10 nodes)items:0: Energy density <Wave energy density> (meter pow2 sec per deg)
>>> mikeio.read("tests/testdata/area_spectra.dfsu", time=-1)<mikeio.Dataset>dims: (element:40, direction:16, frequency:25)time: 2017-10-2705:00:00 (time-invariant)geometry: DfsuSpectral2D (40 elements, 33 nodes)items:0: Energy density <Wave energy density> (meter pow2 sec per deg)