Skip to content

probe.py

Neuropixels Probes

activate(schema_name, *, create_schema=True, create_tables=True)

Activates the probe schemas.

Parameters:

Name Type Description Default
schema_name str

A string containing the name of the probe schema.

 required
create_schema bool

If True, schema will be created in the database.

 True
create_tables bool

If True, tables related to the schema will be created in the database.

 True

Dependencies: Upstream tables: Session: A parent table to ProbeInsertion.

Functions:

Source code in element_array_ephys/probe.py 
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
def activate(
    schema_name: str,
    *,
    create_schema: bool = True,
    create_tables: bool = True,
):
    """Activates the `probe` schemas.

    Args:
        schema_name (str): A string containing the name of the probe schema.
        create_schema (bool): If True, schema will be created in the database.
        create_tables (bool): If True, tables related to the schema will be created in the database.

    Dependencies:
    Upstream tables:
        Session: A parent table to ProbeInsertion.

    Functions:
    """
    schema.activate(
        schema_name, create_schema=create_schema, create_tables=create_tables
    )

    # Add neuropixels probes
    for probe_type in (
        "neuropixels 1.0 - 3A",
        "neuropixels 1.0 - 3B",
        "neuropixels UHD",
        "neuropixels 2.0 - SS",
        "neuropixels 2.0 - MS",
    ):
        if not (ProbeType & {"probe_type": probe_type}):
            try:
                ProbeType.create_neuropixels_probe(probe_type)
            except dj.errors.DataJointError as e:
                print(f"Unable to create probe-type: {probe_type}\n{str(e)}")

ProbeType

Bases: Lookup

Type of probe.

Attributes:

Name Type Description
probe_type foreign key, varchar (32)

Name of the probe type.
Source code in element_array_ephys/probe.py 
 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
@schema
class ProbeType(dj.Lookup):
    """Type of probe.

    Attributes:
        probe_type (foreign key, varchar (32) ): Name of the probe type.
    """

    definition = """
    # Type of probe, with specific electrodes geometry defined
    probe_type: varchar(32)  # e.g. neuropixels_1.0
    """

    class Electrode(dj.Part):
        """Electrode information for a given probe.

        Attributes:
            ProbeType (foreign key): ProbeType primary key.
            electrode (foreign key, int): Electrode index, starting at 0.
            shank (int): shank index, starting at 0.
            shank_col (int): column index, starting at 0.
            shank_row (int): row index, starting at 0.
            x_coord (float): x-coordinate of the electrode within the probe in micrometers.
            y_coord (float): y-coordinate of the electrode within the probe in micrometers.
        """

        definition = """
        -> master
        electrode: int       # electrode index, starts at 0
        ---
        shank: int           # shank index, starts at 0, advance left to right
        shank_col: int       # column index, starts at 0, advance left to right
        shank_row: int       # row index, starts at 0.
        x_coord=NULL: float  # (um) x coordinate of the electrode within the probe.
        y_coord=NULL: float  # (um) y coordinate of the electrode within the probe.
        """

    @staticmethod
    def create_neuropixels_probe(probe_type: str = "neuropixels 1.0 - 3A"):
        """
        Create `ProbeType` and `Electrode` for neuropixels probes:
        + neuropixels 1.0 - 3A
        + neuropixels 1.0 - 3B
        + neuropixels UHD
        + neuropixels 2.0 - SS
        + neuropixels 2.0 - MS

        For electrode location, the (0, 0) is the
         bottom left corner of the probe (ignore the tip portion)
        Electrode numbering is 0-indexing
        """

        npx_probes_config = probe_geometry.M
        npx_probes_config["neuropixels 1.0 - 3A"] = npx_probes_config["3A"]
        npx_probes_config["neuropixels 1.0 - 3B"] = npx_probes_config["NP1010"]
        npx_probes_config["neuropixels UHD"] = npx_probes_config["NP1100"]
        npx_probes_config["neuropixels 2.0 - SS"] = npx_probes_config["NP2000"]
        npx_probes_config["neuropixels 2.0 - MS"] = npx_probes_config["NP2010"]

        probe_type = {"probe_type": probe_type}
        probe_params = dict(
            zip(
                probe_geometry.geom_param_names,
                npx_probes_config[probe_type["probe_type"]],
            )
        )
        electrode_layouts = probe_geometry.build_npx_probe(
            **{**probe_params, **probe_type}
        )
        with ProbeType.connection.transaction:
            ProbeType.insert1(probe_type, skip_duplicates=True)
            ProbeType.Electrode.insert(electrode_layouts, skip_duplicates=True)

Electrode

Bases: Part

Electrode information for a given probe.

Attributes:

Name Type Description
ProbeType foreign key

ProbeType primary key.
electrode foreign key, int

Electrode index, starting at 0.
shank int

shank index, starting at 0.
shank_col int

column index, starting at 0.
shank_row int

row index, starting at 0.
x_coord float

x-coordinate of the electrode within the probe in micrometers.
y_coord float

