1+
2+ <!DOCTYPE html>
3+
4+
5+ < html lang ="en " data-content_root ="../ " >
6+
7+ < head >
8+ < meta charset ="utf-8 " />
9+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
10+ < title > Overview: module code — circStudio documentation</ title >
11+
12+
13+
14+ < script data-cfasync ="false ">
15+ document . documentElement . dataset . mode = localStorage . getItem ( "mode" ) || "" ;
16+ document . documentElement . dataset . theme = localStorage . getItem ( "theme" ) || "" ;
17+ </ script >
18+ <!--
19+ this give us a css class that will be invisible only if js is disabled
20+ -->
21+ < noscript >
22+ < style >
23+ .pst-js-only { display : none !important ; }
24+
25+ </ style >
26+ </ noscript >
27+
28+ <!-- Loaded before other Sphinx assets -->
29+ < link href ="../_static/styles/theme.css?digest=8878045cc6db502f8baf " rel ="stylesheet " />
30+ < link href ="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf " rel ="stylesheet " />
31+
32+ < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css?v=8f2a1f02 " />
33+ < link rel ="stylesheet " type ="text/css " href ="../_static/styles/sphinx-book-theme.css?v=eba8b062 " />
34+ < link rel ="stylesheet " type ="text/css " href ="../_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css " />
35+
36+ <!-- So that users can add custom icons -->
37+ < script src ="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf "> </ script >
38+ <!-- Pre-loaded scripts that we'll load fully later -->
39+ < link rel ="preload " as ="script " href ="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf " />
40+ < link rel ="preload " as ="script " href ="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf " />
41+
42+ < script src ="../_static/documentation_options.js?v=9eb32ce0 "> </ script >
43+ < script src ="../_static/doctools.js?v=fd6eb6e6 "> </ script >
44+ < script src ="../_static/sphinx_highlight.js?v=6ffebe34 "> </ script >
45+ < script src ="../_static/scripts/sphinx-book-theme.js?v=887ef09a "> </ script >
46+ < script > DOCUMENTATION_OPTIONS . pagename = '_modules/index' ; </ script >
47+ < link rel ="index " title ="Index " href ="../genindex.html " />
48+ < link rel ="search " title ="Search " href ="../search.html " />
49+ < meta name ="viewport " content ="width=device-width, initial-scale=1 "/>
50+ < meta name ="docsearch:language " content ="en "/>
51+ < meta name ="docsearch:version " content ="" />
52+ </ head >
53+
54+
55+ < body data-bs-spy ="scroll " data-bs-target =".bd-toc-nav " data-offset ="180 " data-bs-root-margin ="0px 0px -60% " data-default-mode ="">
56+
57+
58+
59+ < div id ="pst-skip-link " class ="skip-link d-print-none "> < a href ="#main-content "> Skip to main content</ a > </ div >
60+
61+ < div id ="pst-scroll-pixel-helper "> </ div >
62+
63+ < button type ="button " class ="btn rounded-pill " id ="pst-back-to-top ">
64+ < i class ="fa-solid fa-arrow-up "> </ i > Back to top</ button >
65+
66+
67+ < dialog id ="pst-search-dialog ">
68+
69+ < form class ="bd-search d-flex align-items-center "
70+ action ="../search.html "
71+ method ="get ">
72+ < i class ="fa-solid fa-magnifying-glass "> </ i >
73+ < input type ="search "
74+ class ="form-control "
75+ name ="q "
76+ placeholder ="Search... "
77+ aria-label ="Search... "
78+ autocomplete ="off "
79+ autocorrect ="off "
80+ autocapitalize ="off "
81+ spellcheck ="false "/>
82+ < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd > K</ kbd > </ span >
83+ </ form >
84+ </ dialog >
85+
86+ < div class ="pst-async-banner-revealer d-none ">
87+ < aside id ="bd-header-version-warning " class ="d-none d-print-none " aria-label ="Version warning "> </ aside >
88+ </ div >
89+
90+
91+ < header class ="bd-header navbar navbar-expand-lg bd-navbar d-print-none ">
92+ </ header >
93+
94+
95+ < div class ="bd-container ">
96+ < div class ="bd-container__inner bd-page-width ">
97+
98+
99+
100+
101+
102+ < dialog id ="pst-primary-sidebar-modal "> </ dialog >
103+ < div id ="pst-primary-sidebar " class ="bd-sidebar-primary bd-sidebar ">
104+
105+
106+
107+ < div class ="sidebar-header-items sidebar-primary__section ">
108+
109+
110+
111+
112+ </ div >
113+
114+ < div class ="sidebar-primary-items__start sidebar-primary__section ">
115+ < div class ="sidebar-primary-item ">
116+
117+
118+
119+
120+
121+ < a class ="navbar-brand logo " href ="../index.html ">
122+
123+
124+
125+
126+
127+
128+ < p class ="title logo__title "> circStudio documentation</ p >
129+
130+ </ a > </ div >
131+ < div class ="sidebar-primary-item ">
132+
133+ < button class ="btn search-button-field search-button__button pst-js-only " title ="Search " aria-label ="Search " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
134+ < i class ="fa-solid fa-magnifying-glass "> </ i >
135+ < span class ="search-button__default-text "> Search</ span >
136+ < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd class ="kbd-shortcut__modifier "> K</ kbd > </ span >
137+ </ button > </ div >
138+ < div class ="sidebar-primary-item "> < nav class ="bd-links bd-docs-nav " aria-label ="Main ">
139+ < div class ="bd-toc-item navbar-nav active ">
140+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> Contents:</ span > </ p >
141+ < ul class ="nav bd-sidenav ">
142+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_0.html "> Quick setup</ a > </ li >
143+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_1.html "> Opening and processing actigraphy data</ a > </ li >
144+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_2.html "> Preprocessing actigraphy data</ a > </ li >
145+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_3.html "> Calculating common activity and light metrics</ a > </ li >
146+
147+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_4.html "> Mathematical models of circadian rhythms using light intensity data</ a > </ li >
148+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_5.html "> Single-component cosinor</ a > </ li >
149+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_6.html "> Singular Spectrum Analysis (SSA)</ a > </ li >
150+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_7.html "> (Multi-fractal)Detrended fluctuation analysis</ a > </ li >
151+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../tutorial_8.html "> Functional Linear Modelling (FLM)</ a > </ li >
152+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../api.html "> API Reference</ a > </ li >
153+
154+
155+
156+
157+
158+ </ ul >
159+
160+ </ div >
161+ </ nav > </ div >
162+ </ div >
163+
164+
165+ < div class ="sidebar-primary-items__end sidebar-primary__section ">
166+ < div class ="sidebar-primary-item ">
167+ < div id ="ethical-ad-placement "
168+ class ="flat "
169+ data-ea-publisher ="readthedocs "
170+ data-ea-type ="readthedocs-sidebar "
171+ data-ea-manual ="true ">
172+ </ div > </ div >
173+ </ div >
174+
175+
176+ </ div >
177+
178+ < main id ="main-content " class ="bd-main " role ="main ">
179+
180+
181+
182+ < div class ="sbt-scroll-pixel-helper "> </ div >
183+
184+ < div class ="bd-content ">
185+ < div class ="bd-article-container ">
186+
187+ < div class ="bd-header-article d-print-none ">
188+ < div class ="header-article-items header-article__inner ">
189+
190+ < div class ="header-article-items__start ">
191+
192+ < div class ="header-article-item "> < button class ="sidebar-toggle primary-toggle btn btn-sm " title ="Toggle primary sidebar " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
193+ < span class ="fa-solid fa-bars "> </ span >
194+ </ button > </ div >
195+
196+ </ div >
197+
198+
199+ < div class ="header-article-items__end ">
200+
201+ < div class ="header-article-item ">
202+
203+ < div class ="article-header-buttons ">
204+
205+
206+
207+ < button onclick ="toggleFullScreen() "
208+ class ="btn btn-sm btn-fullscreen-button "
209+ title ="Fullscreen mode "
210+ data-bs-placement ="bottom " data-bs-toggle ="tooltip "
211+ >
212+
213+
214+ < span class ="btn__icon-container ">
215+ < i class ="fas fa-expand "> </ i >
216+ </ span >
217+
218+ </ button >
219+
220+
221+
222+ < button class ="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only " aria-label ="Color mode " data-bs-title ="Color mode " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
223+ < i class ="theme-switch fa-solid fa-sun fa-lg " data-mode ="light " title ="Light "> </ i >
224+ < i class ="theme-switch fa-solid fa-moon fa-lg " data-mode ="dark " title ="Dark "> </ i >
225+ < i class ="theme-switch fa-solid fa-circle-half-stroke fa-lg " data-mode ="auto " title ="System Settings "> </ i >
226+ </ button >
227+
228+
229+ < button class ="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only " title ="Search " aria-label ="Search " data-bs-placement ="bottom " data-bs-toggle ="tooltip ">
230+ < i class ="fa-solid fa-magnifying-glass fa-lg "> </ i >
231+ </ button >
232+
233+ </ div > </ div >
234+
235+ </ div >
236+
237+ </ div >
238+ </ div >
239+
240+
241+
242+ < div id ="jb-print-docs-body " class ="onlyprint ">
243+ < h1 > </ h1 >
244+ <!-- Table of contents -->
245+ < div id ="print-main-content ">
246+ < div id ="jb-print-toc ">
247+
248+ </ div >
249+ </ div >
250+ </ div >
251+
252+
253+
254+ < div id ="searchbox "> </ div >
255+ < article class ="bd-article ">
256+
257+ < h1 > All modules for which code is available</ h1 >
258+ < ul > < li > < a href ="circstudio/analysis/cosinor/cosinor.html "> circstudio.analysis.cosinor.cosinor</ a > </ li >
259+ < li > < a href ="circstudio/analysis/metrics/metrics.html "> circstudio.analysis.metrics.metrics</ a > </ li >
260+ < li > < a href ="circstudio/analysis/models/math_models.html "> circstudio.analysis.models.math_models</ a > </ li >
261+ < li > < a href ="circstudio/analysis/sleep/diary.html "> circstudio.analysis.sleep.diary</ a > </ li >
262+ < li > < a href ="circstudio/analysis/sleep/sleep.html "> circstudio.analysis.sleep.sleep</ a > </ li >
263+ < li > < a href ="circstudio/io/base.html "> circstudio.io.base</ a > </ li >
264+ < li > < a href ="circstudio/io/mask.html "> circstudio.io.mask</ a > </ li >
265+ </ ul >
266+
267+ </ article >
268+
269+
270+
271+
272+
273+
274+ < footer class ="prev-next-footer d-print-none ">
275+
276+ < div class ="prev-next-area ">
277+ </ div >
278+ </ footer >
279+
280+ </ div >
281+
282+
283+
284+
285+ </ div >
286+ < footer class ="bd-footer-content ">
287+
288+ < div class ="bd-footer-content__inner container ">
289+
290+ < div class ="footer-item ">
291+
292+ < p class ="component-author ">
293+ By Daniel Marques
294+ </ p >
295+
296+ </ div >
297+
298+ < div class ="footer-item ">
299+
300+
301+ < p class ="copyright ">
302+
303+ © Copyright 2025, Daniel Marques | Nuno Morais Lab and Cátia Reis.
304+ < br />
305+
306+ </ p >
307+
308+ </ div >
309+
310+ < div class ="footer-item ">
311+
312+ </ div >
313+
314+ < div class ="footer-item ">
315+
316+ </ div >
317+
318+ </ div >
319+ </ footer >
320+
321+
322+ </ main >
323+ </ div >
324+ </ div >
325+
326+ <!-- Scripts loaded after <body> so the DOM is not blocked -->
327+ < script defer src ="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf "> </ script >
328+ < script defer src ="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf "> </ script >
329+
330+ < footer class ="bd-footer ">
331+ </ footer >
332+ </ body >
333+ </ html >
0 commit comments