Procedure log types

Entry schemas for procedure logs: measurements followed over time for one procedure.

Table of contents

  1. Impedances log
  2. Linear displacement log
  3. Tetrode adjustment log
  4. API access

Impedances log

Logs electrode impedance measurements per channel, with impedance and phase values, unit and measurement frequency, for example to track an implant over days.

FieldDescription
ImpedancesRequired. Multi-select. Impedance values ordered to correspond to the listed channels.
Impedance unitChoice. The unit shared by all impedance values in this log entry. Options: Ω, kΩ, MΩ.
Measurement frequencyQuantity with unit. The stimulus frequency used for the impedance measurement. Units: Hz, kHz.
Phases (°)Multi-select. Phase angles ordered to correspond to the listed channels.
List of channelsList of integers. Channel numbers corresponding by position to the impedance and phase arrays.

Linear displacement log

Logs the displacement of a movable implant at each log time, for example a probe advanced on a microdrive.

FieldDescription
DisplacementRequired. Quantity with unit. The signed or absolute displacement recorded at this log time. Units: nm, µm, mm, cm, m.

Tetrode adjustment log

Logs adjustments of individual tetrodes on a drive, with one row per tetrode moved at each log time.

FieldDescription
Tetrode adjustmentsRequired. Table of rows. One row per tetrode adjusted at this log time; tetrodes left untouched are omitted.
Tetrode adjustments › TetrodeRequired. Integer. Position of the tetrode on the drive, numbered from 1 as the lab labels it. Range: ≥ 1.
Tetrode adjustments › AdvanceRequired. Quantity with unit. How far the tetrode was moved in this adjustment, as a distance or as screw rotation; negative values retract. Units: µm, mm, turn, °.

API access

The same types are documented for API users, with property codes, versions and payload examples, on the ProcedureLog schemas API page.