Data acquisition types

Type-specific details of the data recorded in a session.

Table of contents

Audio and Behavior Tracking

Audio recordings and video or tracking data that capture the subject’s sounds and behavior.

Audio

A recorded sound signal, such as vocalizations or an acoustic monitor. Use this for the audio signal itself; a sound used as a stimulus is a Manipulation.

FieldDescription
File nameText. The name of the audio file including the extension (e.g., ‘track.mp3’). This identifies the file on storage media or file systems.
FormatText. The file format or container type of the audio file (e.g., MP3, WAV, AAC). Different formats may support various features like metadata, compression, and copyright management.
CompressionText. Describes whether the audio is compressed losslessly or lossily, and the type of compression used if applicable. This affects audio quality and file size.
Bit depthInteger. The number of bits of information in each sample, which determines the dynamic range and noise level of the audio. Common values are 8, 16, 24, or 32 bits. Range: ≥ 0.
CodecText. The codec used to encode or decode the audio (e.g., FLAC, ALAC, Opus). The choice of codec affects compatibility with playback devices and audio quality.
Number of channelsInteger. The number of separate audio channels (e.g., 1 for mono, 2 for stereo, more for surround sound configurations). This affects the spatial representation of sound. Range: ≥ 1.
Number of samplesInteger. The total number of audio samples in the file. This number, along with the sampling rate, can determine the total duration of the audio. Range: ≥ 0.
Sampling rateQuantity with unit. The sampling rate of the audio, which is the number of samples of audio carried per second. Units: GHz, MHz, kHz, Hz.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, Generic, Microphone.

Behavioral Tracking

Derived or processed tracking data: positions, markers, key points or poses produced by a tracking system such as an OptiTrack motion-capture rig or a pose-estimation pipeline. Use this when the stored stream is the processed points; the raw footage is Video tracking.

FieldDescription
File nameText. The name of the file containing behavioral tracking data, typically including the file extension (e.g., ‘session1.avi’).
FormatText. The video or data file format (e.g., MP4, AVI) used to store behavioral tracking information.
CompressionText. Type of compression used to reduce the file size of the behavioral tracking data, if applicable.
Number of framesInteger. Total number of frames included in the behavioral tracking session, which determines the total duration of the recorded data. Range: ≥ 0.
Vertical resolutionInteger. The number of vertical pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video. Range: ≥ 0.
Horizontal resolutionInteger. The number of horizontal pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video. Range: ≥ 0.
Frame rateQuantity with unit. The number of frames per second at which the behavioral data was recorded, affecting the smoothness and accuracy of motion analysis. Units: GHz, MHz, kHz, Hz.

Experimental interface types that can be linked: Camera, TrackingSystem.

Video Tracking

Raw video recorded to track a subject’s movements or behavior. Use this when the video itself is the stored data; processed points or trajectories derived from it are Behavioral tracking.

FieldDescription
File nameText. The name of the file containing behavioral tracking data, typically including the file extension (e.g., ‘session1.avi’).
FormatText. The video or data file format (e.g., MP4, AVI) used to store behavioral tracking information.
CompressionText. Type of compression used to reduce the file size of the behavioral tracking data, if applicable.
Number of framesInteger. Total number of frames included in the behavioral tracking session, which determines the total duration of the recorded data. Range: ≥ 0.
Vertical resolutionInteger. The number of vertical pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video. Range: ≥ 0.
Horizontal resolutionInteger. The number of horizontal pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video. Range: ≥ 0.
Frame rateQuantity with unit. The number of frames per second at which the behavioral data was recorded, affecting the smoothness and accuracy of motion analysis. Units: GHz, MHz, kHz, Hz.

Experimental interface types that can be linked: Camera, TrackingSystem.

Electrophysiology

Recordings of electrical activity, from scalp EEG and peripheral nerve signals to extracellular and intracellular recordings of neurons.

Electroencephalography (EEG)

Large-scale electrical activity recorded from electrodes on or beneath the skull rather than from within the tissue. Also use this type for ECoG surface arrays, or Extracellular Electrophysiology when a dense array is recorded on a probe system with electrode groups and channel tags.

