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
|
# Authors: The MNE-Python contributors.
# License: BSD-3-Clause
# Copyright the MNE-Python contributors.
from docutils import nodes
from docutils.parsers.rst import Directive
from docutils.statemachine import StringList
from mne._fiff.pick import (
_DATA_CH_TYPES_ORDER_DEFAULT,
_DATA_CH_TYPES_SPLIT,
_EYETRACK_CH_TYPES_SPLIT,
_PICK_TYPES_DATA_DICT,
)
from mne.defaults import DEFAULTS
class MNESubstitution(Directive): # noqa: D101
has_content = False
required_arguments = 1
final_argument_whitespace = True
def run(self, **kwargs): # noqa: D102
env = self.state.document.settings.env
if self.arguments[0] == "data channels list":
keys = list()
for key in _DATA_CH_TYPES_ORDER_DEFAULT:
if key in _DATA_CH_TYPES_SPLIT:
keys.append(key)
elif key not in ("meg", "fnirs") and _PICK_TYPES_DATA_DICT.get(
key, False
):
keys.append(key)
rst = "- " + "\n- ".join(
f"``{repr(key)}``: **{DEFAULTS['titles'][key]}** "
f"(scaled by {DEFAULTS['scalings'][key]:g} to "
f"plot in *{DEFAULTS['units'][key]}*)"
for key in keys
)
elif self.arguments[0] == "non-data channels list":
keys = list()
rst = ""
for key in _DATA_CH_TYPES_ORDER_DEFAULT:
if (
not _PICK_TYPES_DATA_DICT.get(key, True)
or key in _EYETRACK_CH_TYPES_SPLIT
or key in ("ref_meg", "whitened")
):
keys.append(key)
for key in keys:
if DEFAULTS["scalings"].get(key, False) and DEFAULTS["units"].get(
key, False
):
rst += (
f"- ``{repr(key)}``: **{DEFAULTS['titles'][key]}** "
f"(scaled by {DEFAULTS['scalings'][key]:g} to "
f"plot in *{DEFAULTS['units'][key]}*)\n"
)
else:
rst += f"- ``{repr(key)}``: **{DEFAULTS['titles'][key]}**\n"
else:
raise self.error(
"MNE directive unknown in %s: %r" # noqa: UP031
% (
env.doc2path(env.docname, base=None),
self.arguments[0],
)
)
node = nodes.compound(rst) # General(Body), Element
content = StringList(
rst.split("\n"),
parent=self.content.parent,
parent_offset=self.content.parent_offset,
)
self.state.nested_parse(content, self.content_offset, node)
return [node]
def setup(app): # noqa: D103
app.add_directive("mne", MNESubstitution)
return {"version": "0.1", "parallel_read_safe": True, "parallel_write_safe": True}
|
