Skip to content

added IcEphysAssembly #1739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saskiad merged 3 commits into from
Feb 25, 2026
+26 −5
Merged

added IcEphysAssembly #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af541c0
added IcEphysAssembly
saskiad Feb 19, 2026
003b436
patch clamp
saskiad Feb 20, 2026
4df26e4
added to instrument components
saskiad Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/source/components/devices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ Description of an enclosure

### EphysAssembly

Named assembly for combining a manipulator and ephys probes
Named assembly for combining a manipulator and extracellular ephys probes

| Field | Type | Title (Description) |
|-------|------|-------------|
Expand All @@ -351,7 +351,7 @@ Named assembly for combining a manipulator and ephys probes

### EphysProbe

Probe used in an ephys experiment
Probe used in an extracellular ephys experiment

| Field | Type | Title (Description) |
|-------|------|-------------|
Expand All @@ -376,6 +376,17 @@ Module for inserted fiber photometry recording
| `fibers` | List[[FiberProbe](#fiberprobe)] | Probes that are held by this module |


### PatchClampEphysAssembly

Assembly combining a manipulator and headstage used for Patch clamp ephys

| Field | Type | Title (Description) |
|-------|------|-------------|
| `name` | `str` | Patch clamp assembly name |
| `manipulator` | [Manipulator](#manipulator) | Manipulator |
| `headstage` | [Device](#device) | Headstage |


### FiberPatchCord

Description of a patch cord
Expand Down
2 changes: 1 addition & 1 deletion docs/source/instrument.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ Description of an instrument
| `temperature_control` | `Optional[bool]` | Temperature control (Does the instrument maintain a constant temperature?) |
| `notes` | `Optional[str]` | Notes |
| `connections` | List[[Connection](components/connections.md#connection)] | Connections (List of all connections between devices in the instrument) |
| `components` | List[[Monitor](components/devices.md#monitor) or [Olfactometer](components/devices.md#olfactometer) or [LickSpout](components/devices.md#lickspout) or [LickSpoutAssembly](components/devices.md#lickspoutassembly) or [AirPuffDevice](components/devices.md#airpuffdevice) or [Speaker](components/devices.md#speaker) or [CameraAssembly](components/devices.md#cameraassembly) or [Enclosure](components/devices.md#enclosure) or [EphysAssembly](components/devices.md#ephysassembly) or [FiberAssembly](components/devices.md#fiberassembly) or [LaserAssembly](components/devices.md#laserassembly) or [FiberPatchCord](components/devices.md#fiberpatchcord) or [Laser](components/devices.md#laser) or [LightEmittingDiode](components/devices.md#lightemittingdiode) or [Lamp](components/devices.md#lamp) or [Detector](components/devices.md#detector) or [Camera](components/devices.md#camera) or [Objective](components/devices.md#objective) or [Scanner](components/devices.md#scanner) or [Filter](components/devices.md#filter) or [Lens](components/devices.md#lens) or [DigitalMicromirrorDevice](components/devices.md#digitalmicromirrordevice) or [PolygonalScanner](components/devices.md#polygonalscanner) or [PockelsCell](components/devices.md#pockelscell) or [HarpDevice](components/devices.md#harpdevice) or [NeuropixelsBasestation](components/devices.md#neuropixelsbasestation) or [OpenEphysAcquisitionBoard](components/devices.md#openephysacquisitionboard) or [MotorizedStage](components/devices.md#motorizedstage) or [ScanningStage](components/devices.md#scanningstage) or [AdditionalImagingDevice](components/devices.md#additionalimagingdevice) or [Disc](components/devices.md#disc) or [Wheel](components/devices.md#wheel) or [Tube](components/devices.md#tube) or [Treadmill](components/devices.md#treadmill) or [Arena](components/devices.md#arena) or [DAQDevice](components/devices.md#daqdevice) or [Computer](components/devices.md#computer) or [Microscope](components/devices.md#microscope) or [Device](components/devices.md#device)] | Components (List of all devices in the instrument) |
| `components` | List[[Monitor](components/devices.md#monitor) or [Olfactometer](components/devices.md#olfactometer) or [LickSpout](components/devices.md#lickspout) or [LickSpoutAssembly](components/devices.md#lickspoutassembly) or [AirPuffDevice](components/devices.md#airpuffdevice) or [Speaker](components/devices.md#speaker) or [CameraAssembly](components/devices.md#cameraassembly) or [Enclosure](components/devices.md#enclosure) or [EphysAssembly](components/devices.md#ephysassembly) or [FiberAssembly](components/devices.md#fiberassembly) or [LaserAssembly](components/devices.md#laserassembly) or [FiberPatchCord](components/devices.md#fiberpatchcord) or [Laser](components/devices.md#laser) or [LightEmittingDiode](components/devices.md#lightemittingdiode) or [Lamp](components/devices.md#lamp) or [Detector](components/devices.md#detector) or [Camera](components/devices.md#camera) or [Objective](components/devices.md#objective) or [Scanner](components/devices.md#scanner) or [Filter](components/devices.md#filter) or [Lens](components/devices.md#lens) or [DigitalMicromirrorDevice](components/devices.md#digitalmicromirrordevice) or [PatchClampEphysAssembly](components/devices.md#patchclampephysassembly) or [PolygonalScanner](components/devices.md#polygonalscanner) or [PockelsCell](components/devices.md#pockelscell) or [HarpDevice](components/devices.md#harpdevice) or [NeuropixelsBasestation](components/devices.md#neuropixelsbasestation) or [OpenEphysAcquisitionBoard](components/devices.md#openephysacquisitionboard) or [MotorizedStage](components/devices.md#motorizedstage) or [ScanningStage](components/devices.md#scanningstage) or [AdditionalImagingDevice](components/devices.md#additionalimagingdevice) or [Disc](components/devices.md#disc) or [Wheel](components/devices.md#wheel) or [Tube](components/devices.md#tube) or [Treadmill](components/devices.md#treadmill) or [Arena](components/devices.md#arena) or [DAQDevice](components/devices.md#daqdevice) or [Computer](components/devices.md#computer) or [Microscope](components/devices.md#microscope) or [Device](components/devices.md#device)] | Components (List of all devices in the instrument) |
12 changes: 10 additions & 2 deletions src/aind_data_schema/components/devices.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,14 +453,14 @@ class LaserAssembly(DataModel):


class EphysProbe(Device):
"""Probe used in an ephys experiment"""
"""Probe used in an extracellular ephys experiment"""

probe_model: ProbeModel = Field(..., title="Probe model")
headstage: Optional[Device] = Field(default=None, title="Headstage for this probe")


class EphysAssembly(DataModel):
"""Named assembly for combining a manipulator and ephys probes"""
"""Named assembly for combining a manipulator and extracellular ephys probes"""

name: str = Field(..., title="Ephys assembly name")
manipulator: Manipulator = Field(..., title="Manipulator")
Expand All @@ -487,6 +487,14 @@ class FiberAssembly(DataModel):
fibers: List[FiberProbe] = Field(..., title="Probes that are held by this module")


class PatchClampEphysAssembly(DataModel):
"""Assembly combining a manipulator and headstage used for Patch clamp ephys"""

name: str = Field(..., title="Patch clamp Assembly Name")
manipulator: Manipulator = Field(..., title="Manipulator")
headstage: Device = Field(..., title="Headstage")


class DigitalMicromirrorDevice(Device):
"""Description of a Digital Micromirror Device (DMD)"""

Expand Down
2 changes: 2 additions & 0 deletions src/aind_data_schema/core/instrument.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
Objective,
Olfactometer,
OpenEphysAcquisitionBoard,
PatchClampEphysAssembly,
PockelsCell,
PolygonalScanner,
Scanner,
Expand Down Expand Up @@ -142,6 +143,7 @@ class Instrument(DataCoreModel):
| Filter
| Lens
| DigitalMicromirrorDevice
| PatchClampEphysAssembly
| PolygonalScanner
| PockelsCell
| HarpDevice
Expand Down