FieldDescription
File nameText. The name of the file containing EEG data, typically including the file extension (e.g., ‘.edf’). This file stores brain wave patterns recorded during EEG sessions.
FormatText. The digital file format of the EEG data (e.g., EDF, BDF). This format determines how data is organized, stored, and how compatible it is with various EEG analysis software.
Data-typeText. Specifies the data type used to store the EEG signals (e.g., ‘int16’ for 16-bit integers), which impacts the data’s precision and storage size.
Number of channelsInteger. Number of separately recorded EEG channels. Range: ≥ 0.
Number of samplesInteger. The total number of data points recorded per channel, which determines the total duration of the EEG recording when combined with the sampling rate. Range: ≥ 0.
Sampling rateQuantity with unit. The frequency at which the EEG signals are sampled per second, crucial for capturing the temporal dynamics of brain activity. Higher rates provide more detailed time resolution. Units: GHz, MHz, kHz, Hz.
Least significant bitQuantity with unit. The smallest measurable change in voltage detectable by the EEG equipment, which affects the amplitude resolution of the recorded brain wave signals. Units: V, mV, µV, nV.
Electrode groupsTable of rows. Named channel groupings used to describe the recording layout.
Electrode groups › List of channelsList of integers. Channel numbers assigned to this electrode group.
Electrode groups › LabelText. A descriptive label for the electrode group, aiding in identifying the function or location of the group within the EEG setup.
Channel tagsTable of rows. Tags that associate recorded channels with roles or analysis groupings.
Channel tags › Channel tagText. A tag that categorizes or adds metadata to channels, helping to identify their roles or characteristics in the EEG data.
Channel tags › List of channelsList of integers. Channel numbers assigned to this channel tag.
Channel tags › Electrode groupsList of integers. Electrode-group numbers associated with this channel tag.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, EEG, ECoG, ReferenceElectrode, GroundElectrode.

Electroneurogram (ENG)

Electrical activity recorded from a peripheral nerve, typically through a nerve cuff or hook electrode.

FieldDescription
File nameText. The name of the file containing electroneurogram data, often indicating the type of neural activity recorded (e.g., ‘nerve_activity.edf’).
FormatText. The digital format of the electroneurogram data (e.g., CSV, EDF). This format dictates how the data can be accessed and analyzed using various software tools.
Data-typeText. Specifies the data type used to store the electrical signals from nerve activity (e.g., ‘int16’ for 16-bit integers), affecting the precision and size of the data.
Number of channelsInteger. The number of separate recording channels, each capturing signals from different nerves or different locations on a single nerve, enhancing the detail and scope of analysis. Range: ≥ 0.
Number of samplesInteger. The total number of data points collected per channel, determining the total duration of the recording when combined with the sampling rate. Range: ≥ 0.
Sampling rateQuantity with unit. The frequency at which the neural data is sampled, crucial for capturing the rapid electrical changes that occur during nerve activation. Units: GHz, MHz, kHz, Hz.
Least significant bitQuantity with unit. The smallest detectable change in signal by the recording system, affecting the amplitude resolution of the neural activity measurements. Units: V, mV, µV, nV.
Electrode groupsTable of rows. Named channel groupings used to describe the recording layout.
Electrode groups › List of channelsList of integers. Channel numbers assigned to this electrode group.
Electrode groups › LabelText. A label identifying the electrode group, useful for referencing during analysis or reporting.
Channel tagsTable of rows. Tags that associate recorded channels with roles or analysis groupings.
Channel tags › Channel tagText. A descriptive tag providing additional information about the role or characteristics of a channel in the recording setup.
Channel tags › List of channelsList of integers. Channel numbers assigned to this channel tag.
Channel tags › Electrode groupsList of integers. Electrode-group numbers associated with this channel tag.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, EMG, EEG, ReferenceElectrode, NerveCuff.

Extracellular Electrophysiology

