Manipulation schemas
Type-specific details of manipulations applied during a session.
Table of contents
- How to use this family
- Quick type map
- Electrical and Magnetic Stimulation
- Optical, Thermal and Ultrasound Stimulation
- Chemical and Pharmacological Perturbations
- Sensory Stimulation
How to use this family
manipulation: settypeto a type code below and send its properties indetails.manipulationtemplate: settypeto a type code below and send its properties indetails.- Every version is published at
https://www.brainstem.org/schemas/Manipulation/<Type>/<version>.jsonand never changes;https://www.brainstem.org/schemas/Manipulation/<Type>.jsonis the current version andhttps://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 code | Title | Group | Version | Required properties | Schema |
|---|---|---|---|---|---|
AuditoryStimulation | Auditory stimulation | Sensory Stimulation | 2.0.2 | none | 2.0.2.json |
DeepBrainStimulation | Deep brain stimulation (DBS) | Electrical and Magnetic Stimulation | 2.0.2 | none | 2.0.2.json |
ElectricalStimulation | Electrical stimulation | Electrical and Magnetic Stimulation | 2.0.2 | none | 2.0.2.json |
ElectromagneticFieldStimulation | Electromagnetic field stimulation | Electrical and Magnetic Stimulation | 2.0.2 | none | 2.0.2.json |
LiquidPerturbation | Liquid perturbation | Chemical and Pharmacological Perturbations | 3.0.2 | none | 3.0.2.json |
Microperfusion | Microperfusion | Chemical and Pharmacological Perturbations | 3.0.2 | none | 3.0.2.json |
MultisensoryStimulation | Multisensory stimulation | Sensory Stimulation | 3.0.3 | none | 3.0.3.json |
OdorStimulation | Odor stimulation | Sensory Stimulation | 2.0.2 | none | 2.0.2.json |
OptogeneticStimulation | Optogenetic stimulation | Optical, Thermal and Ultrasound Stimulation | 2.0.2 | none | 2.0.2.json |
PharmacologicalInhalation | Pharmacological inhalation | Chemical and Pharmacological Perturbations | 3.0.2 | none | 3.0.2.json |
PharmacologicalInjection | Pharmacological injection | Chemical and Pharmacological Perturbations | 3.0.2 | none | 3.0.2.json |
PharmacologicalSuperfusion | Pharmacological superfusion | Chemical and Pharmacological Perturbations | 3.0.2 | none | 3.0.2.json |
TactileStimulation | Tactile stimulation | Sensory Stimulation | 2.0.2 | none | 2.0.2.json |
ThermalPerturbation | Thermal perturbation | Optical, Thermal and Ultrasound Stimulation | 2.0.2 | none | 2.0.2.json |
TranscranialElectricalStimulation | Transcranial electrical stimulation | Electrical and Magnetic Stimulation | 2.0.2 | none | 2.0.2.json |
TranscranialMagneticStimulation | Transcranial magnetic stimulation (TMS) | Electrical and Magnetic Stimulation | 2.0.2 | none | 2.0.2.json |
UltrasoundStimulation | Ultrasound stimulation | Optical, Thermal and Ultrasound Stimulation | 2.0.2 | none | 2.0.2.json |
VisualStimulation | Visual stimulation | Sensory Stimulation | 4.0.3 | none | 4.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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units A, mA, µA, nA; default {"unit": "A"} | The intensity of the electrical stimulus applied, measured in amperes. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time each stimulation lasts. | |
profile | Profile | choice | 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_noise | Defines the profile of the electrical signal used for stimulation. | |
dutyCycle | Duty cycle | number | ≥ 0 | The proportion of the ‘on’ time to the total cycle time, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation cycle is repeated during a session. | |
injectionPolarity | Injection polarity | text | Specifies the polarity of the stimulation, which can be anodal or cathodal, influencing the direction of the current flow. | ||
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,StimulatingElectrode,ReferenceElectrode,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units V, mV, µV; default {"unit": "V"} | The magnitude of the electrical voltage applied during stimulation. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time for which the stimulation is applied. | |
profile | Profile | choice | 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_noise | The pattern or waveform of the stimulation. | |
dutyCycle | Duty cycle | number | ≥ 0 | The proportion of the stimulation cycle during which the stimulus is active, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation is repeated during a session. | |
injectionPolarity | Injection polarity | text | Refers to the direction of current flow in the stimulation. | ||
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,ReferenceElectrode,EEG,ECoG,EMG,StimulatingElectrode,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units V, mV, µV; default {"unit": "V"} | The intensity of the electromagnetic field applied. | |
duration | Duration | quantity 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. | |
profile | Profile | choice | 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_noise | Defines the waveform of the electromagnetic field used during stimulation. | |
dutyCycle | Duty cycle | number | ≥ 0 | The proportion of the stimulation cycle during which the electromagnetic field is active, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation cycle is repeated within a single session. | |
injectionPolarity | Injection polarity | text | Indicates the polarity of the electromagnetic field, which can be positive, negative, or alternating. | ||
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,StimulatingElectrode,TMSCoil,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units A, mA, µA, nA; default {"unit": "mA"} | The intensity of the electrical current applied. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time each stimulation session lasts. | |
profile | Profile | choice | 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_noise | Describes the waveform or modulation method used during stimulation. | |
dutyCycle | Duty cycle | number | ≥ 0 | The ratio of the stimulation ‘on’ time to the total cycle period, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation cycle is repeated during a session. | |
injectionPolarity | Injection polarity | text | Refers typically to the directionality of current flow in other contexts. | ||
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,ReferenceElectrode,EEG,ECoG,EMG,StimulatingElectrode,Generic; other values are refused (400).
Transcranial magnetic stimulation (TMS)
- type code
TranscranialMagneticStimulation· version 2.0.2 · schema
Non-contact induction of currents in tissue using a magnetic coil.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity 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). | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | Defines the total time each stimulation lasts. | |
profile | Profile | choice | 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_noise | Describes the waveform type of the electrical signal. | |
dutyCycle | Duty cycle | number | ≥ 0 | The fraction of one period in which a signal or system is active. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation is repeated during a session. | |
injectionPolarity | Injection polarity | text | Typically refers to the directionality of the current in conventional terms. | ||
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,TMSCoil,StimulatingElectrode,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
power | Power | quantity with unit | units W, mW, µW; default {"unit": "mW"} | The output power of the light source used for stimulation. | |
profile | Profile | choice | 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_noise | The pattern or waveform of the light used during stimulation. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time each light stimulation lasts. | |
dutyCycle | Duty cycle | number | ≥ 0 | The fraction of one period in which a signal or system is active. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the stimulation is repeated. | |
wavelength | Wavelength | quantity 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. | |
closedLoop | Closed loop | yes/no | Indicates whether the stimulation parameters can be automatically adjusted based on feedback. |
Illustrative payload:
[
{
"power": {
"value": 1,
"unit": "mW"
},
"profile": "amplitude_modulated"
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,GRINLens,Prism,OpticFiber,Generic,CranialWindow,MicroscopeObjective,Catheter,LEDArray; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units °C, K, °F; default {"unit": "°C"} | The maximum change in temperature from the baseline or ambient level. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time for which the thermal stimulus is applied. | |
profile | Profile | choice | 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_noise | Describes the pattern or modulation of the thermal stimulus. | |
dutyCycle | Duty cycle | number | ≥ 0 | Represents the fraction of the total period during which the thermal stimulus is active, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the thermal stimulus is repeated during an experiment. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Catheter,Generic,OpticFiber,GRINLens,Prism,ThermalProbe; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
acousticPressure | Acoustic pressure | quantity with unit | units Pa, kPa, MPa; default {"unit": "MPa"} | Peak acoustic pressure of the ultrasound field. | |
acousticIntensity | Acoustic intensity | quantity with unit | units W/cm², mW/cm²; default {"unit": "W/cm²"} | Acoustic intensity of the ultrasound field. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The total time each ultrasound session lasts. | |
dutyCycle | Duty cycle | number | ≥ 0 | The ratio of the ‘on’ time to the total period of the ultrasound pulse cycle, expressed as a fraction. | |
profile | Profile | choice | 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_noise | Specifies the pattern or type of ultrasound waves used. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the ultrasound pulses are repeated within a session. | |
injectionPolarity | Injection polarity | text | Typically refers to the polarity of electrical input in electromechanical systems. | ||
closedLoop | Closed loop | yes/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²"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,UltrasoundTransducer,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
volume | Volume | quantity with unit | units µL, mL, L, nL; default {"unit": "µL"} | The total volume of the agent to be administered. | |
profile | Profile | choice | one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titration | Describes the method of liquid delivery. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the perturbation is to be repeated. | |
flowRate | Flow rate | quantity 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. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,Catheter,InjectionCannula,MicroperfusionLine,DrugDeliveryLine,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
volume | Volume | quantity with unit | units µL, mL, L, nL; default {"unit": "µL"} | The total volume of the agent to be administered through microperfusion. | |
profile | Profile | choice | one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titration | The method or pattern of delivery for the liquid agent. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the microperfusion procedure is repeated. | |
flowRate | Flow rate | quantity 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. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,MicroperfusionLine,BathPerfusion,DrugDeliveryLine,Catheter,Generic; other values are refused (400).
Pharmacological inhalation
- type code
PharmacologicalInhalation· version 3.0.2 · schema
An agent delivered through the respiratory route during the session.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
flowRate | Flow rate | quantity 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. | |
profile | Profile | choice | 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_breathing | The method or pattern of inhalation used. | |
volume | Volume | quantity with unit | units L, mL, µL, nL, pL; default {"unit": "µL"} | Total volume of the inhalation agent administered. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the inhalation procedure is repeated. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,DrugDeliveryLine,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
volume | Volume | quantity with unit | units µL, mL, L, nL; default {"unit": "µL"} | The total volume of the injection given. | |
profile | Profile | choice | one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titration | The method of injection used. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the injection is administered. | |
flowRate | Flow rate | quantity 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. | |
closedLoop | Closed loop | yes/no | Specifies whether the injection system automatically adjusts based on feedback. |
Illustrative payload:
[
{
"concentration": {
"value": 1,
"unit": "mg/mL"
},
"volume": {
"value": 1,
"unit": "µL"
}
}
]
interfacesaccepts ExperimentalInterface types:InjectionCannula,OpticFiber,Generic,Catheter,DrugDeliveryLine,OsmoticPump; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
volume | Volume | quantity with unit | units µL, mL, L, nL; default {"unit": "µL"} | The total volume of the superfusion fluid used throughout the experiment or procedure. | |
profile | Profile | choice | one of bolus_injection, continuous_infusion, tapered_dose, intermittent_bolus, staggered_injection, ramp_infusion, burst_infusion, step_infusion, layered_dosing, titration | The pattern or method of superfusion. | |
repetitions | Repetitions | integer | ≥ 0 | The number of cycles or iterations of superfusion performed during the experiment. | |
flowRate | Flow rate | quantity 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. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:SiliconProbe,Tetrode,SingleWireElectrode,OpticFiber,BathPerfusion,DrugDeliveryLine,MicroperfusionLine,Generic; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
amplitude | Amplitude | quantity with unit | units dB, dB SPL, Pa; default {"unit": "dB"} | The maximum level of the sound pressure created by the stimulus. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | The length of time for which the sound is played. | |
frequency | Frequency | quantity with unit | units Hz, kHz, MHz; default {"unit": "Hz"} | Base frequency of the sound stimulus. | |
modulationFrequency | Modulation frequency | quantity with unit | units Hz, kHz, MHz; default {"unit": "Hz"} | Modulation frequency if amplitude- or frequency-modulated (optional). | |
profile | Profile | choice | 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_noise | The specific waveform or pattern of the sound used for stimulation. | |
dutyCycle | Duty cycle | number | ≥ 0 | The proportion of the period during which the sound is active, expressed as a fraction. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the sound stimulus is repeated. | |
closedLoop | Closed loop | yes/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"
}
}
]
interfacesaccepts ExperimentalInterface types:Microphone,Generic,AuditoryStimulator; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
modalities | Modalities | multi-select | one of visual, auditory, tactile, olfactory, gustatory, vestibular, other; format select2 | Select the sensory modalities presented together in this stimulation event. | |
synchronization | Temporal relationship | choice | one of synchronous, asynchronous, randomized, unknown | Indicates how the different sensory stimuli were timed relative to each other. | |
duration | Duration | quantity 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. | |
repetitions | Repetitions | integer | ≥ 0 | Number of times this multisensory stimulus combination was repeated. | |
closedLoop | Closed loop | yes/no | Was stimulus timing or modality selection dynamically adapted based on behavioral or physiological signals? |
Illustrative payload:
[
{
"modalities": [
"visual"
],
"synchronization": "synchronous"
}
]
interfacesaccepts ExperimentalInterface types:Microphone,Generic,Camera,DrugDeliveryLine; other values are refused (400).
Odor stimulation
- type code
OdorStimulation· version 2.0.2 · schema
A presented olfactory stimulus, usually delivered by an olfactometer.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
concentration | Concentration | quantity 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. | |
flowRate | Flow rate | quantity 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. | |
repetitions | Repetitions | integer | ≥ 0 | The number of times the inhalation procedure is repeated. | |
inhalationPhase | Inhalation phase | text | Is the odor presented at a specific inhalation phase? |
Illustrative payload:
[
{
"concentration": {
"value": 1,
"unit": "mg/mL"
},
"flowRate": {
"value": 1,
"unit": "mL/min"
}
}
]
interfacesaccepts ExperimentalInterface types:DrugDeliveryLine,Generic,Olfactometer; other values are refused (400).
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.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
contactType | Contact type | choice | one of mechanical_contact, mechanical_vibration, air_puff, brush, cotton_swab, other | General type of tactile interaction used for stimulation. | |
site | Stimulation site | text | The anatomical location where the tactile stimulus is applied. | ||
force | Force | quantity with unit | units mN, N, µN, gf, kgf; default {"unit": "mN"} | Approximate mechanical force applied during stimulation. Can be estimated if not measured precisely. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | Duration for which the tactile stimulus is applied. | |
profile | Profile | choice | one of single_pulse, pulse_train, sinusoidal, square_wave, sawtooth, burst, ramp, step_function, manual | Temporal profile or shape of the stimulation waveform. ‘Manual’ can be selected if triggered by hand. | |
repetitions | Repetitions | integer | ≥ 0 | Number of times the tactile stimulus is delivered. | |
closedLoop | Closed loop | yes/no | Indicates whether stimulation is delivered based on real-time behavioral or physiological signals. |
Illustrative payload:
[
{
"contactType": "mechanical_contact",
"site": "text"
}
]
interfacesaccepts ExperimentalInterface types:Generic,TactileStimulator; other values are refused (400).
Visual stimulation
- type code
VisualStimulation· version 4.0.3 · schema
A presented visual stimulus, such as a grating, flash, or natural scene.
| Property | Title | Shape | Required | Allowed values | Meaning |
|---|---|---|---|---|---|
stimulusTypes | Stimulus types | multi-select | one of gratings, natural_images, led_flashes, checkerboard, full_field_flashes, moving_bars, flicker, other; format select2 | Select one or more visual stimulus types used in this stimulation event. | |
stimulationPosition | Stimulus position | choice | one of contralateral, ipsilateral, bilateral, centered, surround, other, unknown | Location of the stimulus relative to the subject’s visual field. | |
duration | Duration | quantity with unit | units s, ms, µs, min, h; default {"unit": "s"} | Duration of this visual stimulus presentation. | |
repetitions | Repetitions | integer | ≥ 0 | Number of times this visual stimulus was repeated. | |
closedLoop | Closed loop | yes/no | Whether the visual stimulus was dynamically adapted to the subject’s behavior or physiological signals. |
Illustrative payload:
[
{
"stimulusTypes": [
"gratings"
],
"stimulationPosition": "contralateral"
}
]
interfacesaccepts ExperimentalInterface types:Camera,Generic,VisualStimulator; other values are refused (400).