Manipulation schemas

Type-specific details of manipulations applied during a session.

Table of contents

  1. How to use this family
  2. Quick type map
  3. Electrical and Magnetic Stimulation
    1. Deep brain stimulation (DBS)
    2. Electrical stimulation
    3. Electromagnetic field stimulation
    4. Transcranial electrical stimulation
    5. Transcranial magnetic stimulation (TMS)
  4. Optical, Thermal and Ultrasound Stimulation
    1. Optogenetic stimulation
    2. Thermal perturbation
    3. Ultrasound stimulation
  5. Chemical and Pharmacological Perturbations
    1. Liquid perturbation
    2. Microperfusion
    3. Pharmacological inhalation
    4. Pharmacological injection
    5. Pharmacological superfusion
  6. Sensory Stimulation
    1. Auditory stimulation
    2. Multisensory stimulation
    3. Odor stimulation
    4. Tactile stimulation
    5. Visual stimulation

How to use this family

  • manipulation: set type to a type code below and send its properties in details.
  • manipulationtemplate: set type to a type code below and send its properties in details.
  • Every version is published at https://www.brainstem.org/schemas/Manipulation/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/Manipulation/<Type>.json is the current version and https://www.brainstem.org/schemas/Manipulation/<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
AuditoryStimulationAuditory stimulationSensory Stimulation2.0.2none2.0.2.json
DeepBrainStimulationDeep brain stimulation (DBS)Electrical and Magnetic Stimulation2.0.2none2.0.2.json
ElectricalStimulationElectrical stimulationElectrical and Magnetic Stimulation2.0.2none2.0.2.json
ElectromagneticFieldStimulationElectromagnetic field stimulationElectrical and Magnetic Stimulation2.0.2none2.0.2.json
LiquidPerturbationLiquid perturbationChemical and Pharmacological Perturbations3.0.2none3.0.2.json
MicroperfusionMicroperfusionChemical and Pharmacological Perturbations3.0.2none3.0.2.json
MultisensoryStimulationMultisensory stimulationSensory Stimulation3.0.3none3.0.3.json
OdorStimulationOdor stimulationSensory Stimulation2.0.2none2.0.2.json
OptogeneticStimulationOptogenetic stimulationOptical, Thermal and Ultrasound Stimulation2.0.2none2.0.2.json
PharmacologicalInhalationPharmacological inhalationChemical and Pharmacological Perturbations3.0.2none3.0.2.json
PharmacologicalInjectionPharmacological injectionChemical and Pharmacological Perturbations3.0.2none3.0.2.json
PharmacologicalSuperfusionPharmacological superfusionChemical and Pharmacological Perturbations3.0.2none3.0.2.json
TactileStimulationTactile stimulationSensory Stimulation2.0.2none2.0.2.json
ThermalPerturbationThermal perturbationOptical, Thermal and Ultrasound Stimulation2.0.2none2.0.2.json
TranscranialElectricalStimulationTranscranial electrical stimulationElectrical and Magnetic Stimulation2.0.2none2.0.2.json
TranscranialMagneticStimulationTranscranial magnetic stimulation (TMS)Electrical and Magnetic Stimulation2.0.2none2.0.2.json
UltrasoundStimulationUltrasound stimulationOptical, Thermal and Ultrasound Stimulation2.0.2none2.0.2.json
VisualStimulationVisual stimulationSensory Stimulation4.0.3none4.0.3.json

Electrical and Magnetic Stimulation

Deep brain stimulation (DBS)

  • type code DeepBrainStimulation · version 2.0.2 · schema

Electrical stimulation delivered through an implanted electrode to a defined deep target. Use this rather than Electrical stimulation when the defining feature is the chronic deep-target implant.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units A, mA, µA, nA; default {"unit": "A"}The intensity of the electrical stimulus applied, measured in amperes.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time each stimulation lasts.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseDefines the profile of the electrical signal used for stimulation.
dutyCycleDuty cyclenumber ≥ 0The proportion of the ‘on’ time to the total cycle time, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation cycle is repeated during a session.
injectionPolarityInjection polaritytext  Specifies the polarity of the stimulation, which can be anodal or cathodal, influencing the direction of the current flow.
closedLoopClosed loopyes/no  Indicates whether the stimulation system is capable of adjusting its parameters based on real-time feedback from the patient’s physiological responses.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "A"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Electrical stimulation

  • type code ElectricalStimulation · version 2.0.2 · schema