Spiking and field activity recorded outside cells with a probe, tetrode, or wire electrode. This is the usual choice for silicon-probe and tetrode recordings.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the extracellular electrophysiology data (e.g., Binary, HDF5). This affects how the data can be accessed and analyzed using various software tools.
Data-typeText. Specifies the data type used to store the electrical signals (e.g., ‘int16’ for 16-bit integers), affecting the precision and size of the data.
Number of channelsInteger. The number of separate recording channels, each capturing signals from different parts of the extracellular space, influencing the spatial resolution of the activity mapping. Range: ≥ 0.
Number of samplesInteger. The total number of data points collected per channel, which determines the total duration of the recording when combined with the sampling rate. Range: ≥ 0.
Sampling rateQuantity with unit. The frequency at which the electrical signals are sampled per second, crucial for capturing the rapid changes that occur in neuronal activity. Units: GHz, MHz, kHz, Hz.
Least significant bitQuantity with unit. The smallest detectable change in voltage by the recording equipment, influencing the resolution and sensitivity of the measurements. Units: V, mV, µV, nV.
Electrode groupsTable of rows. Named channel groupings used to describe the recording layout.
Electrode groups › List of channelsList of integers. Channel numbers assigned to this electrode group.
Electrode groups › LabelText. A descriptive label for the electrode group, aiding in identifying the function or location of the group within the electrophysiological setup.
Channel tagsTable of rows. Tags that associate recorded channels with roles or analysis groupings.
Channel tags › Channel tagText. A descriptive tag providing additional information about the role or characteristics of a channel in the recording setup.
Channel tags › List of channelsList of integers. Channel numbers assigned to this channel tag.
Channel tags › Electrode groupsList of integers. Electrode-group numbers associated with this channel tag.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, MultiElectrodeArray, ECoG, ReferenceElectrode, GroundElectrode, TungstenMicroelectrode.

Intracellular Electrophysiology

Membrane potential or current recorded from inside a single cell, as in whole-cell patch or sharp-electrode recordings.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the intracellular electrophysiology data (e.g., ABF, DAT), which determines how data is organized, stored, and how compatible it is with various analysis software.
Data-typeText. Specifies the data type used to store the electrical signals (e.g., ‘int16’ for 16-bit integers), affecting the precision and size of the data.
Number of channelsInteger. The number of separate recording channels, each possibly recording from different cells or different parts of a cell, providing a comprehensive view of neural activity. Range: ≥ 0.
Number of samplesInteger. The total number of data points collected per channel, defining the duration and extent of the recording session when combined with the sampling rate. Range: ≥ 0.
Sampling rateQuantity with unit. The frequency at which the electrical signals inside the neuron are sampled per second, crucial for capturing the rapid changes in voltage that occur during neuronal activity. Units: GHz, MHz, kHz, Hz.
Least significant bitQuantity with unit. The smallest detectable change in signal by the recording system, impacting the amplitude resolution of the recorded signals and hence the detail of neuronal activity that can be analyzed. Units: V, mV, µV, nV.

Experimental interface types that can be linked: Tetrode, SingleWireElectrode, PatchPipette, ReferenceElectrode, GroundElectrode, TungstenMicroelectrode.

Optical Imaging

Fluorescence and optical recordings, from fiber photometry and miniscopes to confocal, light field and one-, two- and three-photon microscopy.

Confocal Microscopy

Imaging that rejects out-of-focus light with a pinhole to produce optical sections.

FieldDescription
File nameText. The name of the file containing confocal microscopy images, typically including the file extension (e.g., ‘.tif’).
FormatText. The digital format of the confocal microscopy data (e.g., TIFF, JPEG, or specialized microscopy formats), which affects the compatibility with analysis software.
CompressionText. Describes whether the image files are stored using lossless or lossy compression, which impacts file size and image quality.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, influencing the level of detail and clarity in the image. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, impacting the sharpness and granularity of the visual data. Range: ≥ 0.
Number of framesInteger. The total number of image frames captured during the confocal microscopy session, providing insight into the extent and duration of the observation. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which images are captured per second, important in time-lapse confocal microscopy to observe dynamic processes in live cells. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used in microscopy, which affects the intensity of light illuminating the sample and can influence the quality and depth of the images captured. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the fluorescent dyes within the sample, crucial for specific fluorescence imaging and contrast. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The depth within the sample that can be effectively imaged, key for examining three-dimensional structures within thick biological specimens. Units: m, cm, mm, µm, nm.
Voxel size (X dimension)Quantity with unit. The size of a single voxel along the X-axis, determining the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Y dimension)Quantity with unit. The size of a single voxel along the Y-axis, determining the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Z dimension)Quantity with unit. The size of a single voxel along the Z-axis, determining the spatial resolution of the image in that dimension and the depth of field possible in the imagery. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, GRINLens, Prism, Generic, MicroscopeObjective, CranialWindow.

