From 76cf8e54fb1df14ceb851dd199b3301ef057d97f Mon Sep 17 00:00:00 2001 From: Alister Trabattoni Date: Wed, 18 Sep 2024 09:41:47 +0200 Subject: [PATCH] Add some doc. --- docs/user-guide/data-formats.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/user-guide/data-formats.md b/docs/user-guide/data-formats.md index be5b6e1..58a142c 100644 --- a/docs/user-guide/data-formats.md +++ b/docs/user-guide/data-formats.md @@ -30,6 +30,11 @@ The formats that are currently implemented are: ASN, FEBUS, OPTASENSE, SINTELA a | SINTELA | `"sintela"` | | TERRA15 | `"terra15"` | +```{warning} +Due to poor documentation of the various version of the Febus format, it is recommended to manually provide the required trimming and the position of the timestamps within each block. For example to trim 100 samples on both side of each block and to set the timestamp location at the center of the block for a block of 2000 samples: + `xdas.open_dataarray("path.h5", engine="febus", overlaps=(100, 100), offset=1000)` +``` + ## Extending *xdas* with your file format *xdas* insists on its extensibility, the power is in the hands of the users. Extending *xdas* usually consists of writing few-line-of-code-long functions. The process consists in dealing with the two main aspects of a {py:class}`xarray.DataArray`: unpacking the data and coordinates objects, eventually processing them and packing them back into a Database object.