readrawnix.html 4.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: module readrawnix</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>readrawnix</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/readrawnix.py">/Users/achilleas/code/pilsen-workshop/DataConversionToNIX/readrawnix.py</a></font></td></tr></table>
  11. <p><tt>readrawnix.py<br>
  12. &nbsp;<br>
  13. Usage:<br>
  14. &nbsp;&nbsp;python&nbsp;readrawnix.py&nbsp;&lt;nixfile&gt;<br>
  15. &nbsp;<br>
  16. Arguments:<br>
  17. &nbsp;&nbsp;nixfile&nbsp;&nbsp;&nbsp;Path&nbsp;to&nbsp;the&nbsp;NIX&nbsp;file&nbsp;to&nbsp;read.<br>
  18. &nbsp;<br>
  19. &nbsp;<br>
  20. (Requires&nbsp;Python&nbsp;3)<br>
  21. &nbsp;<br>
  22. Command&nbsp;line&nbsp;script&nbsp;for&nbsp;reading&nbsp;NIX&nbsp;files&nbsp;into&nbsp;an&nbsp;MNE&nbsp;structure&nbsp;(mne-python).<br>
  23. NIX&nbsp;file&nbsp;should&nbsp;have&nbsp;been&nbsp;created&nbsp;using&nbsp;the&nbsp;mnetonix.py&nbsp;script/module.&nbsp;&nbsp;This<br>
  24. reader&nbsp;expects&nbsp;certain&nbsp;objects&nbsp;relationships&nbsp;and&nbsp;names&nbsp;to&nbsp;exist&nbsp;in&nbsp;order&nbsp;to<br>
  25. load&nbsp;all&nbsp;data&nbsp;and&nbsp;metadata&nbsp;successfully.&nbsp;&nbsp;Refer&nbsp;to&nbsp;the&nbsp;"NIX&nbsp;Format&nbsp;Layout"&nbsp;in<br>
  26. the&nbsp;mnetonix.py&nbsp;module&nbsp;for&nbsp;details.<br>
  27. &nbsp;<br>
  28. To&nbsp;include&nbsp;in&nbsp;a&nbsp;script,&nbsp;call&nbsp;the&nbsp;'<a href="#-import_nix">import_nix</a>()'&nbsp;and&nbsp;provide&nbsp;a&nbsp;NIX&nbsp;filename.</tt></p>
  29. <p>
  30. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  31. <tr bgcolor="#aa55cc">
  32. <td colspan=3 valign=bottom>&nbsp;<br>
  33. <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  34. <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  35. <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="mne.html">mne</a><br>
  36. <a href="nixio.html">nixio</a><br>
  37. </td><td width="25%" valign=top><a href="numpy.html">numpy</a><br>
  38. <a href="os.html">os</a><br>
  39. </td><td width="25%" valign=top><a href="sys.html">sys</a><br>
  40. </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  41. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  42. <tr bgcolor="#eeaa77">
  43. <td colspan=3 valign=bottom>&nbsp;<br>
  44. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  45. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  46. <td width="100%"><dl><dt><a name="-convert_prop_type"><strong>convert_prop_type</strong></a>(prop)</dt></dl>
  47. <dl><dt><a name="-create_mne_annotations"><strong>create_mne_annotations</strong></a>(mtags)</dt></dl>
  48. <dl><dt><a name="-import_nix"><strong>import_nix</strong></a>(nixfilename)</dt><dd><tt>Import&nbsp;a&nbsp;NIX&nbsp;file&nbsp;(generated&nbsp;with&nbsp;mnetonix.py)&nbsp;into&nbsp;an&nbsp;MNE&nbsp;Raw&nbsp;structure.<br>
  49. &nbsp;<br>
  50. :param&nbsp;nixfilename:&nbsp;Path&nbsp;to&nbsp;the&nbsp;NIX&nbsp;file&nbsp;to&nbsp;be&nbsp;loaded.<br>
  51. :rtype:&nbsp;mne.io.RawArray</tt></dd></dl>
  52. <dl><dt><a name="-main"><strong>main</strong></a>()</dt></dl>
  53. <dl><dt><a name="-md_to_dict"><strong>md_to_dict</strong></a>(section)</dt></dl>
  54. <dl><dt><a name="-merge_data_arrays"><strong>merge_data_arrays</strong></a>(arrays)</dt></dl>
  55. </td></tr></table><p>
  56. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  57. <tr bgcolor="#55aa55">
  58. <td colspan=3 valign=bottom>&nbsp;<br>
  59. <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
  60. <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  61. <td width="100%"><strong>DATA_BLOCK_NAME</strong> = 'EEG Data Block'<br>
  62. <strong>DATA_BLOCK_TYPE</strong> = 'Recording'<br>
  63. <strong>RAW_DATA_GROUP_NAME</strong> = 'Raw Data Group'<br>
  64. <strong>RAW_DATA_GROUP_TYPE</strong> = 'EEG Channels'<br>
  65. <strong>RAW_DATA_TYPE</strong> = 'Raw Data'<br>
  66. <strong>typemap</strong> = {'bool': &lt;class 'bool'&gt;, 'float': &lt;class 'float'&gt;, 'int': &lt;class 'int'&gt;, 'list': &lt;class 'list'&gt;, 'numpy.float64': &lt;class 'numpy.float64'&gt;, 'numpy.ndarray': &lt;built-in function array&gt;, 'str': &lt;class 'str'&gt;, 'tuple': &lt;class 'tuple'&gt;}</td></tr></table>
  67. </body></html>