Fiber Photometry

Bulk fluorescence collected through an implanted optical fiber. It yields a population signal rather than an image, so it has no resolution fields.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the fiber photometry data (e.g., CSV, TXT), affecting how data is stored, accessed, and analyzed.
CompressionText. Describes any compression applied to the fiber photometry data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of recorded frames, which determines the overall duration of the fluorescence recording. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which fluorescent signal data is recorded, measured in frames per second. Higher frame rates allow for more detailed temporal analysis of changes in neural activity. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during the fiber photometry recording. Laser power affects the intensity of the excitation light and can influence the fluorescence signal strength. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the fluorescent dye or protein in the study. Specific wavelengths are chosen based on the properties of the fluorescent markers used. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, GRINLens, Prism, Generic.

Light Field Microscopy

Imaging that captures the light field in one shot so a volume can be reconstructed without scanning. Choose it for volumetric single-shot acquisition rather than plane-by-plane imaging.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the light field microscopy data (e.g., TIFF, proprietary formats), which affects the accessibility and compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the microscopy data files, which can impact file size and potentially affect data quality and processing speed.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the captured images. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image. High resolution is crucial for detailed visualization of microscopic structures. Range: ≥ 0.
Number of framesInteger. The total number of recorded frames, which determines the overall duration of the imaging data and is critical for time-series analysis. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which images are captured per second, important for dynamic studies where motion within the sample is analyzed over time. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during imaging, which affects the intensity of the illumination and can influence the quality of the captured images. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the samples, selected based on the optical properties of the sample and the specific fluorescent dyes used. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The depth within the sample that can be effectively imaged, crucial for studies involving thick specimens or tissues. Units: m, cm, mm, µm, nm.
Voxel size (X dimension)Quantity with unit. The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Y dimension)Quantity with unit. The size of a single voxel along the Y-axis, influencing the spatial resolution of the image in that dimension and the detail of structural data. Units: m, cm, mm, µm, nm.
Voxel size (Z dimension)Quantity with unit. The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism.

Miniscope Microscopy

Imaging through a head-mounted miniature microscope in a freely moving subject, usually above a GRIN lens.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the Miniscope data (e.g., AVI, MOV), which affects the accessibility and compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the microscopy video files, which can impact file size and potentially affect video quality and processing speed.
Number of framesInteger. The total number of frames captured during the recording session, which determines the overall length of the video and the duration of the observed biological processes. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each frame, affecting the image quality and the detail visible in the video. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each frame, crucial for accurately capturing detailed features of the observed specimen. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which video frames are captured, measured in frames per second. Crucial for capturing the dynamic processes at cellular resolution in real time. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during imaging, influencing the intensity and depth of illumination, which is vital for enhancing image clarity and contrast in fluorescence-based applications. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. The depth within the tissue that the Miniscope can effectively image. This is crucial for targeting specific layers of neural circuits in the brain or other tissues. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism, Miniscope.

Single-Photon Microscopy

Widefield or epifluorescence imaging using single-photon excitation. Use this for conventional widefield calcium imaging.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the single-photon microscopy data (e.g., TIFF, JPEG), which affects the accessibility and compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen. Range: ≥ 0.
Number of framesInteger. The total number of frames captured during the recording session, which determines the overall length of the video and the duration of the observed biological processes. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which images are captured, measured in frames per second. Crucial for capturing dynamic processes at cellular resolution in real time. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during imaging, influencing the intensity and depth of illumination, which is vital for enhancing image clarity and contrast in fluorescence-based applications. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the samples, selected based on the optical properties of the sample and the specific fluorescent dyes used. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The depth within the sample that the microscope can effectively image. This is crucial for targeting specific layers of cellular structures in the tissue. Units: m, cm, mm, µm, nm.
Voxel size (X dimension)Quantity with unit. The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Y dimension)Quantity with unit. The size of a single voxel along the Y-axis, influencing the spatial resolution of the image in that dimension and the detail of structural data. Units: m, cm, mm, µm, nm.
Voxel size (Z dimension)Quantity with unit. The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism, Miniscope, WidefieldMacroscope.

