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 > Python Module Index — 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 = 'py-modindex' ; </ script >
47+ < link rel ="index " title ="Index " href ="genindex.html " />
48+ < link rel ="search " title ="Search " href ="search.html " />
49+
50+ < meta name ="viewport " content ="width=device-width, initial-scale=1 "/>
51+ < meta name ="docsearch:language " content ="en "/>
52+ < meta name ="docsearch:version " content ="" />
53+
54+
55+ </ head >
56+
57+
58+ < body data-bs-spy ="scroll " data-bs-target =".bd-toc-nav " data-offset ="180 " data-bs-root-margin ="0px 0px -60% " data-default-mode ="">
59+
60+
61+
62+ < div id ="pst-skip-link " class ="skip-link d-print-none "> < a href ="#main-content "> Skip to main content</ a > </ div >
63+
64+ < div id ="pst-scroll-pixel-helper "> </ div >
65+
66+ < button type ="button " class ="btn rounded-pill " id ="pst-back-to-top ">
67+ < i class ="fa-solid fa-arrow-up "> </ i > Back to top</ button >
68+
69+
70+ < dialog id ="pst-search-dialog ">
71+
72+ < form class ="bd-search d-flex align-items-center "
73+ action ="search.html "
74+ method ="get ">
75+ < i class ="fa-solid fa-magnifying-glass "> </ i >
76+ < input type ="search "
77+ class ="form-control "
78+ name ="q "
79+ placeholder ="Search... "
80+ aria-label ="Search... "
81+ autocomplete ="off "
82+ autocorrect ="off "
83+ autocapitalize ="off "
84+ spellcheck ="false "/>
85+ < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd > K</ kbd > </ span >
86+ </ form >
87+ </ dialog >
88+
89+ < div class ="pst-async-banner-revealer d-none ">
90+ < aside id ="bd-header-version-warning " class ="d-none d-print-none " aria-label ="Version warning "> </ aside >
91+ </ div >
92+
93+
94+ < header class ="bd-header navbar navbar-expand-lg bd-navbar d-print-none ">
95+ </ header >
96+
97+
98+ < div class ="bd-container ">
99+ < div class ="bd-container__inner bd-page-width ">
100+
101+
102+
103+
104+
105+ < dialog id ="pst-primary-sidebar-modal "> </ dialog >
106+ < div id ="pst-primary-sidebar " class ="bd-sidebar-primary bd-sidebar ">
107+
108+
109+
110+ < div class ="sidebar-header-items sidebar-primary__section ">
111+
112+
113+
114+
115+ </ div >
116+
117+ < div class ="sidebar-primary-items__start sidebar-primary__section ">
118+ < div class ="sidebar-primary-item ">
119+
120+
121+
122+
123+
124+ < a class ="navbar-brand logo " href ="index.html ">
125+
126+
127+
128+
129+
130+
131+ < p class ="title logo__title "> circStudio documentation</ p >
132+
133+ </ a > </ div >
134+ < div class ="sidebar-primary-item ">
135+
136+ < 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 ">
137+ < i class ="fa-solid fa-magnifying-glass "> </ i >
138+ < span class ="search-button__default-text "> Search</ span >
139+ < span class ="search-button__kbd-shortcut "> < kbd class ="kbd-shortcut__modifier "> Ctrl</ kbd > +< kbd class ="kbd-shortcut__modifier "> K</ kbd > </ span >
140+ </ button > </ div >
141+ < div class ="sidebar-primary-item "> < nav class ="bd-links bd-docs-nav " aria-label ="Main ">
142+ < div class ="bd-toc-item navbar-nav active ">
143+ < p aria-level ="2 " class ="caption " role ="heading "> < span class ="caption-text "> Contents:</ span > </ p >
144+ < ul class ="nav bd-sidenav ">
145+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_0.html "> Quick setup</ a > </ li >
146+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_1.html "> Opening and processing actigraphy data</ a > </ li >
147+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_2.html "> Preprocessing actigraphy data</ a > </ li >
148+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_3.html "> Calculating common activity and light metrics</ a > </ li >
149+
150+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_4.html "> Mathematical models of circadian rhythms using light intensity data</ a > </ li >
151+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_5.html "> Single-component cosinor</ a > </ li >
152+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_6.html "> Singular Spectrum Analysis (SSA)</ a > </ li >
153+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_7.html "> (Multi-fractal)Detrended fluctuation analysis</ a > </ li >
154+ < li class ="toctree-l1 "> < a class ="reference internal " href ="tutorial_8.html "> Functional Linear Modelling (FLM)</ a > </ li >
155+ < li class ="toctree-l1 "> < a class ="reference internal " href ="api.html "> API Reference</ a > </ li >
156+
157+
158+
159+
160+
161+ </ ul >
162+
163+ </ div >
164+ </ nav > </ div >
165+ </ div >
166+
167+
168+ < div class ="sidebar-primary-items__end sidebar-primary__section ">
169+ < div class ="sidebar-primary-item ">
170+ < div id ="ethical-ad-placement "
171+ class ="flat "
172+ data-ea-publisher ="readthedocs "
173+ data-ea-type ="readthedocs-sidebar "
174+ data-ea-manual ="true ">
175+ </ div > </ div >
176+ </ div >
177+
178+
179+ </ div >
180+
181+ < main id ="main-content " class ="bd-main " role ="main ">
182+
183+
184+
185+ < div class ="sbt-scroll-pixel-helper "> </ div >
186+
187+ < div class ="bd-content ">
188+ < div class ="bd-article-container ">
189+
190+ < div class ="bd-header-article d-print-none ">
191+ < div class ="header-article-items header-article__inner ">
192+
193+ < div class ="header-article-items__start ">
194+
195+ < 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 ">
196+ < span class ="fa-solid fa-bars "> </ span >
197+ </ button > </ div >
198+
199+ </ div >
200+
201+
202+ < div class ="header-article-items__end ">
203+
204+ < div class ="header-article-item ">
205+
206+ < div class ="article-header-buttons ">
207+
208+
209+
210+ < button onclick ="toggleFullScreen() "
211+ class ="btn btn-sm btn-fullscreen-button "
212+ title ="Fullscreen mode "
213+ data-bs-placement ="bottom " data-bs-toggle ="tooltip "
214+ >
215+
216+
217+ < span class ="btn__icon-container ">
218+ < i class ="fas fa-expand "> </ i >
219+ </ span >
220+
221+ </ button >
222+
223+
224+
225+ < 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 ">
226+ < i class ="theme-switch fa-solid fa-sun fa-lg " data-mode ="light " title ="Light "> </ i >
227+ < i class ="theme-switch fa-solid fa-moon fa-lg " data-mode ="dark " title ="Dark "> </ i >
228+ < i class ="theme-switch fa-solid fa-circle-half-stroke fa-lg " data-mode ="auto " title ="System Settings "> </ i >
229+ </ button >
230+
231+
232+ < 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 ">
233+ < i class ="fa-solid fa-magnifying-glass fa-lg "> </ i >
234+ </ button >
235+
236+ </ div > </ div >
237+
238+ </ div >
239+
240+ </ div >
241+ </ div >
242+
243+
244+
245+ < div id ="jb-print-docs-body " class ="onlyprint ">
246+ < h1 > </ h1 >
247+ <!-- Table of contents -->
248+ < div id ="print-main-content ">
249+ < div id ="jb-print-toc ">
250+
251+ </ div >
252+ </ div >
253+ </ div >
254+
255+
256+
257+ < div id ="searchbox "> </ div >
258+ < article class ="bd-article ">
259+
260+
261+ < h1 > Python Module Index</ h1 >
262+
263+ < div class ="modindex-jumpbox ">
264+ < a href ="#cap-c "> < strong > c</ strong > </ a >
265+ </ div >
266+
267+ < table class ="indextable modindextable ">
268+ < tr class ="pcap "> < td > </ td > < td >  </ td > < td > </ td > </ tr >
269+ < tr class ="cap " id ="cap-c "> < td > </ td > < td >
270+ < strong > c</ strong > </ td > < td > </ td > </ tr >
271+ < tr >
272+ < td > < img src ="_static/minus.png " class ="toggler "
273+ id ="toggle-1 " style ="display: none " alt ="- " /> </ td >
274+ < td >
275+ < code class ="xref "> circstudio</ code > </ td > < td >
276+ < em > </ em > </ td > </ tr >
277+ < tr class ="cg-1 ">
278+ < td > </ td >
279+ < td >    
280+ < a href ="api.html#module-circstudio.analysis.cosinor.cosinor "> < code class ="xref "> circstudio.analysis.cosinor.cosinor</ code > </ a > </ td > < td >
281+ < em > </ em > </ td > </ tr >
282+ < tr class ="cg-1 ">
283+ < td > </ td >
284+ < td >    
285+ < a href ="api.html#module-circstudio.analysis.metrics.metrics "> < code class ="xref "> circstudio.analysis.metrics.metrics</ code > </ a > </ td > < td >
286+ < em > </ em > </ td > </ tr >
287+ < tr class ="cg-1 ">
288+ < td > </ td >
289+ < td >    
290+ < a href ="api.html#module-circstudio.analysis.models.math_models "> < code class ="xref "> circstudio.analysis.models.math_models</ code > </ a > </ td > < td >
291+ < em > </ em > </ td > </ tr >
292+ < tr class ="cg-1 ">
293+ < td > </ td >
294+ < td >    
295+ < a href ="api.html#module-circstudio.analysis.sleep.diary "> < code class ="xref "> circstudio.analysis.sleep.diary</ code > </ a > </ td > < td >
296+ < em > </ em > </ td > </ tr >
297+ < tr class ="cg-1 ">
298+ < td > </ td >
299+ < td >    
300+ < a href ="api.html#module-circstudio.analysis.sleep.sleep "> < code class ="xref "> circstudio.analysis.sleep.sleep</ code > </ a > </ td > < td >
301+ < em > </ em > </ td > </ tr >
302+ < tr class ="cg-1 ">
303+ < td > </ td >
304+ < td >    
305+ < a href ="api.html#module-circstudio.io.base "> < code class ="xref "> circstudio.io.base</ code > </ a > </ td > < td >
306+ < em > </ em > </ td > </ tr >
307+ < tr class ="cg-1 ">
308+ < td > </ td >
309+ < td >    
310+ < a href ="api.html#module-circstudio.io.mask "> < code class ="xref "> circstudio.io.mask</ code > </ a > </ td > < td >
311+ < em > </ em > </ td > </ tr >
312+ </ table >
313+
314+
315+ </ article >
316+
317+
318+
319+
320+
321+
322+ < footer class ="prev-next-footer d-print-none ">
323+
324+ < div class ="prev-next-area ">
325+ </ div >
326+ </ footer >
327+
328+ </ div >
329+
330+
331+
332+
333+ </ div >
334+ < footer class ="bd-footer-content ">
335+
336+ < div class ="bd-footer-content__inner container ">
337+
338+ < div class ="footer-item ">
339+
340+ < p class ="component-author ">
341+ By Daniel Marques
342+ </ p >
343+
344+ </ div >
345+
346+ < div class ="footer-item ">
347+
348+
349+ < p class ="copyright ">
350+
351+ © Copyright 2025, Daniel Marques | Nuno Morais Lab and Cátia Reis.
352+ < br />
353+
354+ </ p >
355+
356+ </ div >
357+
358+ < div class ="footer-item ">
359+
360+ </ div >
361+
362+ < div class ="footer-item ">
363+
364+ </ div >
365+
366+ </ div >
367+ </ footer >
368+
369+
370+ </ main >
371+ </ div >
372+ </ div >
373+
374+ <!-- Scripts loaded after <body> so the DOM is not blocked -->
375+ < script defer src ="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf "> </ script >
376+ < script defer src ="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf "> </ script >
377+
378+ < footer class ="bd-footer ">
379+ </ footer >
380+ </ body >
381+ </ html >
0 commit comments