Skip to content

Commit

Permalink
added new movement datasets figure, with caption (#286)
Browse files Browse the repository at this point in the history
* added new movement datasets figure, with caption

* update caption according to review comment

---------

Co-authored-by: sfmig <[email protected]>
  • Loading branch information
niksirbi and sfmig authored Aug 29, 2024
1 parent 3df12a9 commit 9612951
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
Binary file modified docs/source/_static/dataset_structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/source/getting_started/movement_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ To learn more about `xarray` data structures in general, see the relevant

## Dataset structure

![](../_static/dataset_structure.png)
```{figure} ../_static/dataset_structure.png
:alt: movement dataset structure
An {class}`xarray.Dataset` is a collection of several data arrays that share some dimensions. The schematic shows the data arrays that make up the `poses` and `bboxes` datasets in `movement`.
```

The structure of a `movement` dataset `ds` can be easily inspected by simply
printing it.
Expand Down

0 comments on commit 9612951

Please sign in to comment.