Three-Photon Microscopy

Multiphoton imaging using three-photon excitation for greater depth and reduced background than two-photon imaging.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the three-photon microscopy data (e.g., TIFF, JPEG), which affects how data is organized, stored, and the compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen. Range: ≥ 0.
Number of framesInteger. The total number of frames captured during the imaging session, which determines the overall length of the video and the duration of the observed biological processes. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which images are captured, measured in frames per second. Important for studies involving dynamic biological processes. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during imaging, crucial for three-photon excitation to achieve effective depth penetration and image clarity. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the samples, crucial for achieving efficient three-photon excitation and optimizing fluorescence emission from deep tissue structures. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The depth within the sample that the microscope can effectively image, particularly important for deep tissue imaging with minimal light scattering. Units: m, cm, mm, µm, nm.
Voxel size (X dimension)Quantity with unit. The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Y dimension)Quantity with unit. The size of a single voxel along the Y-axis, influencing the spatial resolution of the image in that dimension and the detail of structural data. Units: m, cm, mm, µm, nm.
Voxel size (Z dimension)Quantity with unit. The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism.

Two-Photon Microscopy

Multiphoton imaging using two-photon excitation, the common choice for in-vivo cellular-resolution imaging.

FieldDescription
File nameText. The name of the file containing two-photon microscopy data, typically including the file extension. This file stores high-resolution images capable of deep tissue penetration with minimal photodamage.
FormatText. The digital format of the two-photon microscopy data (e.g., TIFF, JPEG), which determines how data is organized, stored, and the compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen. Range: ≥ 0.
Number of framesInteger. The total number of frames captured during the imaging session, which determines the overall length of the video and the duration of the observed biological processes. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which images are captured, measured in frames per second. Important for studies involving dynamic biological processes. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used during imaging, crucial for two-photon excitation to achieve effective depth penetration and image clarity. Units: kW, W, mW, µW.
Excitation wavelengthQuantity with unit. The wavelength of light used to excite the samples, crucial for achieving efficient two-photon excitation and optimizing fluorescence emission from deep tissue structures. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The depth within the sample that the microscope can effectively image, particularly important for deep tissue imaging with minimal light scattering. Units: m, cm, mm, µm, nm.
Voxel size (X dimension)Quantity with unit. The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension. Units: m, cm, mm, µm, nm.
Voxel size (Y dimension)Quantity with unit. The size of a single voxel along the Y-axis, influencing the spatial resolution of the image in that dimension and the detail of structural data. Units: m, cm, mm, µm, nm.
Voxel size (Z dimension)Quantity with unit. The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism.

Magnetic and Functional Imaging

Structural and functional magnetic resonance imaging and magnetoencephalography.

Functional Magnetic Resonance Imaging (fMRI)

MRI acquired as a time series to follow activity-related signal changes. Use plain MRI for structural scans.

FieldDescription
File nameText. The name of the file containing fMRI data, typically including the file extension (e.g., ‘.nii’). This data represents brain activity by detecting changes in blood flow.
FormatText. The digital format of the fMRI data (e.g., NIfTI, DICOM), which affects the accessibility and compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the fMRI data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of image frames, which determines the overall duration of the fMRI scan and the temporal resolution of the brain activity data. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image frame. Higher resolution allows for more detailed visualization of brain structures. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image frame. Like vertical resolution, it affects the clarity and detail of the displayed brain activity. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which fMRI images are captured, measured in frames per second. Important for studies involving time-series analysis of brain activity. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used, if applicable, in laser-enhanced fMRI procedures. This setting influences the intensity of light used during imaging. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. The depth within the brain that the fMRI can effectively image, important for targeting specific brain structures or layers. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, Generic.

Magnetic Resonance Imaging (MRI)

Structural or anatomical magnetic resonance imaging.

