-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathspm_DisplayTimeSeries.html
More file actions
206 lines (203 loc) · 14.4 KB
/
Copy pathspm_DisplayTimeSeries.html
File metadata and controls
206 lines (203 loc) · 14.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.5">
<title>spm.spm_DisplayTimeSeries API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>spm.spm_DisplayTimeSeries</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="spm.spm_DisplayTimeSeries.spm_DisplayTimeSeries"><code class="name flex">
<span>def <span class="ident">spm_DisplayTimeSeries</span></span>(<span>*args, **kwargs)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def spm_DisplayTimeSeries(*args, **kwargs):
"""
Build a GUI for 'smart' time series display
FORMAT [ud] = spm_DisplayTimeSeries(y,options)
IN:
- y: the txn data, where t is the number of time sample, and p the
number of 'channels'
- options: a structure (default is empty), which allows to adapt this
function to specific needs. Optional fields are:
.hp: the handle of the parent figure/object. This is used to
include the time series display in a panel/figure. By default, a
new figure will be created.
.Fsample: the sample rate of the data (in Hz)
.events: a nex1 structure vector containing the time indices of the
events and their type (if any). Default is empty. Basic structure
contains fields .time and .type (see below).
.M: a pxn matrix premultiplied to the data when plotted (default is
1).
.bad a px1 binary vector containing the good/bad status of the
channels. Default is zeros(p,1).
.transpose: a binary variable that transposes the data (useful for
file_array display). Using options.transpose = 1 is similar to do
something similar to plot(y'). Default is 0.
.minY: the min value of the plotted data (used to define the main
axes limit). Default is calculated according to the offset.
.maxY: the max value of the plotted data (used to define the main
axes limit). Default is calculated according to the offset.
.minSizeWindow: minimum size of the plotted window (in number of
time samples). {min([200,0.5*size(y,1)]}
.maxSizeWindow: maximum size of the plotted window (in number of
time samples). {min([5000,size(y,1)])}
.ds: an integer giving the number of displayed time samples when
dynamically moving the display time window. Default is 1e4. If you
set it to Inf, no downsampling is applied.
.callback: a string or function handle which is evaluated after
each release of the mouse button (when moving the patch or clicking
on the slider). Default is empty.
.tag: a string used to tag both axes
.pos1: a 4x1 vector containing the position of the main display
axes {[0.13 0.3 0.775 0.655]}
.pos2: a 4x1 vector containing the position of the global power
display axes {[0.13 0.05 0.775 0.15]}
.pos3: a 4x1 vector containing the position of the temporal slider
{[0.13 0.01 0.775 0.02]}
.itw: a vector containing the indices of data time samples
initially displayed in the main axes {1:minSizeWindow}
.ytick: the 'ytick' property of the main axes
.yticklabel: the 'yticklabel' property of the main axes
.offset: a px1 vector containing the vertical offset that has to be
added to each of the plotted time series
!! .ytick, .yticklabel and .offset can be used to display labelled
time series one above each other !!
OUT:
- ud: a structure containing all relevant information about the
graphical objects created for the GUI. This is useful for manipulating
the figure later on (see below).
__________________________________________________________________________
[Matlab code]( https://github.com/spm/spm/blob/main/spm_DisplayTimeSeries.m )
Copyright (C) 1995-2025 Functional Imaging Laboratory, Department of Imaging Neuroscience, UCL
"""
return Runtime.call("spm_DisplayTimeSeries", *args, **kwargs)</code></pre>
</details>
<div class="desc"><p>Build a GUI for 'smart' time series display<br>
FORMAT [ud] = spm_DisplayTimeSeries(y,options)<br>
IN:<br>
- y: the txn data, where t is the number of time sample, and p the<br>
number of 'channels'<br>
- options: a structure (default is empty), which allows to adapt this<br>
function to specific needs. Optional fields are:<br>
.hp: the handle of the parent figure/object. This is used to<br>
include the time series display in a panel/figure. By default, a<br>
new figure will be created.<br>
.Fsample: the sample rate of the data (in Hz)<br>
.events: a nex1 structure vector containing the time indices of the<br>
events and their type (if any). Default is empty. Basic structure<br>
contains fields .time and .type (see below).<br>
.M: a pxn matrix premultiplied to the data when plotted (default is<br>
1).<br>
.bad a px1 binary vector containing the good/bad status of the<br>
channels. Default is zeros(p,1).<br>
.transpose: a binary variable that transposes the data (useful for<br>
file_array display). Using options.transpose = 1 is similar to do<br>
something similar to plot(y'). Default is 0.<br>
.minY: the min value of the plotted data (used to define the main<br>
axes limit). Default is calculated according to the offset.<br>
.maxY: the max value of the plotted data (used to define the main<br>
axes limit). Default is calculated according to the offset.<br>
.minSizeWindow: minimum size of the plotted window (in number of<br>
time samples). {min([200,0.5*size(y,1)]}<br>
.maxSizeWindow: maximum size of the plotted window (in number of<br>
time samples). {min([5000,size(y,1)])}<br>
.ds: an integer giving the number of displayed time samples when<br>
dynamically moving the display time window. Default is 1e4. If you<br>
set it to Inf, no downsampling is applied.<br>
.callback: a string or function handle which is evaluated after<br>
each release of the mouse button (when moving the patch or clicking<br>
on the slider). Default is empty.<br>
.tag: a string used to tag both axes<br>
.pos1: a 4x1 vector containing the position of the main display<br>
axes {[0.13 0.3 0.775 0.655]}<br>
.pos2: a 4x1 vector containing the position of the global power<br>
display axes {[0.13 0.05 0.775 0.15]}<br>
.pos3: a 4x1 vector containing the position of the temporal slider<br>
{[0.13 0.01 0.775 0.02]}<br>
.itw: a vector containing the indices of data time samples<br>
initially displayed in the main axes {1:minSizeWindow}<br>
.ytick: the 'ytick' property of the main axes<br>
.yticklabel: the 'yticklabel' property of the main axes<br>
.offset: a px1 vector containing the vertical offset that has to be<br>
added to each of the plotted time series<br>
!! .ytick, .yticklabel and .offset can be used to display labelled<br>
time series one above each other !!<br>
OUT:<br>
- ud: a structure containing all relevant information about the<br>
graphical objects created for the GUI. This is useful for manipulating<br>
the figure later on (see below).
</p>
<hr>
<p><a href="https://github.com/spm/spm/blob/main/spm_DisplayTimeSeries.m">Matlab code</a></p>
<p>Copyright (C) 1995-2025 Functional Imaging Laboratory, Department of Imaging Neuroscience, UCL</p></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="spm" href="index.html">spm</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="spm.spm_DisplayTimeSeries.spm_DisplayTimeSeries" href="#spm.spm_DisplayTimeSeries.spm_DisplayTimeSeries">spm_DisplayTimeSeries</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
</footer>
</body>
</html>