General electrical stimulation through an electrode, including intracortical and peripheral stimulation. This is the default electrical choice when no more specific type applies.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units V, mV, µV; default {"unit": "V"}The magnitude of the electrical voltage applied during stimulation.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time for which the stimulation is applied.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseThe pattern or waveform of the stimulation.
dutyCycleDuty cyclenumber ≥ 0The proportion of the stimulation cycle during which the stimulus is active, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation is repeated during a session.
injectionPolarityInjection polaritytext  Refers to the direction of current flow in the stimulation.
closedLoopClosed loopyes/no  Indicates whether the system adjusts the stimulation parameters based on real-time feedback from physiological sensors.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "V"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Electromagnetic field stimulation

  • type code ElectromagneticFieldStimulation · version 2.0.2 · schema

Exposure to an applied electromagnetic field rather than current delivered through a contacting electrode.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units V, mV, µV; default {"unit": "V"}The intensity of the electromagnetic field applied.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time for which the electromagnetic field is applied during each session.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseDefines the waveform of the electromagnetic field used during stimulation.
dutyCycleDuty cyclenumber ≥ 0The proportion of the stimulation cycle during which the electromagnetic field is active, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation cycle is repeated within a single session.
injectionPolarityInjection polaritytext  Indicates the polarity of the electromagnetic field, which can be positive, negative, or alternating.
closedLoopClosed loopyes/no  Whether the stimulation system is capable of adjusting its output based on real-time feedback from sensors measuring biological responses.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "V"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Transcranial electrical stimulation

  • type code TranscranialElectricalStimulation · version 2.0.2 · schema

Current applied through scalp or skull electrodes without penetrating the tissue, covering direct, alternating, and random noise variants. Record which variant was used in the profile and notes.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units A, mA, µA, nA; default {"unit": "mA"}The intensity of the electrical current applied.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time each stimulation session lasts.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseDescribes the waveform or modulation method used during stimulation.
dutyCycleDuty cyclenumber ≥ 0The ratio of the stimulation ‘on’ time to the total cycle period, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation cycle is repeated during a session.
injectionPolarityInjection polaritytext  Refers typically to the directionality of current flow in other contexts.
closedLoopClosed loopyes/no  Indicates whether the system uses feedback from the patient’s physiological responses to automatically adjust stimulation parameters.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "mA"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Transcranial magnetic stimulation (TMS)

  • type code TranscranialMagneticStimulation · version 2.0.2 · schema

Non-contact induction of currents in tissue using a magnetic coil.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units % MSO, T, mT, µT; default {"unit": "% MSO"}Specifies the intensity of the magnetic stimulation, often measured as a percentage of the Maximum Stimulator Output (% MSO) or in Tesla (T).
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}Defines the total time each stimulation lasts.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseDescribes the waveform type of the electrical signal.
dutyCycleDuty cyclenumber ≥ 0The fraction of one period in which a signal or system is active.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation is repeated during a session.
injectionPolarityInjection polaritytext  Typically refers to the directionality of the current in conventional terms.
closedLoopClosed loopyes/no  Indicates if the stimulation system adjusts parameters in real-time based on feedback to achieve desired outcomes.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "% MSO"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Optical, Thermal and Ultrasound Stimulation

Optogenetic stimulation

  • type code OptogeneticStimulation · version 2.0.2 · schema

Light delivered to drive or suppress genetically targeted cells. Record the wavelength, since it is what distinguishes excitation from inhibition for most opsins.

PropertyTitleShapeRequiredAllowed valuesMeaning
powerPowerquantity with unit units W, mW, µW; default {"unit": "mW"}The output power of the light source used for stimulation.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseThe pattern or waveform of the light used during stimulation.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time each light stimulation lasts.
dutyCycleDuty cyclenumber ≥ 0The fraction of one period in which a signal or system is active.
repetitionsRepetitionsinteger ≥ 0The number of times the stimulation is repeated.
wavelengthWavelengthquantity with unit units nm, µm, mm, m; default {"unit": "nm"}The wavelength of the light used, selected based on the activation spectrum of the specific optogenetic actuators used.
closedLoopClosed loopyes/no  Indicates whether the stimulation parameters can be automatically adjusted based on feedback.

Illustrative payload:

[
    {
        "power": {
            "value": 1,
            "unit": "mW"
        },
        "profile": "amplitude_modulated"
    }
]

Thermal perturbation

  • type code ThermalPerturbation · version 2.0.2 · schema