FieldDescription
File nameText. The name of the file containing MRI data, typically including the file extension (e.g., ‘.nii’ for NIfTI files). This file stores detailed images of organs and tissues.
FormatText. The digital format of the MRI data (e.g., DICOM, NIfTI), which determines how data is organized, stored, and how compatible it is with various imaging analysis software.
CompressionText. Describes any compression applied to the MRI data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of recorded frames, which determines the overall duration of the MRI scan and is critical for time-series analysis in functional MRI studies. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical structures visualized. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, which is crucial for accurately capturing the fine details of the tissues and structures being studied. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which MRI images are captured, measured in frames per second. This is crucial for dynamic studies, such as functional MRI, where changes over time are analyzed. Units: Hz, kHz, MHz, GHz.
Magnetic field strengthQuantity with unit. The strength of the static magnetic field (B0), measured in Tesla. Units: T, mT, µT.
Imaging depthQuantity with unit. The depth within the body that the MRI can effectively image. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, Generic.

Magnetoencephalography (MEG)

Magnetic fields produced by neural activity, recorded outside the head.

FieldDescription
File nameText. The name of the file containing magnetoencephalography data, usually including the file extension (e.g., ‘.fif’ for FIFF files). This file captures the magnetic fields produced by neural activity.
FormatText. The digital format of the MEG data (e.g., FIFF, DICOM), which determines how data is organized, stored, and how compatible it is with various analysis software.
CompressionText. Describes any compression applied to the MEG data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of frames recorded, determining the overall duration of the MEG recording session and the temporal resolution of the data. Range: ≥ 0.
Vertical resolutionInteger. The resolution of the sensor array in the vertical dimension, which impacts the precision of spatial localization of brain activity. Range: ≥ 0.
Horizontal resolutionInteger. The resolution of the sensor array in the horizontal dimension, important for detailed spatial mapping of neural activity across the scalp. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which MEG data is sampled, measured in frames per second. Crucial for capturing the rapid temporal dynamics of brain activity. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. Laser power is generally not applicable to MEG, as MEG does not use lasers for imaging. This field may be a placeholder or error in the schema. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. Depth of the brain region represented by the MEG measurement, when reported by the acquisition method. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, Generic.

Tomography and Ultrasound

Tomographic and ultrasound imaging, including CT, PET, SPECT, optical coherence tomography and functional ultrasound.

Computed Tomography (CT)

X-ray tomography, typically for skeletal or implant anatomy and implant verification.

FieldDescription
File nameText. The name of the file containing computed tomography scan data, usually including the file extension (e.g., ‘scan.dcm’). This identifies the specific scan file for reference or analysis.
FormatText. The digital file format of the CT images (e.g., DICOM). This format determines the compatibility with various viewing and processing software.
CompressionText. Describes the type of data compression used for the CT images, if any, which can affect the file size and image quality.
Number of framesInteger. Total number of image frames captured in a CT scan session. More frames can provide a more detailed view of the scanned area over time. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, which affects the clarity and detail of the vertical aspects of the CT images. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, impacting the sharpness and detail of the horizontal aspects of the CT images. Range: ≥ 0.
Frame rateQuantity with unit. The frame rate at which the CT scanner captures images per second. This is particularly relevant for dynamic studies such as perfusion scanning. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used, if applicable, in procedures associated with the CT scan, such as laser scanning CT, influencing the illumination and image clarity. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. The maximum depth at which the CT images provide usable data, important for understanding the penetration capability of the CT imaging. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, Generic.

Functional Ultrasound Imaging (fUS)

Ultrasound imaging of cerebral blood volume as an activity proxy.

FieldDescription
File nameText. The name of the file containing functional ultrasound imaging data, typically including the file extension (e.g., ‘.fus’). This file stores dynamic blood flow images within the brain or other organs.
FormatText. The digital format of the functional ultrasound imaging data (e.g., DICOM, proprietary formats), which affects the accessibility and compatibility with various imaging analysis software.
CompressionText. Describes any compression applied to the ultrasound data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of image frames captured during the ultrasound session. This number determines the overall duration of the imaging data and is critical for time-series analysis. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the imaging data. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image. Higher resolution allows for better visualization of physiological structures and flow patterns. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which ultrasound images are captured, measured in frames per second. This is crucial for capturing dynamic changes in blood flow and other physiological parameters. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. The power of the laser used in laser-enhanced ultrasound imaging. This setting influences the intensity and penetration of the ultrasound waves. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. The depth within the tissue that the ultrasound can effectively image. This is crucial for targeting specific anatomical features or regions within the organ being studied. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, UltrasoundTransducer.

