DataAcquisition schemas

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

Table of contents

  1. How to use this family
  2. Quick type map
  3. Audio and Behavior Tracking
    1. Audio
    2. Behavioral Tracking
    3. Video Tracking
  4. Electrophysiology
    1. Electroencephalography (EEG)
    2. Electroneurogram (ENG)
    3. Extracellular Electrophysiology
    4. Intracellular Electrophysiology
  5. Optical Imaging
    1. Confocal Microscopy
    2. Fiber Photometry
    3. Light Field Microscopy
    4. Miniscope Microscopy
    5. Single-Photon Microscopy
    6. Three-Photon Microscopy
    7. Two-Photon Microscopy
  6. Magnetic and Functional Imaging
    1. Functional Magnetic Resonance Imaging (fMRI)
    2. Magnetic Resonance Imaging (MRI)
    3. Magnetoencephalography (MEG)
  7. Tomography and Ultrasound
    1. Computed Tomography (CT)
    2. Functional Ultrasound Imaging (fUS)
    3. Optical Coherence Tomography (OCT)
    4. Positron Emission Tomography (PET)
    5. Single-Photon Emission Computed Tomography (SPECT)
  8. General and Time-Series Data
    1. General time-series

How to use this family

  • dataacquisition: set type to a type code below and send its properties in details.
  • dataacquisitiontemplate: set type to a type code below and send its properties in details.
  • Every version is published at https://www.brainstem.org/schemas/DataAcquisition/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/DataAcquisition/<Type>.json is the current version and https://www.brainstem.org/schemas/DataAcquisition/<Type>/ lists the versions. See Public schemas.
  • Quantities are objects {"value": <number>, "unit": "<code>"}. Property paths with [] are inside a repeatable list of rows. The server sets the schema version field itself.

Quick type map

Type codeTitleGroupVersionRequired propertiesSchema
AudioAudioAudio and Behavior Tracking1.1.1none1.1.1.json
BehavioralTrackingBehavioral TrackingAudio and Behavior Tracking1.1.1none1.1.1.json
ComputedTomographyComputed Tomography (CT)Tomography and Ultrasound1.1.1none1.1.1.json
ConfocalMicroscopyConfocal MicroscopyOptical Imaging1.1.1none1.1.1.json
ElectroencephalographyElectroencephalography (EEG)Electrophysiology1.1.2none1.1.2.json
ElectroneurogramElectroneurogram (ENG)Electrophysiology1.1.1none1.1.1.json
ExtracellularEphysExtracellular ElectrophysiologyElectrophysiology1.1.2none1.1.2.json
FiberPhotometryFiber PhotometryOptical Imaging1.1.2none1.1.2.json
FunctionalMagneticResonanceImagingFunctional Magnetic Resonance Imaging (fMRI)Magnetic and Functional Imaging1.1.1none1.1.1.json
FunctionalUltrasoundImagingFunctional Ultrasound Imaging (fUS)Tomography and Ultrasound1.1.1none1.1.1.json
GeneralTimeSeriesGeneral time-seriesGeneral and Time-Series Data1.1.1none1.1.1.json
IntracellularEphysIntracellular ElectrophysiologyElectrophysiology1.1.2none1.1.2.json
LightFieldMicroscopyLight Field MicroscopyOptical Imaging1.1.2none1.1.2.json
MagneticResonanceImagingMagnetic Resonance Imaging (MRI)Magnetic and Functional Imaging1.1.1none1.1.1.json
MagnetoencephalographyMagnetoencephalography (MEG)Magnetic and Functional Imaging1.1.2none1.1.2.json
MiniscopeMiniscope MicroscopyOptical Imaging1.1.2none1.1.2.json
OpticalCoherenceTomographyOptical Coherence Tomography (OCT)Tomography and Ultrasound1.1.1none1.1.1.json
PositronEmissionTomographyPositron Emission Tomography (PET)Tomography and Ultrasound1.1.1none1.1.1.json
SinglePhotonEmissionComputedTomographySingle-Photon Emission Computed Tomography (SPECT)Tomography and Ultrasound1.1.2none1.1.2.json
SinglePhotonMicroscopySingle-Photon MicroscopyOptical Imaging1.1.2none1.1.2.json
ThreePhotonMicroscopyThree-Photon MicroscopyOptical Imaging1.1.2none1.1.2.json
TwoPhotonMicroscopyTwo-Photon MicroscopyOptical Imaging1.1.1none1.1.1.json
VideoTrackingVideo TrackingAudio and Behavior Tracking1.1.1none1.1.1.json

