Dfs1
Dfs1(self, filename)Class for reading/writing dfs1 files.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| filename | str | Path | Path to dfs1 file | required |
Attributes
| Name | Description |
|---|---|
| custom_blocks | Custom blocks of the dfs1 file header, as name -> 1-D array. |
| deletevalue | File delete value. |
| dx | Step size in x direction. |
| end_time | File end time. |
| geometry | Spatial information. |
| is_geo | Are coordinates geographical (LONG/LAT)? |
| items | List of items. |
| latitude | Origin latitude. |
| longitude | Origin longitude. |
| n_items | Number of items. |
| n_timesteps | Number of time steps. |
| nx | Number of node values. |
| orientation | Orientation (in own CRS). |
| origin | Origin (in own CRS). |
| start_time | File start time. |
| timestep | Time step size in seconds. |
| title | Title of the dfs1 file. |
| x0 | Start point of x values (often 0). |
Methods
| Name | Description |
|---|---|
| read | Read data from a dfs1 file. |
read
Dfs1.read(items=None, time=None, keepdims=False, dtype=np.float32)Read data from a dfs1 file.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| items | str | int | Sequence[str | int] | None | Read only selected items, by number (0-based), or by name | None |
| time | int | str | slice | Sequence[int] | None | Read only selected time steps, by default None (=all) | None |
| keepdims | bool | When reading a single time step only, should the time-dimension be kept in the returned Dataset? by default: False | False |
| dtype | Any | Define the dtype of the returned dataset (default = np.float32) | np.float32 |
Returns
| Name | Type | Description |
|---|---|---|
| Dataset |