Optical Coherence Tomography (OCT)

Interferometric depth-resolved optical imaging of tissue microstructure.

FieldDescription
File nameText. The name of the file containing optical coherence tomography data, typically including the file extension. OCT files store high-resolution cross-sectional images of tissue microstructure.
FormatText. The digital format of the OCT data (e.g., DICOM, OCT native format, TIFF)
CompressionText. Describes any compression applied to the OCT image files to reduce file size while preserving image quality for accurate analysis.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each OCT image. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each OCT image. Range: ≥ 0.
Number of framesInteger. The total number of frames captured during the OCT imaging session. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which OCT images are captured, measured in frames per second. Units: GHz, MHz, kHz, Hz.
Center wavelengthQuantity with unit. The central wavelength of the light source used in OCT, typically in the near-infrared range (800-1300 nm), which affects tissue penetration depth and image contrast. Units: m, cm, mm, µm, nm.
BandwidthQuantity with unit. The spectral bandwidth of the OCT light source, which determines the axial resolution of the system. Broader bandwidth provides better axial resolution. Units: m, cm, mm, µm, nm.
Imaging depthQuantity with unit. The maximum depth within the tissue that the OCT system can effectively image, typically ranging from hundreds of micrometers to a few millimeters depending on tissue properties. Units: m, cm, mm, µm, nm.
Axial resolutionQuantity with unit. The resolution along the depth direction (z-axis), determining the ability to distinguish between closely spaced structures in the depth dimension. Units: m, cm, mm, µm, nm.
Lateral resolutionQuantity with unit. The resolution in the scanning plane (x-y axes), determining the ability to distinguish between closely spaced features in the lateral dimensions. Units: m, cm, mm, µm, nm.
Scan patternText. The scanning pattern used for OCT imaging (e.g., raster scan, circular scan, radial scan), which affects the coverage area and acquisition speed.
Scan areaQuantity with unit. The total area covered by the OCT scan, typically measured in square millimeters, defining the field of view for the imaging session. Units: m², cm², mm², µm², nm².
Number of averagesInteger. The number of repeat measurements averaged to improve signal-to-noise ratio and image quality, with more averages providing cleaner but slower acquisition. Range: ≥ 0.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic, GRINLens, Prism.

Positron Emission Tomography (PET)

Imaging of an injected radiotracer’s distribution, used for metabolic and receptor mapping.

FieldDescription
File nameText. The name of the file containing PET scan data, typically including the file extension (e.g., ‘.pet’). PET scans are advanced imaging tests that show how organs and tissues are functioning.
FormatText. The digital format of the PET scan data (e.g., DICOM), which determines how data is organized, stored, and how compatible it is with various imaging analysis software.
CompressionText. Describes any compression applied to the PET scan data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of frames captured during the PET scan, which determines the overall duration of the scan and is critical for time-series analysis of metabolic activity. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical and functional visualization. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, which is crucial for accurately capturing detailed features of metabolic and physiological processes. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which PET scan images are captured, measured in frames per second. This is crucial for capturing dynamic changes in tracer distribution and metabolism over time. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. Laser power is not applicable to PET imaging as it does not use lasers for imaging. This field may be a placeholder or error in the schema. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. In PET imaging, imaging depth is not measured in micrometers but is rather about the penetration of the gamma rays emitted by the radiotracers, which can image the entire body or targeted organs. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic.

Single-Photon Emission Computed Tomography (SPECT)

Gamma-emitting radiotracer tomography. It is distinct from PET in tracer and detector, not in what the row records.