Audio and Behavior Tracking

Audio

  • type code Audio · version 1.1.1 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  The name of the audio file including the extension (e.g., ‘track.mp3’). This identifies the file on storage media or file systems.
formatFormattext  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.
compressionCompressiontext  Describes whether the audio is compressed losslessly or lossily, and the type of compression used if applicable. This affects audio quality and file size.
bitDepthBit depthinteger ≥ 0; default 8The 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.
codecCodectext  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.
nChannelsNumber of channelsinteger ≥ 1; default 2The 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.
nSamplesNumber of samplesinteger ≥ 0The total number of audio samples in the file. This number, along with the sampling rate, can determine the total duration of the audio.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The sampling rate of the audio, which is the number of samples of audio carried per second.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Behavioral Tracking

  • type code BehavioralTracking · version 1.1.1 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  The name of the file containing behavioral tracking data, typically including the file extension (e.g., ‘session1.avi’).
formatFormattext  The video or data file format (e.g., MP4, AVI) used to store behavioral tracking information.
compressionCompressiontext  Type of compression used to reduce the file size of the behavioral tracking data, if applicable.
nFramesNumber of framesinteger ≥ 0Total number of frames included in the behavioral tracking session, which determines the total duration of the recorded data.
verticalResolutionVertical resolutioninteger ≥ 0The number of vertical pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of horizontal pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The number of frames per second at which the behavioral data was recorded, affecting the smoothness and accuracy of motion analysis.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}
  • interfaces accepts ExperimentalInterface types: Camera, TrackingSystem; other values are refused (400).

Video Tracking

  • type code VideoTracking · version 1.1.1 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  The name of the file containing behavioral tracking data, typically including the file extension (e.g., ‘session1.avi’).
formatFormattext  The video or data file format (e.g., MP4, AVI) used to store behavioral tracking information.
compressionCompressiontext  Type of compression used to reduce the file size of the behavioral tracking data, if applicable.
nFramesNumber of framesinteger ≥ 0Total number of frames included in the behavioral tracking session, which determines the total duration of the recorded data.
verticalResolutionVertical resolutioninteger ≥ 0The number of vertical pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of horizontal pixels in each frame, which affects the clarity and detail visible in the behavioral tracking video.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The number of frames per second at which the behavioral data was recorded, affecting the smoothness and accuracy of motion analysis.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}
  • interfaces accepts ExperimentalInterface types: Camera, TrackingSystem; other values are refused (400).

Electrophysiology

Electroencephalography (EEG)

  • type code Electroencephalography · version 1.1.2 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