Deliberate heating or cooling of tissue, such as focal cooling used to silence a region.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units °C, K, °F; default {"unit": "°C"}The maximum change in temperature from the baseline or ambient level.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time for which the thermal stimulus is applied.
profileProfilechoice one of amplitude_modulated, burst, chirp, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseDescribes the pattern or modulation of the thermal stimulus.
dutyCycleDuty cyclenumber ≥ 0Represents the fraction of the total period during which the thermal stimulus is active, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the thermal stimulus is repeated during an experiment.
closedLoopClosed loopyes/no  Indicates whether the thermal control system automatically adjusts based on real-time feedback.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "°C"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Ultrasound stimulation

  • type code UltrasoundStimulation · version 2.0.2 · schema

Focused ultrasound used to modulate activity, as distinct from ultrasound used to image, which is a Data acquisition.

PropertyTitleShapeRequiredAllowed valuesMeaning
acousticPressureAcoustic pressurequantity with unit units Pa, kPa, MPa; default {"unit": "MPa"}Peak acoustic pressure of the ultrasound field.
acousticIntensityAcoustic intensityquantity with unit units W/cm², mW/cm²; default {"unit": "W/cm²"}Acoustic intensity of the ultrasound field.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The total time each ultrasound session lasts.
dutyCycleDuty cyclenumber ≥ 0The ratio of the ‘on’ time to the total period of the ultrasound pulse cycle, expressed as a fraction.
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseSpecifies the pattern or type of ultrasound waves used.
repetitionsRepetitionsinteger ≥ 0The number of times the ultrasound pulses are repeated within a session.
injectionPolarityInjection polaritytext  Typically refers to the polarity of electrical input in electromechanical systems.
closedLoopClosed loopyes/no  Indicates whether the stimulation parameters are dynamically adjusted in response to real-time feedback from physiological sensors or biomarkers.

Illustrative payload:

[
    {
        "acousticPressure": {
            "value": 1,
            "unit": "MPa"
        },
        "acousticIntensity": {
            "value": 1,
            "unit": "W/cm²"
        }
    }
]

Chemical and Pharmacological Perturbations

Liquid perturbation

  • type code LiquidPerturbation · version 3.0.2 · schema

A change of the fluid around the preparation or exposed tissue whose effect comes from the solution itself, such as an osmotic challenge, ionic substitution or a bath-medium switch. Local delivery through a probe is Microperfusion; a drug in the bath is Pharmacological superfusion.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, ng/mL, M, mM, µM, nM; default {"unit": "mg/mL"}The concentration of the liquid agent, crucial for ensuring the desired potency and effect.
volumeVolumequantity with unit units µL, mL, L, nL; default {"unit": "µL"}The total volume of the agent to be administered.
profileProfilechoice one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titrationDescribes the method of liquid delivery.
repetitionsRepetitionsinteger ≥ 0The number of times the perturbation is to be repeated.
flowRateFlow ratequantity with unit units µL/min, mL/min, L/min, nL/min, µL/s, mL/s; default {"unit": "µL/min"}The rate at which the liquid agent is administered.
closedLoopClosed loopyes/no  Indicates whether the system can adjust the flow, volume, or concentration of the agent based on real-time feedback.

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "volume": {
            "value": 1,
            "unit": "µL"
        }
    }
]

Microperfusion

  • type code Microperfusion · version 3.0.2 · schema

Local delivery or exchange of a solution inside tissue through an implanted probe or line at low flow, as in open-flow microperfusion or reverse microdialysis. Use it when the agent reaches a small target volume; bath-wide changes are Liquid perturbation or Pharmacological superfusion.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, ng/mL, M, mM, µM, nM; default {"unit": "mg/mL"}The concentration of the liquid agent, critical for ensuring the desired physiological impact.
volumeVolumequantity with unit units µL, mL, L, nL; default {"unit": "µL"}The total volume of the agent to be administered through microperfusion.
profileProfilechoice one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titrationThe method or pattern of delivery for the liquid agent.
repetitionsRepetitionsinteger ≥ 0The number of times the microperfusion procedure is repeated.
flowRateFlow ratequantity with unit units µL/min, mL/min, L/min, nL/min, µL/s, mL/s; default {"unit": "µL/min"}The rate at which the liquid agent is administered.
closedLoopClosed loopyes/no  Indicates whether the microperfusion system adjusts the delivery parameters based on real-time feedback.

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "volume": {
            "value": 1,
            "unit": "µL"
        }
    }
]

Pharmacological inhalation

  • type code PharmacologicalInhalation · version 3.0.2 · schema