FieldDescription
File nameText. Name of the data file, including its extension.
FormatText. The digital format of the SPECT scan data (e.g., DICOM), which determines how data is organized, stored, and how compatible it is with various imaging analysis software.
CompressionText. Describes any compression applied to the SPECT scan data files, which can impact file size and potentially affect data quality and processing speed.
Number of framesInteger. The total number of frames captured during the SPECT scan, which determines the overall duration of the scan and is critical for time-series analysis of metabolic activity. Range: ≥ 0.
Vertical resolutionInteger. The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical and functional visualization. Range: ≥ 0.
Horizontal resolutionInteger. The number of pixels in the horizontal dimension of each image, which is crucial for accurately capturing detailed features of metabolic and physiological processes. Range: ≥ 0.
Frame rateQuantity with unit. The rate at which SPECT images are captured, measured in frames per second. This is crucial for capturing dynamic changes in tracer distribution and metabolism over time. Units: GHz, MHz, kHz, Hz.
Laser powerQuantity with unit. Laser power is generally not applicable to SPECT as it does not use lasers for imaging. This field may be a placeholder or error in the schema. Units: kW, W, mW, µW.
Imaging depthQuantity with unit. In SPECT imaging, imaging depth is not measured in micrometers but is rather about the penetration of gamma rays emitted by the radiotracers, which can image the entire body or targeted organs. Units: m, cm, mm, µm, nm.

Experimental interface types that can be linked: OpticFiber, CranialWindow, MicroscopeObjective, Generic.

General and Time-Series Data

Sampled signals that no more specific acquisition type covers, such as analog inputs and sensor streams.

General time-series

Use this catch-all for a sampled signal that no specific method above describes, such as a temperature, force, or auxiliary sensor trace. Describe the signal and its source in Notes, because the type name alone will not tell another user what was recorded.

FieldDescription
File nameText. The name of the file containing time series data, typically including the file extension (e.g., ‘.csv’). This file stores a series of data points indexed in time order.
FormatText. The digital format of the time series data (e.g., CSV, JSON), which affects how the data can be accessed, processed, and analyzed.
Data-typeText. Specifies the data type used to store the time series values (e.g., ‘int16’ for 16-bit integers), influencing data precision and storage size.
Number of channelsInteger. The number of separate data channels recorded, each possibly representing different variables or sensors, enhancing the complexity and multidimensionality. Range: ≥ 0.
Number of samplesInteger. The total number of data points recorded, defining the length of the time series. Range: ≥ 0.
Sampling rateQuantity with unit. The frequency at which data points are recorded per second, crucial for determining the temporal resolution of the time series. Units: GHz, MHz, kHz, Hz.
Least significant bitQuantity with unit. The smallest measurable change in data by the recording system, impacting the amplitude resolution of the recorded signals. Units: V, mV, µV, nV.
Electrode groupsTable of rows. Named channel groupings used to describe the recording layout.
Electrode groups › List of channelsList of integers. Channel numbers assigned to this electrode group.
Electrode groups › LabelText. A label for the electrode group, helping to categorize or identify the group based on its function or location.
Channel tagsTable of rows. Tags that associate recorded channels with roles or analysis groupings.
Channel tags › Channel tagText. A tag providing additional information or categorization for the channels, useful in data analysis and interpretation.
Channel tags › List of channelsList of integers. Channel numbers assigned to this channel tag.
Channel tags › Electrode groupsList of integers. Electrode-group numbers associated with this channel tag.

Experimental interface types that can be linked: SiliconProbe, Tetrode, SingleWireElectrode, MultiElectrodeArray, OpticFiber, EMG, EEG, ECoG, ReferenceElectrode, PatchPipette, ECG, NerveCuff, GroundElectrode, GRINLens, Prism, MicroscopeObjective, Miniscope, CranialWindow, Camera, Microphone, TrackingSystem, InjectionCannula, MicroperfusionLine, BathPerfusion, DrugDeliveryLine, Catheter, StimulatingElectrode, UltrasoundTransducer, ThermalProbe, TMSCoil, Generic, BloodPressureSensor, RespiratorySensor, Headcap, Headpost, TactileStimulator, VisualStimulator, AuditoryStimulator, Olfactometer, LEDArray, OsmoticPump, TungstenMicroelectrode, WidefieldMacroscope.

API access

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