typeData-typetext default "int16"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.
nChannelsNumber of channelsinteger ≥ 0Number of separately recorded EEG channels.
nSamplesNumber of samplesinteger ≥ 0The total number of data points recorded per channel, which determines the total duration of the EEG recording when combined with the sampling rate.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"value": 20000, "unit": "Hz"}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.
lsbLeast significant bitquantity with unit units V, mV, µV, nV; default {"unit": "µV"}The smallest measurable change in voltage detectable by the EEG equipment, which affects the amplitude resolution of the recorded brain wave signals.
electrodeGroupsElectrode groupstable of rows format tableNamed channel groupings used to describe the recording layout.
electrodeGroups[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this electrode group.
electrodeGroups[].labelLabeltext  A descriptive label for the electrode group, aiding in identifying the function or location of the group within the EEG setup.
channelTagsChannel tagstable of rows format tableTags that associate recorded channels with roles or analysis groupings.
channelTags[].tagChannel tagtext  A tag that categorizes or adds metadata to channels, helping to identify their roles or characteristics in the EEG data.
channelTags[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this channel tag.
channelTags[].groupsElectrode groupslist of integers format comma-separated-integersElectrode-group numbers associated with this channel tag.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Electroneurogram (ENG)

  • type code Electroneurogram · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  The name of the file containing electroneurogram data, often indicating the type of neural activity recorded (e.g., ‘nerve_activity.edf’).
formatFormattext  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.
typeData-typetext default "int16"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.
nChannelsNumber of channelsinteger ≥ 0The 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.
nSamplesNumber of samplesinteger ≥ 0The total number of data points collected per channel, determining the total duration of the recording when combined with the sampling rate.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"value": 20000, "unit": "Hz"}The frequency at which the neural data is sampled, crucial for capturing the rapid electrical changes that occur during nerve activation.
lsbLeast significant bitquantity with unit units V, mV, µV, nV; default {"unit": "µV"}The smallest detectable change in signal by the recording system, affecting the amplitude resolution of the neural activity measurements.
electrodeGroupsElectrode groupstable of rows format tableNamed channel groupings used to describe the recording layout.
electrodeGroups[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this electrode group.
electrodeGroups[].labelLabeltext  A label identifying the electrode group, useful for referencing during analysis or reporting.
channelTagsChannel tagstable of rows format tableTags that associate recorded channels with roles or analysis groupings.
channelTags[].tagChannel tagtext  A descriptive tag providing additional information about the role or characteristics of a channel in the recording setup.
channelTags[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this channel tag.
channelTags[].groupsElectrode groupslist of integers format comma-separated-integersElectrode-group numbers associated with this channel tag.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Extracellular Electrophysiology

  • type code ExtracellularEphys · version 1.1.2 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  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.
typeData-typetext default "int16"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.
nChannelsNumber of channelsinteger ≥ 0The number of separate recording channels, each capturing signals from different parts of the extracellular space, influencing the spatial resolution of the activity mapping.
nSamplesNumber of samplesinteger ≥ 0The total number of data points collected per channel, which determines the total duration of the recording when combined with the sampling rate.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The frequency at which the electrical signals are sampled per second, crucial for capturing the rapid changes that occur in neuronal activity.
lsbLeast significant bitquantity with unit units V, mV, µV, nV; default {"unit": "µV"}The smallest detectable change in voltage by the recording equipment, influencing the resolution and sensitivity of the measurements.
electrodeGroupsElectrode groupstable of rows format tableNamed channel groupings used to describe the recording layout.
electrodeGroups[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this electrode group.
electrodeGroups[].labelLabeltext  A descriptive label for the electrode group, aiding in identifying the function or location of the group within the electrophysiological setup.
channelTagsChannel tagstable of rows format tableTags that associate recorded channels with roles or analysis groupings.
channelTags[].tagChannel tagtext  A descriptive tag providing additional information about the role or characteristics of a channel in the recording setup.
channelTags[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this channel tag.
channelTags[].groupsElectrode groupslist of integers format comma-separated-integersElectrode-group numbers associated with this channel tag.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Intracellular Electrophysiology

  • type code IntracellularEphys · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  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.
typeData-typetext default "int16"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.
nChannelsNumber of channelsinteger ≥ 0The number of separate recording channels, each possibly recording from different cells or different parts of a cell, providing a comprehensive view of neural activity.
nSamplesNumber of samplesinteger ≥ 0The total number of data points collected per channel, defining the duration and extent of the recording session when combined with the sampling rate.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
lsbLeast significant bitquantity with unit units V, mV, µV, nV; default {"unit": "µV"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Optical Imaging

Confocal Microscopy

  • type code ConfocalMicroscopy · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  The name of the file containing confocal microscopy images, typically including the file extension (e.g., ‘.tif’).
formatFormattext  The digital format of the confocal microscopy data (e.g., TIFF, JPEG, or specialized microscopy formats), which affects the compatibility with analysis software.
compressionCompressiontext  Describes whether the image files are stored using lossless or lossy compression, which impacts file size and image quality.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, influencing the level of detail and clarity in the image.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, impacting the sharpness and granularity of the visual data.
nFramesNumber of framesinteger ≥ 0The total number of image frames captured during the confocal microscopy session, providing insight into the extent and duration of the observation.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which images are captured per second, important in time-lapse confocal microscopy to observe dynamic processes in live cells.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The wavelength of light used to excite the fluorescent dyes within the sample, crucial for specific fluorescence imaging and contrast.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the sample that can be effectively imaged, key for examining three-dimensional structures within thick biological specimens.
xVoxelSizeVoxel size (X dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the X-axis, determining the spatial resolution of the image in that dimension.
yVoxelSizeVoxel size (Y dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the Y-axis, determining the spatial resolution of the image in that dimension.
zVoxelSizeVoxel size (Z dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Fiber Photometry

  • type code FiberPhotometry · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  The digital format of the fiber photometry data (e.g., CSV, TXT), affecting how data is stored, accessed, and analyzed.
compressionCompressiontext  Describes any compression applied to the fiber photometry data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The total number of recorded frames, which determines the overall duration of the fluorescence recording.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Light Field Microscopy

  • type code LightFieldMicroscopy · version 1.1.2 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the microscopy data files, which can impact file size and potentially affect data quality and processing speed.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the captured images.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image. High resolution is crucial for detailed visualization of microscopic structures.
nFramesNumber of framesinteger ≥ 0The total number of recorded frames, which determines the overall duration of the imaging data and is critical for time-series analysis.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which images are captured per second, important for dynamic studies where motion within the sample is analyzed over time.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}The power of the laser used during imaging, which affects the intensity of the illumination and can influence the quality of the captured images.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The wavelength of light used to excite the samples, selected based on the optical properties of the sample and the specific fluorescent dyes used.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the sample that can be effectively imaged, crucial for studies involving thick specimens or tissues.
xVoxelSizeVoxel size (X dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension.
yVoxelSizeVoxel size (Y dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.
zVoxelSizeVoxel size (Z dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Miniscope Microscopy

  • type code Miniscope · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  The digital format of the Miniscope data (e.g., AVI, MOV), which affects the accessibility and compatibility with various imaging analysis software.
compressionCompressiontext  Describes any compression applied to the microscopy video files, which can impact file size and potentially affect video quality and processing speed.
nFramesNumber of framesinteger ≥ 0The 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.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each frame, affecting the image quality and the detail visible in the video.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each frame, crucial for accurately capturing detailed features of the observed specimen.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Single-Photon Microscopy

  • type code SinglePhotonMicroscopy · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  The digital format of the single-photon microscopy data (e.g., TIFF, JPEG), which affects the accessibility and compatibility with various imaging analysis software.
compressionCompressiontext  Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen.
nFramesNumber of framesinteger ≥ 0The 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.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which images are captured, measured in frames per second. Crucial for capturing dynamic processes at cellular resolution in real time.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The wavelength of light used to excite the samples, selected based on the optical properties of the sample and the specific fluorescent dyes used.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the sample that the microscope can effectively image. This is crucial for targeting specific layers of cellular structures in the tissue.
xVoxelSizeVoxel size (X dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension.
yVoxelSizeVoxel size (Y dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.
zVoxelSizeVoxel size (Z dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Three-Photon Microscopy

  • type code ThreePhotonMicroscopy · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen.
nFramesNumber of framesinteger ≥ 0The 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.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which images are captured, measured in frames per second. Important for studies involving dynamic biological processes.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}The power of the laser used during imaging, crucial for three-photon excitation to achieve effective depth penetration and image clarity.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The wavelength of light used to excite the samples, crucial for achieving efficient three-photon excitation and optimizing fluorescence emission from deep tissue structures.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the sample that the microscope can effectively image, particularly important for deep tissue imaging with minimal light scattering.
xVoxelSizeVoxel size (X dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension.
yVoxelSizeVoxel size (Y dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.
zVoxelSizeVoxel size (Z dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Two-Photon Microscopy

  • type code TwoPhotonMicroscopy · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the microscopy image files, which can impact file size and potentially affect image quality and processing speed.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the image quality and the detail visible in the microscopy data.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, crucial for accurately capturing detailed features of the observed specimen.
nFramesNumber of framesinteger ≥ 0The 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.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which images are captured, measured in frames per second. Important for studies involving dynamic biological processes.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}The power of the laser used during imaging, crucial for two-photon excitation to achieve effective depth penetration and image clarity.
excitationWavelengthExcitation wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The wavelength of light used to excite the samples, crucial for achieving efficient two-photon excitation and optimizing fluorescence emission from deep tissue structures.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the sample that the microscope can effectively image, particularly important for deep tissue imaging with minimal light scattering.
xVoxelSizeVoxel size (X dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the X-axis, which affects the spatial resolution of the image in that dimension.
yVoxelSizeVoxel size (Y dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.
zVoxelSizeVoxel size (Z dimension)quantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The size of a single voxel along the Z-axis, determining the depth resolution of the image and aiding in three-dimensional reconstructions.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Magnetic and Functional Imaging

Functional Magnetic Resonance Imaging (fMRI)

  • type code FunctionalMagneticResonanceImaging · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  The digital format of the fMRI data (e.g., NIfTI, DICOM), which affects the accessibility and compatibility with various imaging analysis software.
compressionCompressiontext  Describes any compression applied to the fMRI data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The total number of image frames, which determines the overall duration of the fMRI scan and the temporal resolution of the brain activity data.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image frame. Higher resolution allows for more detailed visualization of brain structures.
horizontalResolutionHorizontal resolutioninteger ≥ 0The 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.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which fMRI images are captured, measured in frames per second. Important for studies involving time-series analysis of brain activity.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}The power of the laser used, if applicable, in laser-enhanced fMRI procedures. This setting influences the intensity of light used during imaging.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The depth within the brain that the fMRI can effectively image, important for targeting specific brain structures or layers.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}
  • interfaces accepts ExperimentalInterface types: OpticFiber, Generic; other values are refused (400).

Magnetic Resonance Imaging (MRI)

  • type code MagneticResonanceImaging · version 1.1.1 · schema

Structural or anatomical magnetic resonance imaging.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the MRI data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The 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.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical structures visualized.
horizontalResolutionHorizontal resolutioninteger ≥ 0The 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.
frameRateFrame ratequantity with unit units Hz, kHz, MHz, GHz; default {"unit": "Hz"}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.
magneticFieldStrengthMagnetic field strengthquantity with unit units T, mT, µT; default {"unit": "T"}The strength of the static magnetic field (B0), measured in Tesla.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "mm"}The depth within the body that the MRI can effectively image.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}
  • interfaces accepts ExperimentalInterface types: OpticFiber, Generic; other values are refused (400).

Magnetoencephalography (MEG)

  • type code Magnetoencephalography · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the MEG data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The total number of frames recorded, determining the overall duration of the MEG recording session and the temporal resolution of the data.
verticalResolutionVertical resolutioninteger ≥ 0The resolution of the sensor array in the vertical dimension, which impacts the precision of spatial localization of brain activity.
horizontalResolutionHorizontal resolutioninteger ≥ 0The resolution of the sensor array in the horizontal dimension, important for detailed spatial mapping of neural activity across the scalp.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which MEG data is sampled, measured in frames per second. Crucial for capturing the rapid temporal dynamics of brain activity.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}Depth of the brain region represented by the MEG measurement, when reported by the acquisition method.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}
  • interfaces accepts ExperimentalInterface types: OpticFiber, Generic; other values are refused (400).

Tomography and Ultrasound

Computed Tomography (CT)

  • type code ComputedTomography · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  The digital file format of the CT images (e.g., DICOM). This format determines the compatibility with various viewing and processing software.
compressionCompressiontext  Describes the type of data compression used for the CT images, if any, which can affect the file size and image quality.
nFramesNumber of framesinteger ≥ 0Total number of image frames captured in a CT scan session. More frames can provide a more detailed view of the scanned area over time.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, which affects the clarity and detail of the vertical aspects of the CT images.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, impacting the sharpness and detail of the horizontal aspects of the CT images.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The frame rate at which the CT scanner captures images per second. This is particularly relevant for dynamic studies such as perfusion scanning.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The maximum depth at which the CT images provide usable data, important for understanding the penetration capability of the CT imaging.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Functional Ultrasound Imaging (fUS)

  • type code FunctionalUltrasoundImaging · version 1.1.1 · schema

Ultrasound imaging of cerebral blood volume as an activity proxy.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the ultrasound data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The 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.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the imaging data.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image. Higher resolution allows for better visualization of physiological structures and flow patterns.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}The power of the laser used in laser-enhanced ultrasound imaging. This setting influences the intensity and penetration of the ultrasound waves.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Optical Coherence Tomography (OCT)

  • type code OpticalCoherenceTomography · version 1.1.1 · schema

Interferometric depth-resolved optical imaging of tissue microstructure.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  The digital format of the OCT data (e.g., DICOM, OCT native format, TIFF)
compressionCompressiontext  Describes any compression applied to the OCT image files to reduce file size while preserving image quality for accurate analysis.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each OCT image.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each OCT image.
nFramesNumber of framesinteger ≥ 0The total number of frames captured during the OCT imaging session.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The rate at which OCT images are captured, measured in frames per second.
centerWavelengthCenter wavelengthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}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.
bandwidthBandwidthquantity with unit units m, cm, mm, µm, nm; default {"unit": "nm"}The spectral bandwidth of the OCT light source, which determines the axial resolution of the system. Broader bandwidth provides better axial resolution.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.
axialResolutionAxial resolutionquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The resolution along the depth direction (z-axis), determining the ability to distinguish between closely spaced structures in the depth dimension.
lateralResolutionLateral resolutionquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}The resolution in the scanning plane (x-y axes), determining the ability to distinguish between closely spaced features in the lateral dimensions.
scanPatternScan patterntext  The scanning pattern used for OCT imaging (e.g., raster scan, circular scan, radial scan), which affects the coverage area and acquisition speed.
scanAreaScan areaquantity with unit units m², cm², mm², µm², nm²; default {"unit": "mm²"}The total area covered by the OCT scan, typically measured in square millimeters, defining the field of view for the imaging session.
averagesNumber of averagesinteger ≥ 0The number of repeat measurements averaged to improve signal-to-noise ratio and image quality, with more averages providing cleaner but slower acquisition.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Positron Emission Tomography (PET)

  • type code PositronEmissionTomography · version 1.1.1 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the PET scan data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The 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.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical and functional visualization.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, which is crucial for accurately capturing detailed features of metabolic and physiological processes.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

Single-Photon Emission Computed Tomography (SPECT)

  • type code SinglePhotonEmissionComputedTomography · version 1.1.2 · schema

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

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile nametext  Name of the data file, including its extension.
formatFormattext  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.
compressionCompressiontext  Describes any compression applied to the SPECT scan data files, which can impact file size and potentially affect data quality and processing speed.
nFramesNumber of framesinteger ≥ 0The 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.
verticalResolutionVertical resolutioninteger ≥ 0The number of pixels in the vertical dimension of each image, affecting the clarity and detail of the anatomical and functional visualization.
horizontalResolutionHorizontal resolutioninteger ≥ 0The number of pixels in the horizontal dimension of each image, which is crucial for accurately capturing detailed features of metabolic and physiological processes.
frameRateFrame ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}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.
laserPowerLaser powerquantity with unit units kW, W, mW, µW; default {"unit": "mW"}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.
imagingDepthImaging depthquantity with unit units m, cm, mm, µm, nm; default {"unit": "µm"}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.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}

General and Time-Series Data

General time-series

  • type code GeneralTimeSeries · version 1.1.1 · schema

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.

PropertyTitleShapeRequiredAllowed valuesMeaning
fileNameFile 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.
formatFormattext  The digital format of the time series data (e.g., CSV, JSON), which affects how the data can be accessed, processed, and analyzed.
typeData-typetext default "int16"Specifies the data type used to store the time series values (e.g., ‘int16’ for 16-bit integers), influencing data precision and storage size.
nChannelsNumber of channelsinteger ≥ 0The number of separate data channels recorded, each possibly representing different variables or sensors, enhancing the complexity and multidimensionality.
nSamplesNumber of samplesinteger ≥ 0The total number of data points recorded, defining the length of the time series.
srSampling ratequantity with unit units GHz, MHz, kHz, Hz; default {"unit": "Hz"}The frequency at which data points are recorded per second, crucial for determining the temporal resolution of the time series.
lsbLeast significant bitquantity with unit units V, mV, µV, nV; default {"unit": "µV"}The smallest measurable change in data by the recording system, impacting the amplitude resolution of the recorded signals.
electrodeGroupsElectrode groupstable of rows format tableNamed channel groupings used to describe the recording layout.
electrodeGroups[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this electrode group.
electrodeGroups[].labelLabeltext  A label for the electrode group, helping to categorize or identify the group based on its function or location.
channelTagsChannel tagstable of rows format tableTags that associate recorded channels with roles or analysis groupings.
channelTags[].tagChannel tagtext  A tag providing additional information or categorization for the channels, useful in data analysis and interpretation.
channelTags[].channelsList of channelslist of integers format comma-separated-integersChannel numbers assigned to this channel tag.
channelTags[].groupsElectrode groupslist of integers format comma-separated-integersElectrode-group numbers associated with this channel tag.

Illustrative payload:

{
    "fileName": "text",
    "format": "text"
}