|
16 | 16 | "After preprocessing actigraphy data using the methods defined in the `Raw` class, users can begin calculating metrics based on the activity and light time series. These include common circadian rhythm metrics such as Interdaily Stability (IS) and Relative Amplitude (RA), among others.\n", |
17 | 17 | "\n", |
18 | 18 | "<div class=\"alert alert-block alert-info\">\n", |
19 | | - "<b>Contrast with pyActigraphy</b><p>A key architectural difference between <code>circStudio</code> and <code>pyActigraphy</code> lies in how metric functions are implemented. In <code>pyActigraphy</code>, metrics are defined as methods of the <code>BaseRaw</code> class, which inherits from the mixin subclasses <code>MetricsMixin</code>, <code>ScoringMixin</code> and <code>SleepBoutMixin</code>, and initializes a new <code>LightRecording</code> instance to store the light intensity data.</p>\n", |
| 19 | + "<b>Contrast with pyActigraphy</b><p>A key architectural difference between <code>circStudio</code> and <code>pyActigraphy</code> lies in how metric functions are implemented. In <code>pyActigraphy</code>, metrics are defined as methods of the <code>BaseRaw</code> class, which inherits from the mixin subclasses <code>MetricsMixin</code>, <code>ScoringMixin</code> and <code>SleepBoutMixin</code>, and initializes a <code>LightRecording</code> instance to store the light intensity data.</p>\n", |
20 | 20 | "\n", |
21 | 21 | "<p>In contrast, <code>circStudio</code> separates data structure from metric computation. The <code>Raw</code> class contains only the data attributes of the actigraphy recording and methods for transforming them (e.g., masking, binarization, imputation).</p>\n", |
22 | 22 | "\n", |
|
77 | 77 | { |
78 | 78 | "cell_type": "markdown", |
79 | 79 | "id": "81acabce-d6d1-49c0-9c9a-124b2f28629b", |
80 | | - "metadata": {}, |
| 80 | + "metadata": { |
| 81 | + "jp-MarkdownHeadingCollapsed": true |
| 82 | + }, |
81 | 83 | "source": [ |
82 | 84 | "### Activity" |
83 | 85 | ] |
|
256 | 258 | { |
257 | 259 | "cell_type": "markdown", |
258 | 260 | "id": "0f27eb6f-9927-4012-93fe-6de14e7554b6", |
259 | | - "metadata": {}, |
| 261 | + "metadata": { |
| 262 | + "jp-MarkdownHeadingCollapsed": true |
| 263 | + }, |
260 | 264 | "source": [ |
261 | 265 | "### Light" |
262 | 266 | ] |
263 | 267 | }, |
264 | 268 | { |
265 | 269 | "cell_type": "markdown", |
266 | 270 | "id": "dfaa3f1e-8d93-4df7-982d-7760583b19d7", |
267 | | - "metadata": {}, |
| 271 | + "metadata": { |
| 272 | + "jp-MarkdownHeadingCollapsed": true |
| 273 | + }, |
268 | 274 | "source": [ |
269 | 275 | "#### Average daily light profile" |
270 | 276 | ] |
|
274 | 280 | "id": "9343441e-9056-44e0-a1ba-25b7340541c8", |
275 | 281 | "metadata": {}, |
276 | 282 | "source": [ |
277 | | - "By default, `daily_profile` a `pd.Series`, but the user can modify the behavior of the function to generate an interactive daily profile plot. So, instead of:" |
| 283 | + "By default, `daily_profile` function returns a `pd.Series` containing the average daily light intensity values. However, its behavior can be modified to generate an interactive daily profile plot instead. For example, instead of:" |
278 | 284 | ] |
279 | 285 | }, |
280 | 286 | { |
|
314 | 320 | "id": "0bbee183-04e1-491e-8588-d4250e05c4b7", |
315 | 321 | "metadata": {}, |
316 | 322 | "source": [ |
317 | | - "Do:" |
| 323 | + "Simply do:" |
318 | 324 | ] |
319 | 325 | }, |
320 | 326 | { |
|
6491 | 6497 | { |
6492 | 6498 | "cell_type": "markdown", |
6493 | 6499 | "id": "0fbc99b5-d822-4ed6-84b1-f22513eca87c", |
6494 | | - "metadata": {}, |
| 6500 | + "metadata": { |
| 6501 | + "jp-MarkdownHeadingCollapsed": true |
| 6502 | + }, |
6495 | 6503 | "source": [ |
6496 | 6504 | "#### Interdaily stability (IS)" |
6497 | 6505 | ] |
|
6520 | 6528 | { |
6521 | 6529 | "cell_type": "markdown", |
6522 | 6530 | "id": "c1571089-4088-46de-b98e-6bbfedf8950c", |
6523 | | - "metadata": {}, |
| 6531 | + "metadata": { |
| 6532 | + "jp-MarkdownHeadingCollapsed": true |
| 6533 | + }, |
6524 | 6534 | "source": [ |
6525 | 6535 | "#### Interdaily variability (IV)" |
6526 | 6536 | ] |
|
6549 | 6559 | { |
6550 | 6560 | "cell_type": "markdown", |
6551 | 6561 | "id": "e419d854-a2ed-407b-ab9e-82c9c3365bbc", |
6552 | | - "metadata": {}, |
| 6562 | + "metadata": { |
| 6563 | + "jp-MarkdownHeadingCollapsed": true |
| 6564 | + }, |
6553 | 6565 | "source": [ |
6554 | 6566 | "#### Ten brightest hours of the day (M10)" |
6555 | 6567 | ] |
|
6578 | 6590 | { |
6579 | 6591 | "cell_type": "markdown", |
6580 | 6592 | "id": "a101bacf-67be-400d-a0f7-74397dc256d9", |
6581 | | - "metadata": {}, |
| 6593 | + "metadata": { |
| 6594 | + "jp-MarkdownHeadingCollapsed": true |
| 6595 | + }, |
6582 | 6596 | "source": [ |
6583 | | - "#### Five least illuminated hours of the day (M10)" |
| 6597 | + "#### Five least illuminated hours of the day (L5)" |
6584 | 6598 | ] |
6585 | 6599 | }, |
6586 | 6600 | { |
|
6604 | 6618 | "l5(data=raw.light)" |
6605 | 6619 | ] |
6606 | 6620 | }, |
| 6621 | + { |
| 6622 | + "cell_type": "markdown", |
| 6623 | + "id": "36061f50-a197-4671-940f-b4c29e2e2618", |
| 6624 | + "metadata": {}, |
| 6625 | + "source": [ |
| 6626 | + "### Sleep" |
| 6627 | + ] |
| 6628 | + }, |
| 6629 | + { |
| 6630 | + "cell_type": "markdown", |
| 6631 | + "id": "727bf142-5683-4192-979f-b1ab551f2dcf", |
| 6632 | + "metadata": {}, |
| 6633 | + "source": [ |
| 6634 | + "#### Automatic inactivity detection algorithms" |
| 6635 | + ] |
| 6636 | + }, |
| 6637 | + { |
| 6638 | + "cell_type": "markdown", |
| 6639 | + "id": "609f8cb3-3eaa-4375-b78e-5a5d1f66e66c", |
| 6640 | + "metadata": {}, |
| 6641 | + "source": [ |
| 6642 | + "`circStudio` contains several algorithms to detect inactivity periods in actigraphy recordings. In this tutorial, we will illustrate this functionality using the Roenneberg (also known as MASDA) algorithm." |
| 6643 | + ] |
| 6644 | + }, |
| 6645 | + { |
| 6646 | + "cell_type": "code", |
| 6647 | + "execution_count": null, |
| 6648 | + "id": "3e78ca92-e65f-4af7-b670-06f15f6559b7", |
| 6649 | + "metadata": {}, |
| 6650 | + "outputs": [], |
| 6651 | + "source": [] |
| 6652 | + }, |
6607 | 6653 | { |
6608 | 6654 | "cell_type": "code", |
6609 | 6655 | "execution_count": null, |
6610 | | - "id": "18d87e2c-5c14-4709-8192-fc7d3a98f49b", |
| 6656 | + "id": "0e2fec8b-8cf2-4f3d-8516-5d7840c87f5d", |
6611 | 6657 | "metadata": {}, |
6612 | 6658 | "outputs": [], |
6613 | 6659 | "source": [] |
6614 | 6660 | }, |
6615 | 6661 | { |
6616 | 6662 | "cell_type": "markdown", |
6617 | | - "id": "36061f50-a197-4671-940f-b4c29e2e2618", |
| 6663 | + "id": "5eb1b4c9-4921-4363-aaa3-ee4c80baef8e", |
6618 | 6664 | "metadata": {}, |
6619 | 6665 | "source": [ |
6620 | | - "### Sleep" |
| 6666 | + "#### Sleep Midpoint" |
6621 | 6667 | ] |
6622 | 6668 | }, |
6623 | 6669 | { |
|
0 commit comments