An agent delivered through the respiratory route during the session.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, g/L, mg/L, µg/L, % w/v, % v/v, % w/w; default {"unit": "mg/mL"}The concentration of the liquid agent in the inhalation mixture.
flowRateFlow ratequantity with unit units µL/min, mL/min, µL/s, mL/s, L/min; default {"unit": "µL/min"}The rate at which the inhalation agent is delivered to the patient.
profileProfilechoice one of bolus_inhalation, continuous_inhalation, controlled_release_inhalation, deep_lung_inhalation, high_frequency_inhalation, holding_breath, low_volume_inhalation, positive_pressure_inhalation, pulse_inhalation, ramp_inhalation, rescue_inhalation, stacked_breathing, tidal_breathingThe method or pattern of inhalation used.
volumeVolumequantity with unit units L, mL, µL, nL, pL; default {"unit": "µL"}Total volume of the inhalation agent administered.
repetitionsRepetitionsinteger ≥ 0The number of times the inhalation procedure is repeated.
closedLoopClosed loopyes/no  Indicates if the inhalation system adjusts the flow, volume, or dosage based on feedback.

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "flowRate": {
            "value": 1,
            "unit": "µL/min"
        }
    }
]

Pharmacological injection

  • type code PharmacologicalInjection · version 3.0.2 · schema

An agent injected during the session to perturb the system under study. A drug given as clinical care, such as analgesia or anesthesia, is a Procedure instead.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, ng/mL, M, mM, µM, nM; default {"unit": "mg/mL"}The concentration of the active ingredient in the injection solution.
volumeVolumequantity with unit units µL, mL, L, nL; default {"unit": "µL"}The total volume of the injection given.
profileProfilechoice one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titrationThe method of injection used.
repetitionsRepetitionsinteger ≥ 0The number of times the injection is administered.
flowRateFlow ratequantity with unit units µL/min, mL/min, L/min, nL/min, µL/s, mL/s; default {"unit": "µL/min"}The rate at which the injection is administered.
closedLoopClosed loopyes/no  Specifies whether the injection system automatically adjusts based on feedback.

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "volume": {
            "value": 1,
            "unit": "µL"
        }
    }
]

Pharmacological superfusion

  • type code PharmacologicalSuperfusion · version 3.0.2 · schema

An agent applied by bathing the preparation in solution, the usual route for slice and other ex-vivo work.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, ng/mL, M, mM, µM, nM; default {"unit": "mg/mL"}The concentration of the liquid agent within the superfusion solution.
volumeVolumequantity with unit units µL, mL, L, nL; default {"unit": "µL"}The total volume of the superfusion fluid used throughout the experiment or procedure.
profileProfilechoice one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titrationThe pattern or method of superfusion.
repetitionsRepetitionsinteger ≥ 0The number of cycles or iterations of superfusion performed during the experiment.
flowRateFlow ratequantity with unit units µL/min, mL/min, L/min, nL/min, µL/s, mL/s; default {"unit": "µL/min"}The rate at which the superfusion solution is applied.
closedLoopClosed loopyes/no  Indicates if the superfusion system adjusts the delivery parameters dynamically based on real-time feedback.

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "volume": {
            "value": 1,
            "unit": "µL"
        }
    }
]

Sensory Stimulation

Auditory stimulation

  • type code AuditoryStimulation · version 2.0.2 · schema

A presented sound, such as a tone, click, or noise burst. Recording sound is a Data acquisition, not a Manipulation.

PropertyTitleShapeRequiredAllowed valuesMeaning
amplitudeAmplitudequantity with unit units dB, dB SPL, Pa; default {"unit": "dB"}The maximum level of the sound pressure created by the stimulus.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}The length of time for which the sound is played.
frequencyFrequencyquantity with unit units Hz, kHz, MHz; default {"unit": "Hz"}Base frequency of the sound stimulus.
modulationFrequencyModulation frequencyquantity with unit units Hz, kHz, MHz; default {"unit": "Hz"}Modulation frequency if amplitude- or frequency-modulated (optional).
profileProfilechoice one of amplitude_modulated, alternating_current, biphasic, burst, chirp, direct_current, cosine, frequency_hopping, frequency_modulated, decaying_exponential, gaussian_pulse, harmonic_stimulation, gaussian_noise, pseudo_random_binary_sequence, pink_noise, pulse_train, sawtooth, staircase, sine_wave, sinc_pulse, square, stochastic, step_function, ramp, rising_exponential, trapezoidal_pulse, triangle, variable_rate_pulse_train, white_noiseThe specific waveform or pattern of the sound used for stimulation.
dutyCycleDuty cyclenumber ≥ 0The proportion of the period during which the sound is active, expressed as a fraction.
repetitionsRepetitionsinteger ≥ 0The number of times the sound stimulus is repeated.
closedLoopClosed loopyes/no  Indicates whether the sound stimulation system can adjust parameters automatically in response to feedback from the subject or environment.

Illustrative payload:

[
    {
        "amplitude": {
            "value": 1,
            "unit": "dB"
        },
        "duration": {
            "value": 1,
            "unit": "s"
        }
    }
]

Multisensory stimulation

  • type code MultisensoryStimulation · version 3.0.3 · schema

Two or more modalities presented as one designed stimulus. Use this when the timing between modalities is part of the experiment; record separate entries when the stimuli are independent.

PropertyTitleShapeRequiredAllowed valuesMeaning
modalitiesModalitiesmulti-select one of visual, auditory, tactile, olfactory, gustatory, vestibular, other; format select2Select the sensory modalities presented together in this stimulation event.
synchronizationTemporal relationshipchoice one of synchronous, asynchronous, randomized, unknownIndicates how the different sensory stimuli were timed relative to each other.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}Overall duration of the multisensory event, i.e., the time window during which stimuli were presented.
repetitionsRepetitionsinteger ≥ 0Number of times this multisensory stimulus combination was repeated.
closedLoopClosed loopyes/no  Was stimulus timing or modality selection dynamically adapted based on behavioral or physiological signals?

Illustrative payload:

[
    {
        "modalities": [
            "visual"
        ],
        "synchronization": "synchronous"
    }
]

Odor stimulation

  • type code OdorStimulation · version 2.0.2 · schema

A presented olfactory stimulus, usually delivered by an olfactometer.

PropertyTitleShapeRequiredAllowed valuesMeaning
concentrationConcentrationquantity with unit units mg/mL, µg/mL, g/L, mg/L, µg/L, % w/v, % v/v, % w/w; default {"unit": "mg/mL"}The concentration of the odor in the inhalation mixture.
flowRateFlow ratequantity with unit units mL/min, µL/min, mL/s, µL/s, L/min; default {"unit": "mL/min"}The rate at which the inhalation agent is delivered to the subject.
repetitionsRepetitionsinteger ≥ 0The number of times the inhalation procedure is repeated.
inhalationPhaseInhalation phasetext  Is the odor presented at a specific inhalation phase?

Illustrative payload:

[
    {
        "concentration": {
            "value": 1,
            "unit": "mg/mL"
        },
        "flowRate": {
            "value": 1,
            "unit": "mL/min"
        }
    }
]

Tactile stimulation

  • type code TactileStimulation · version 2.0.2 · schema

A mechanical stimulus applied to the body surface, such as whisker deflection or a von Frey filament.

PropertyTitleShapeRequiredAllowed valuesMeaning
contactTypeContact typechoice one of mechanical_contact, mechanical_vibration, air_puff, brush, cotton_swab, otherGeneral type of tactile interaction used for stimulation.
siteStimulation sitetext  The anatomical location where the tactile stimulus is applied.
forceForcequantity with unit units mN, N, µN, gf, kgf; default {"unit": "mN"}Approximate mechanical force applied during stimulation. Can be estimated if not measured precisely.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}Duration for which the tactile stimulus is applied.
profileProfilechoice one of single_pulse, pulse_train, sinusoidal, square_wave, sawtooth, burst, ramp, step_function, manualTemporal profile or shape of the stimulation waveform. ‘Manual’ can be selected if triggered by hand.
repetitionsRepetitionsinteger ≥ 0Number of times the tactile stimulus is delivered.
closedLoopClosed loopyes/no  Indicates whether stimulation is delivered based on real-time behavioral or physiological signals.

Illustrative payload:

[
    {
        "contactType": "mechanical_contact",
        "site": "text"
    }
]

Visual stimulation

  • type code VisualStimulation · version 4.0.3 · schema

A presented visual stimulus, such as a grating, flash, or natural scene.

PropertyTitleShapeRequiredAllowed valuesMeaning
stimulusTypesStimulus typesmulti-select one of gratings, natural_images, led_flashes, checkerboard, full_field_flashes, moving_bars, flicker, other; format select2Select one or more visual stimulus types used in this stimulation event.
stimulationPositionStimulus positionchoice one of contralateral, ipsilateral, bilateral, centered, surround, other, unknownLocation of the stimulus relative to the subject’s visual field.
durationDurationquantity with unit units s, ms, µs, min, h; default {"unit": "s"}Duration of this visual stimulus presentation.
repetitionsRepetitionsinteger ≥ 0Number of times this visual stimulus was repeated.
closedLoopClosed loopyes/no  Whether the visual stimulus was dynamically adapted to the subject’s behavior or physiological signals.

Illustrative payload:

[
    {
        "stimulusTypes": [
            "gratings"
        ],
        "stimulationPosition": "contralateral"
    }
]