mnetonix.html 5.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module mnetonix</title>
  3. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  4. </head><body bgcolor="#f0f0f8">
  5. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  6. <tr bgcolor="#7799ee">
  7. <td valign=bottom>&nbsp;<br>
  8. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>mnetonix</strong></big></big></font></td
  9. ><td align=right valign=bottom
  10. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/Users/achilleas/code/pilsen-workshop/DataConversionToNIX/mnetonix.py">/Users/achilleas/code/pilsen-workshop/DataConversionToNIX/mnetonix.py</a></font></td></tr></table>
  11. <p><tt>mnetonix.py<br>
  12. &nbsp;<br>
  13. Usage:<br>
  14. python&nbsp;mnetonix.py&nbsp;&lt;datafile&gt;&nbsp;&lt;montage&gt;<br>
  15. &nbsp;<br>
  16. -&nbsp;datafile:&nbsp;Either&nbsp;an&nbsp;EDF&nbsp;file&nbsp;or&nbsp;a&nbsp;BrainVision&nbsp;header&nbsp;file&nbsp;(vhdr).<br>
  17. -&nbsp;montage:&nbsp;Any&nbsp;format&nbsp;montage&nbsp;file&nbsp;supported&nbsp;by&nbsp;MNE.<br>
  18. &nbsp;<br>
  19. (Requires&nbsp;Python&nbsp;3)<br>
  20. &nbsp;<br>
  21. Command&nbsp;line&nbsp;script&nbsp;for&nbsp;reading&nbsp;EDF&nbsp;and&nbsp;BrainVision&nbsp;files&nbsp;using&nbsp;MNE<br>
  22. (mne-python)&nbsp;and&nbsp;storing&nbsp;the&nbsp;data&nbsp;and&nbsp;metadata&nbsp;into&nbsp;a&nbsp;NIX&nbsp;file.&nbsp;&nbsp;Supports<br>
  23. reading&nbsp;montage&nbsp;files&nbsp;for&nbsp;recording&nbsp;channel&nbsp;locations.<br>
  24. &nbsp;<br>
  25. NIX&nbsp;Format&nbsp;layout:<br>
  26. &nbsp;<br>
  27. Data:<br>
  28. Raw&nbsp;Data&nbsp;are&nbsp;stored&nbsp;in&nbsp;either&nbsp;a&nbsp;single&nbsp;2-dimensional&nbsp;DataArray&nbsp;or&nbsp;a&nbsp;collection<br>
  29. of&nbsp;DataArrays&nbsp;(one&nbsp;per&nbsp;recording&nbsp;channel).&nbsp;&nbsp;The&nbsp;latter&nbsp;makes&nbsp;tagging&nbsp;easier<br>
  30. since&nbsp;MultiTag&nbsp;positions&nbsp;and&nbsp;extents&nbsp;don't&nbsp;need&nbsp;to&nbsp;specify&nbsp;every&nbsp;channel&nbsp;they<br>
  31. reference.&nbsp;&nbsp;However,&nbsp;creating&nbsp;multiple&nbsp;DataArrays&nbsp;makes&nbsp;file&nbsp;sizes&nbsp;much<br>
  32. bigger.<br>
  33. &nbsp;<br>
  34. Stimuli:<br>
  35. MNE&nbsp;provides&nbsp;stimulus&nbsp;information&nbsp;through&nbsp;the&nbsp;Raw.annotations&nbsp;dictionary.<br>
  36. Onsets&nbsp;correspond&nbsp;to&nbsp;the&nbsp;'positions'&nbsp;array&nbsp;and&nbsp;durations&nbsp;correspond&nbsp;to&nbsp;the<br>
  37. 'extents'&nbsp;array&nbsp;of&nbsp;the&nbsp;"Stimuli"&nbsp;MultiTag.<br>
  38. &nbsp;<br>
  39. Metadata:<br>
  40. MNE&nbsp;collects&nbsp;metadata&nbsp;into&nbsp;a&nbsp;(nested)&nbsp;dictionary&nbsp;(Raw.info).&nbsp;&nbsp;All&nbsp;non-empty<br>
  41. keys&nbsp;are&nbsp;converted&nbsp;into&nbsp;Properties&nbsp;in&nbsp;NIX.&nbsp;&nbsp;The&nbsp;nested&nbsp;structure&nbsp;of&nbsp;the<br>
  42. dictionary&nbsp;is&nbsp;replicated&nbsp;in&nbsp;NIX&nbsp;by&nbsp;creating&nbsp;child&nbsp;Sections,&nbsp;starting&nbsp;with&nbsp;one<br>
  43. root&nbsp;section&nbsp;with&nbsp;name&nbsp;"Info".</tt></p>
  44. <p>
  45. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  46. <tr bgcolor="#aa55cc">
  47. <td colspan=3 valign=bottom>&nbsp;<br>
  48. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  49. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  50. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="mne.html">mne</a><br>
  51. <a href="nixio.html">nixio</a><br>
  52. </td><td width="25%" valign=top><a href="numpy.html">numpy</a><br>
  53. <a href="os.html">os</a><br>
  54. </td><td width="25%" valign=top><a href="matplotlib.pyplot.html">matplotlib.pyplot</a><br>
  55. <a href="sys.html">sys</a><br>
  56. </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  57. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  58. <tr bgcolor="#eeaa77">
  59. <td colspan=3 valign=bottom>&nbsp;<br>
  60. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  61. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  62. <td width="100%"><dl><dt><a name="-create_md_tree"><strong>create_md_tree</strong></a>(section, values)</dt></dl>
  63. <dl><dt><a name="-main"><strong>main</strong></a>()</dt></dl>
  64. <dl><dt><a name="-plot_channel"><strong>plot_channel</strong></a>(data_array, index)</dt></dl>
  65. <dl><dt><a name="-write_multi_da"><strong>write_multi_da</strong></a>(mneraw, block)</dt></dl>
  66. <dl><dt><a name="-write_raw_mne"><strong>write_raw_mne</strong></a>(nfname, mneraw, split_data_channels=True)</dt></dl>
  67. <dl><dt><a name="-write_single_da"><strong>write_single_da</strong></a>(mneraw, block)</dt></dl>
  68. <dl><dt><a name="-write_stim_tags"><strong>write_stim_tags</strong></a>(mneraw, block)</dt></dl>
  69. </td></tr></table><p>
  70. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  71. <tr bgcolor="#55aa55">
  72. <td colspan=3 valign=bottom>&nbsp;<br>
  73. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
  74. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  75. <td width="100%"><strong>RAW_DATA_TYPE</strong> = 'Raw Data'</td></tr></table>
  76. </body></html>