y-coordinate of the electrode within the probe in micrometers.
Source code in element_array_ephys/probe.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class Electrode(dj.Part):
    """Electrode information for a given probe.

    Attributes:
        ProbeType (foreign key): ProbeType primary key.
        electrode (foreign key, int): Electrode index, starting at 0.
        shank (int): shank index, starting at 0.
        shank_col (int): column index, starting at 0.
        shank_row (int): row index, starting at 0.
        x_coord (float): x-coordinate of the electrode within the probe in micrometers.
        y_coord (float): y-coordinate of the electrode within the probe in micrometers.
    """

    definition = """
    -> master
    electrode: int       # electrode index, starts at 0
    ---
    shank: int           # shank index, starts at 0, advance left to right
    shank_col: int       # column index, starts at 0, advance left to right
    shank_row: int       # row index, starts at 0.
    x_coord=NULL: float  # (um) x coordinate of the electrode within the probe.
    y_coord=NULL: float  # (um) y coordinate of the electrode within the probe.
    """

create_neuropixels_probe(probe_type='neuropixels 1.0 - 3A') staticmethod

Create ProbeType and Electrode for neuropixels probes: + neuropixels 1.0 - 3A + neuropixels 1.0 - 3B + neuropixels UHD + neuropixels 2.0 - SS + neuropixels 2.0 - MS

For electrode location, the (0, 0) is the bottom left corner of the probe (ignore the tip portion) Electrode numbering is 0-indexing

Source code in element_array_ephys/probe.py 
 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
@staticmethod
def create_neuropixels_probe(probe_type: str = "neuropixels 1.0 - 3A"):
    """
    Create `ProbeType` and `Electrode` for neuropixels probes:
    + neuropixels 1.0 - 3A
    + neuropixels 1.0 - 3B
    + neuropixels UHD
    + neuropixels 2.0 - SS
    + neuropixels 2.0 - MS

    For electrode location, the (0, 0) is the
     bottom left corner of the probe (ignore the tip portion)
    Electrode numbering is 0-indexing
    """

    npx_probes_config = probe_geometry.M
    npx_probes_config["neuropixels 1.0 - 3A"] = npx_probes_config["3A"]
    npx_probes_config["neuropixels 1.0 - 3B"] = npx_probes_config["NP1010"]
    npx_probes_config["neuropixels UHD"] = npx_probes_config["NP1100"]
    npx_probes_config["neuropixels 2.0 - SS"] = npx_probes_config["NP2000"]
    npx_probes_config["neuropixels 2.0 - MS"] = npx_probes_config["NP2010"]

    probe_type = {"probe_type": probe_type}
    probe_params = dict(
        zip(
            probe_geometry.geom_param_names,
            npx_probes_config[probe_type["probe_type"]],
        )
    )
    electrode_layouts = probe_geometry.build_npx_probe(
        **{**probe_params, **probe_type}
    )
    with ProbeType.connection.transaction:
        ProbeType.insert1(probe_type, skip_duplicates=True)
        ProbeType.Electrode.insert(electrode_layouts, skip_duplicates=True)

Probe

Bases: Lookup

Represent a physical probe with unique ID

Attributes:

Name Type Description
probe foreign key, varchar(32)

Unique ID for this model of the probe.
ProbeType dict

ProbeType entry.
probe_comment varchar(1000)

Comment about this model of probe.
Source code in element_array_ephys/probe.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
@schema
class Probe(dj.Lookup):
    """Represent a physical probe with unique ID

    Attributes:
        probe (foreign key, varchar(32) ): Unique ID for this model of the probe.
        ProbeType (dict): ProbeType entry.
        probe_comment ( varchar(1000) ): Comment about this model of probe.
    """

    definition = """
    # Represent a physical probe with unique identification
    probe: varchar(32)  # unique identifier for this model of probe (e.g. serial number)
    ---
    -> ProbeType
    probe_comment='' :  varchar(1000)
    """

ElectrodeConfig

Bases: Lookup

Electrode configuration setting on a probe.

Attributes:

Name Type Description
electrode_config_hash foreign key, uuid

unique index for electrode configuration.
ProbeType dict

ProbeType entry.
electrode_config_name varchar(4000)

User-friendly name for this electrode configuration.
Source code in element_array_ephys/probe.py 
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
@schema
class ElectrodeConfig(dj.Lookup):
    """Electrode configuration setting on a probe.

    Attributes:
        electrode_config_hash (foreign key, uuid): unique index for electrode configuration.
        ProbeType (dict): ProbeType entry.
        electrode_config_name ( varchar(4000) ): User-friendly name for this electrode configuration.
    """

    definition = """
    # The electrode configuration setting on a given probe
    electrode_config_hash: uuid
    ---
    -> ProbeType
    electrode_config_name: varchar(4000)  # user friendly name
    """

    class Electrode(dj.Part):
        """Electrode included in the recording.

        Attributes:
            ElectrodeConfig (foreign key): ElectrodeConfig primary key.
            ProbeType.Electrode (foreign key): ProbeType.Electrode primary key.
        """

        definition = """  # Electrodes selected for recording
        -> master
        -> ProbeType.Electrode
        """

Electrode

Bases: Part

Electrode included in the recording.

Attributes:

Name Type Description
ElectrodeConfig foreign key

ElectrodeConfig primary key.
ProbeType.Electrode foreign key

ProbeType.Electrode primary key.
Source code in element_array_ephys/probe.py 
161
162
163
164
165
166
167
168
169
170
171
172
class Electrode(dj.Part):
    """Electrode included in the recording.

    Attributes:
        ElectrodeConfig (foreign key): ElectrodeConfig primary key.
        ProbeType.Electrode (foreign key): ProbeType.Electrode primary key.
    """

    definition = """  # Electrodes selected for recording
    -> master
    -> ProbeType.Electrode
    """