wonambi-python.github.io/api/wonambi.datatype.html at master · wonambi-python/wonambi-python.github.io

History

379 lines (351 loc) · 23.4 KB

Raw

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

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

<!DOCTYPE html>

<head>

<title>wonambi.datatype module — wonambi 7.11 documentation</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<a href="../index.html" class="icon icon-home"> wonambi

</a>

7.11

</div>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

<li class="toctree-l1"><a class="reference internal" href="../introduction.html">WONAMBI</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#features">Features</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#installation">Installation</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#documentation">Documentation</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#change-log">Change Log</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#requirements">Requirements</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#optional-requirements">Optional Requirements</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#status">Status</a></li>

<li class="toctree-l2"><a class="reference internal" href="../introduction.html#license">License</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../installation.html#linux-mac-os-x">Linux / Mac OS X</a></li>

<li class="toctree-l2"><a class="reference internal" href="../installation.html#windows">Windows</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../analysis/index.html">Tutorial / Analysis</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../analysis/tutorial.html">Get Started</a></li>

<li class="toctree-l2"><a class="reference internal" href="../analysis/spectrum.html">Frequency Domain</a></li>

<li class="toctree-l2"><a class="reference internal" href="../analysis/plot3d.html">Plot 3D images</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../cmd.html">Command Line</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../cmd.html#wonambi">wonambi</a></li>

<li class="toctree-l2"><a class="reference internal" href="../cmd.html#won-convert">won_convert</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../gui/index.html">Graphical User Interface</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../gui/open.html">Open Dataset</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/labels.html">Edit Labels</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/channels.html">Plot Channels</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/traces.html">Navigation</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/notes.html">Annotations</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/detect.html">Event detection</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/methods.html">Detection methods</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/analysis.html">Analysis console</a></li>

<li class="toctree-l2"><a class="reference internal" href="../gui/screenshot.html">Screenshot</a></li>

</ul>

</li>

<li class="toctree-l1 current"><a class="reference internal" href="wonambi.html">Modules, classes, functions</a><ul class="current">

<li class="toctree-l2"><a class="reference internal" href="wonambi.html#subpackages">Subpackages</a></li>

<li class="toctree-l2 current"><a class="reference internal" href="wonambi.html#submodules">Submodules</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../testing.html">Development</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#prepare-test-environment">Prepare Test Environment</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#get-files">1. Get Files</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#run-the-tests">2. Run the Tests</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#coverage">3. Coverage</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#documentation">4. Documentation</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#release">5. Release</a></li>

<li class="toctree-l2"><a class="reference internal" href="../testing.html#tips-and-tricks">Tips and Tricks</a></li>

</ul>

</li>

<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Change Log</a><ul>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-7">Version 7</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-6">Version 6</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-5">Version 5</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-4">Version 4</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-3">Version 3</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-2">Version 2</a></li>

<li class="toctree-l2"><a class="reference internal" href="../changelog.html#version-1">Version 1</a></li>

</ul>

</li>

</ul>

</div>

</nav>

<a href="../index.html">wonambi</a>

</nav>

<li class="breadcrumb-item"><a href="wonambi.html">wonambi package</a></li>

<li class="breadcrumb-item active">wonambi.datatype module</li>

</li>

</ul>

<hr/>

</div>

<h1>wonambi.datatype module<a class="headerlink" href="#module-wonambi.datatype" title="Permalink to this heading"></a></h1>

Module contains the different types of data formats.

The main class is Data, all the other classes should depend on it. The other

classes are given only as convenience, but they should not overwride

Data.__call__, which needs to be very general.

<dd>Bases: <a class="reference internal" href="#wonambi.datatype.Data" title="wonambi.datatype.Data"><code class="xref py py-class docutils literal notranslate">Data</code></a>

Specific class for channel-frequency recordings, with axes:

<dt>channdarray (dtype=’O’)</dt><dd>for each trial, channels in the data (dtype=’U’)

</dd>

<dt>freqndarray (dtype=’O’)</dt><dd>for each trial, 1d matrix with the frequency (dtype=’f’)

</dd>

</dl>

Notes

Conceptually, it is reasonable that each trial has the same frequency band,

so it might be more convenient to use only one array, but it can happen

that different trials have different frequency bands, so we keep the format

more open.

</dd></dl>

Specific class for chan-time recordings, with axes:

<dt>channdarray (dtype=’O’)</dt><dd>for each trial, channels in the data (dtype=’U’)

</dd>

<dt>timendarray (dtype=’O’)</dt><dd>for each trial, 1d matrix with the time stamp (dtype=’f’)

</dd>

</dl>

</dd></dl>

Specific class for channel-time-frequency representation, with axes:

<dt>channdarray (dtype=’O’)</dt><dd>for each trial, channels in the data (dtype=’U’)

</dd>

<dt>timendarray (dtype=’O’)</dt><dd>for each trial, 1d matrix with the time stamp (dtype=’f’)

</dd>

<dt>freqndarray (dtype=’O’)</dt><dd>for each trial, 1d matrix with the frequency (dtype=’f’)

</dd>

</dl>

</dd></dl>

class wonambi.datatype.Data(data=None, s_freq=None, **kwargs)<a class="reference internal" href="../_modules/wonambi/datatype.html#Data">[source]</a><a class="headerlink" href="#wonambi.datatype.Data" title="Permalink to this definition"></a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">object</code>

General class containing recordings.

<dt class="field-odd">Parameters:</dt>

<li>data (ndarray) – one matrix with dimension matching the number of axes. You can pass

only one trial.</li>

<li>s_freq (int) – sampling frequency</li>

<li>axes (dict) – dictionary where the key is the name of the axis and the values must be

a numpy vector with the actual values.</li>

</ul>

</dd>

</dl>

data<a class="headerlink" href="#wonambi.datatype.Data.data" title="Permalink to this definition"></a></dt>

<dd>the data as trials. Each trial is a ndarray (dtype=’d’ or ‘f’)

<dd class="field-odd">ndarray (dtype=’O’)

</dd>

</dl>

</dd></dl>

axis<a class="headerlink" href="#wonambi.datatype.Data.axis" title="Permalink to this definition"></a></dt>

<dd>dictionary with axiss (standard names are ‘chan’, ‘time’, ‘freq’);

values should be numpy array

<dd class="field-odd">OrderedDict

</dd>

</dl>

</dd></dl>

s_freq<a class="headerlink" href="#wonambi.datatype.Data.s_freq" title="Permalink to this definition"></a></dt>

<dd>sampling frequency

<dd class="field-odd">int

</dd>

</dl>

</dd></dl>

start_time<a class="headerlink" href="#wonambi.datatype.Data.start_time" title="Permalink to this definition"></a></dt>

<dd>the start time of the recording

<dd class="field-odd">instance of datetime.datetime

</dd>

</dl>

</dd></dl>

attr<a class="headerlink" href="#wonambi.datatype.Data.attr" title="Permalink to this definition"></a></dt>

<dt>contains additional information about the dataset, with keys:</dt><dd><ul class="simple">

<li>scores</li>

</ul>

</dd>

</dl>

<dd class="field-odd">dict

</dd>

</dl>

</dd></dl>

Notes

Something which is not immediately clear for chan. dtype=’U’ (meaning

Unicode) actually creates string of type str_, while if you use dtype=’S’

(meaning String) it creates strings of type bytes_.

export(filename, export_format='FieldTrip', **options)<a class="reference internal" href="../_modules/wonambi/datatype.html#Data.export">[source]</a><a class="headerlink" href="#wonambi.datatype.Data.export" title="Permalink to this definition"></a></dt>

<dd>Export data in other formats.

<dt class="field-odd">Parameters:</dt>

<li>filename (path to file) – file to write</li>

<li>export_format (str, optional) – supported export format is currently FieldTrip, EDF, FIFF, Wonambi,

BrainVision</li>

</ul>

</dd>

</dl>

Notes

‘edf’ takes an optional argument “physical_max”, see write_edf.

‘wonambi’ takes an optional argument “subj_id”, see write_wonambi.

wonambi format creates two files, one .won with the dataset info as json

file and one .dat with the memmap recordings.

‘brainvision’ takes an additional argument (“markers”) which is a list

of dictionaries with fields:

<div>“name” : str (name of the marker),

“start” : float (start time in seconds)

“end” : float (end time in seconds)

</div></blockquote>

‘bids’ has an optional argument “markers”, like in ‘brainvision’

</dd></dl>

index_of(axis)<a class="reference internal" href="../_modules/wonambi/datatype.html#Data.index_of">[source]</a><a class="headerlink" href="#wonambi.datatype.Data.index_of" title="Permalink to this definition"></a></dt>

<dd>Return the index of a axis.

<dt class="field-odd">Parameters:</dt>

<dd class="field-odd">axis (str) – Name of the axis (such as ‘trial’, ‘time’, etc)

</dd>

<dt class="field-even">Returns:</dt>

<dd class="field-even">int or ndarray (dtype=’int’) – number of trial (as int) or number of element in the selected

axis (if any of the other axiss) as 1d array.

</dd>

<dt class="field-odd">Raises:</dt>

<dd class="field-odd">ValueError – If the requested axis is not in the data.

</dd>

</dl>

</dd></dl>

property list_of_axes<a class="headerlink" href="#wonambi.datatype.Data.list_of_axes" title="Permalink to this definition"></a></dt>

<dd>Return the name of all the axes in the data.

</dd></dl>

number_of(axis)<a class="reference internal" href="../_modules/wonambi/datatype.html#Data.number_of">[source]</a><a class="headerlink" href="#wonambi.datatype.Data.number_of" title="Permalink to this definition"></a></dt>

<dd>Return the number of in one axis, as generally as possible.

<dt class="field-odd">Parameters:</dt>

<dd class="field-odd">axis (str) – Name of the axis (such as ‘trial’, ‘time’, etc)

</dd>

<dt class="field-even">Returns:</dt>

<dd class="field-even">int or ndarray (dtype=’int’) – number of trial (as int) or number of element in the selected

axis (if any of the other axiss) as 1d array.

</dd>

<dt class="field-odd">Raises:</dt>

<dd class="field-odd">KeyError – If the requested axis is not in the data.

</dd>

</dl>

Notes

or is it better to catch the exception?

</dd></dl>

</section>

</div>

<a href="wonambi.dataset.html" class="btn btn-neutral float-left" title="wonambi.dataset module" accesskey="p" rel="prev"> Previous</a>

</div>

<hr/>

</div>

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(false);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

wonambi.datatype.html

Latest commit

History

wonambi.datatype.html

File metadata and controls