Skip to content

Add support for quick retract during trial logic #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bruno-f-cruz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for quick retract during trial logic #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions bonsai/Bonsai.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<Packages>
<Package id="AllenNeuralDynamics.AindBehaviorServices" version="0.13.4" />
<Package id="AllenNeuralDynamics.AindBehaviorServices.Distributions" version="0.2.0" />
<Package id="AllenNeuralDynamics.AindManipulator" version="0.3.0" />
<Package id="AllenNeuralDynamics.AindManipulator" version="0.4.0" />
<Package id="AllenNeuralDynamics.Core" version="0.4.1" />
<Package id="AllenNeuralDynamics.Core.Design" version="0.4.0" />
<Package id="AllenNeuralDynamics.EnvironmentSensor" version="0.2.0" />
Expand All @@ -16,24 +16,24 @@
<Package id="Bonsai" version="2.9.0" />
<Package id="Bonsai.Core" version="2.9.0" />
<Package id="Bonsai.Design" version="2.9.0" />
<Package id="Bonsai.Design.Visualizers" version="2.8.0" />
<Package id="Bonsai.Dsp" version="2.8.0" />
<Package id="Bonsai.Design.Visualizers" version="2.9.0" />
<Package id="Bonsai.Dsp" version="2.9.0" />
<Package id="Bonsai.Editor" version="2.9.0" />
<Package id="Bonsai.Gui" version="0.1.0" />
<Package id="Bonsai.Harp" version="3.6.1" />
<Package id="Bonsai.Harp.Design" version="3.5.0" />
<Package id="Bonsai.Numerics" version="0.7.0" />
<Package id="Bonsai.Numerics" version="0.10.0" />
<Package id="Bonsai.Scripting.Expressions" version="2.10.0" />
<Package id="Bonsai.Scripting.Expressions.Design" version="2.10.0" />
<Package id="Bonsai.Scripting.Python" version="0.3.0" />
<Package id="Bonsai.Shaders" version="0.26.0" />
<Package id="Bonsai.Shaders.Design" version="0.26.0" />
<Package id="Bonsai.Shaders.Rendering" version="0.3.0" />
<Package id="Bonsai.Spinnaker" version="0.7.1" />
<Package id="Bonsai.System" version="2.8.1" />
<Package id="Bonsai.System.Design" version="2.7.0" />
<Package id="Bonsai.Vision" version="2.8.1" />
<Package id="Bonsai.Vision.Design" version="2.8.1" />
<Package id="Bonsai.System" version="2.9.0" />
<Package id="Bonsai.System.Design" version="2.9.0" />
<Package id="Bonsai.Vision" version="2.9.0" />
<Package id="Bonsai.Vision.Design" version="2.9.0" />
<Package id="Bonsai.VR" version="0.6.0" />
<Package id="Bonsai.Windows.Input" version="2.9.0" />
<Package id="BonVision" version="0.11.0" />
Expand All @@ -44,7 +44,7 @@
<Package id="Harp.LoadCells" version="0.2.0" />
<Package id="Harp.Olfactometer" version="0.2.0" />
<Package id="Harp.SoundCard" version="0.2.0" />
<Package id="Harp.StepperDriver" version="0.3.0" />
<Package id="Harp.StepperDriver" version="0.4.0" />
<Package id="Hexa.NET.ImGui" version="2.2.9" />
<Package id="Hexa.NET.ImGui.Backends" version="1.0.18" />
<Package id="Hexa.NET.ImPlot" version="2.2.9" />
Expand Down Expand Up @@ -122,7 +122,7 @@
<AssemblyLocations>
<AssemblyLocation assemblyName="AllenNeuralDynamics.AindBehaviorServices" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.AindBehaviorServices.0.13.4/lib/net472/AllenNeuralDynamics.AindBehaviorServices.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.AindBehaviorServices.Distributions" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.AindBehaviorServices.Distributions.0.2.0/lib/net472/AllenNeuralDynamics.AindBehaviorServices.Distributions.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.AindManipulator" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.AindManipulator.0.3.0/lib/net48/AllenNeuralDynamics.AindManipulator.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.AindManipulator" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.AindManipulator.0.4.0/lib/net48/AllenNeuralDynamics.AindManipulator.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.Core" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.Core.0.4.1/lib/net472/AllenNeuralDynamics.Core.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.Core.Design" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.Core.Design.0.4.0/lib/net472/AllenNeuralDynamics.Core.Design.dll" />
<AssemblyLocation assemblyName="AllenNeuralDynamics.EnvironmentSensor" processorArchitecture="MSIL" location="Packages/AllenNeuralDynamics.EnvironmentSensor.0.2.0/lib/net462/AllenNeuralDynamics.EnvironmentSensor.dll" />
Expand All @@ -135,24 +135,24 @@
<AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages/Bonsai.2.9.0/lib/net48/Bonsai.exe" />
<AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages/Bonsai.Core.2.9.0/lib/net472/Bonsai.Core.dll" />
<AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Design.2.9.0/lib/net472/Bonsai.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Design.Visualizers" processorArchitecture="MSIL" location="Packages/Bonsai.Design.Visualizers.2.8.0/lib/net462/Bonsai.Design.Visualizers.dll" />
<AssemblyLocation assemblyName="Bonsai.Dsp" processorArchitecture="MSIL" location="Packages/Bonsai.Dsp.2.8.0/lib/net462/Bonsai.Dsp.dll" />
<AssemblyLocation assemblyName="Bonsai.Design.Visualizers" processorArchitecture="MSIL" location="Packages/Bonsai.Design.Visualizers.2.9.0/lib/net472/Bonsai.Design.Visualizers.dll" />
<AssemblyLocation assemblyName="Bonsai.Dsp" processorArchitecture="MSIL" location="Packages/Bonsai.Dsp.2.9.0/lib/net472/Bonsai.Dsp.dll" />
<AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages/Bonsai.Editor.2.9.0/lib/net472/Bonsai.Editor.dll" />
<AssemblyLocation assemblyName="Bonsai.Gui" processorArchitecture="MSIL" location="Packages/Bonsai.Gui.0.1.0/lib/net472/Bonsai.Gui.dll" />
<AssemblyLocation assemblyName="Bonsai.Harp" processorArchitecture="MSIL" location="Packages/Bonsai.Harp.3.6.1/lib/net462/Bonsai.Harp.dll" />
<AssemblyLocation assemblyName="Bonsai.Harp.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Harp.Design.3.5.0/lib/net462/Bonsai.Harp.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Numerics" processorArchitecture="MSIL" location="Packages/Bonsai.Numerics.0.7.0/lib/net462/Bonsai.Numerics.dll" />
<AssemblyLocation assemblyName="Bonsai.Numerics" processorArchitecture="MSIL" location="Packages/Bonsai.Numerics.0.10.0/lib/net462/Bonsai.Numerics.dll" />
<AssemblyLocation assemblyName="Bonsai.Scripting.Expressions" processorArchitecture="MSIL" location="Packages/Bonsai.Scripting.Expressions.2.10.0/lib/net472/Bonsai.Scripting.Expressions.dll" />
<AssemblyLocation assemblyName="Bonsai.Scripting.Expressions.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Scripting.Expressions.Design.2.10.0/lib/net472/Bonsai.Scripting.Expressions.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Scripting.Python" processorArchitecture="MSIL" location="Packages/Bonsai.Scripting.Python.0.3.0/lib/net472/Bonsai.Scripting.Python.dll" />
<AssemblyLocation assemblyName="Bonsai.Shaders" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.0.26.0/lib/net462/Bonsai.Shaders.dll" />
<AssemblyLocation assemblyName="Bonsai.Shaders.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.Design.0.26.0/lib/net462/Bonsai.Shaders.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Shaders.Rendering" processorArchitecture="MSIL" location="Packages/Bonsai.Shaders.Rendering.0.3.0/lib/net462/Bonsai.Shaders.Rendering.dll" />
<AssemblyLocation assemblyName="Bonsai.Spinnaker" processorArchitecture="MSIL" location="Packages/Bonsai.Spinnaker.0.7.1/lib/net462/Bonsai.Spinnaker.dll" />
<AssemblyLocation assemblyName="Bonsai.System" processorArchitecture="MSIL" location="Packages/Bonsai.System.2.8.1/lib/net462/Bonsai.System.dll" />
<AssemblyLocation assemblyName="Bonsai.System.Design" processorArchitecture="MSIL" location="Packages/Bonsai.System.Design.2.7.0/lib/net462/Bonsai.System.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Vision" processorArchitecture="MSIL" location="Packages/Bonsai.Vision.2.8.1/lib/net462/Bonsai.Vision.dll" />
<AssemblyLocation assemblyName="Bonsai.Vision.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Vision.Design.2.8.1/lib/net462/Bonsai.Vision.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.System" processorArchitecture="MSIL" location="Packages/Bonsai.System.2.9.0/lib/net472/Bonsai.System.dll" />
<AssemblyLocation assemblyName="Bonsai.System.Design" processorArchitecture="MSIL" location="Packages/Bonsai.System.Design.2.9.0/lib/net472/Bonsai.System.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Vision" processorArchitecture="MSIL" location="Packages/Bonsai.Vision.2.9.0/lib/net472/Bonsai.Vision.dll" />
<AssemblyLocation assemblyName="Bonsai.Vision.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Vision.Design.2.9.0/lib/net472/Bonsai.Vision.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.VR" processorArchitecture="MSIL" location="Packages/Bonsai.VR.0.6.0/lib/net45/Bonsai.VR.dll" />
<AssemblyLocation assemblyName="Bonsai.Windows.Input" processorArchitecture="MSIL" location="Packages/Bonsai.Windows.Input.2.9.0/lib/net472/Bonsai.Windows.Input.dll" />
<AssemblyLocation assemblyName="BonVision" processorArchitecture="MSIL" location="Packages/BonVision.0.11.0/lib/net462/BonVision.dll" />
Expand All @@ -161,7 +161,7 @@
<AssemblyLocation assemblyName="Harp.LoadCells" processorArchitecture="MSIL" location="Packages/Harp.LoadCells.0.2.0/lib/net462/Harp.LoadCells.dll" />
<AssemblyLocation assemblyName="Harp.Olfactometer" processorArchitecture="MSIL" location="Packages/Harp.Olfactometer.0.2.0/lib/net462/Harp.Olfactometer.dll" />
<AssemblyLocation assemblyName="Harp.SoundCard" processorArchitecture="MSIL" location="Packages/Harp.SoundCard.0.2.0/lib/net462/Harp.SoundCard.dll" />
<AssemblyLocation assemblyName="Harp.StepperDriver" processorArchitecture="MSIL" location="Packages/Harp.StepperDriver.0.3.0/lib/net462/Harp.StepperDriver.dll" />
<AssemblyLocation assemblyName="Harp.StepperDriver" processorArchitecture="MSIL" location="Packages/Harp.StepperDriver.0.4.0/lib/net462/Harp.StepperDriver.dll" />
<AssemblyLocation assemblyName="Hexa.NET.ImGui" processorArchitecture="MSIL" location="Packages/Hexa.NET.ImGui.2.2.9/lib/netstandard2.0/Hexa.NET.ImGui.dll" />
<AssemblyLocation assemblyName="Hexa.NET.ImGui.Backends" processorArchitecture="MSIL" location="Packages/Hexa.NET.ImGui.Backends.1.0.18/lib/netstandard2.0/Hexa.NET.ImGui.Backends.dll" />
<AssemblyLocation assemblyName="Hexa.NET.ImPlot" processorArchitecture="MSIL" location="Packages/Hexa.NET.ImPlot.2.2.9/lib/netstandard2.0/Hexa.NET.ImPlot.dll" />
Expand Down
209 changes: 146 additions & 63 deletions schema/aind_behavior_dynamic_foraging.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,7 +876,7 @@
"type": "string"
},
"quiescent_duration": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Exponential",
"distribution_parameters": {
Expand Down Expand Up @@ -907,7 +907,7 @@
"type": "number"
},
"inter_trial_interval_duration": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Exponential",
"distribution_parameters": {
Expand All @@ -924,7 +924,7 @@
"description": "Distribution describing the inter-trial interval (in seconds)."
},
"block_len": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Exponential",
"distribution_parameters": {
Expand Down Expand Up @@ -1008,58 +1008,6 @@
"title": "CoupledTrialGeneratorSpec",
"type": "object"
},
"Distribution": {
"description": "Available distributions",
"discriminator": {
"mapping": {
"Beta": "#/$defs/BetaDistribution",
"Binomial": "#/$defs/BinomialDistribution",
"Exponential": "#/$defs/ExponentialDistribution",
"Gamma": "#/$defs/GammaDistribution",
"LogNormal": "#/$defs/LogNormalDistribution",
"Normal": "#/$defs/NormalDistribution",
"Pdf": "#/$defs/PdfDistribution",
"Poisson": "#/$defs/PoissonDistribution",
"Scalar": "#/$defs/Scalar",
"Uniform": "#/$defs/UniformDistribution"
},
"propertyName": "family"
},
"oneOf": [
{
"$ref": "#/$defs/Scalar"
},
{
"$ref": "#/$defs/NormalDistribution"
},
{
"$ref": "#/$defs/LogNormalDistribution"
},
{
"$ref": "#/$defs/ExponentialDistribution"
},
{
"$ref": "#/$defs/UniformDistribution"
},
{
"$ref": "#/$defs/PoissonDistribution"
},
{
"$ref": "#/$defs/BinomialDistribution"
},
{
"$ref": "#/$defs/BetaDistribution"
},
{
"$ref": "#/$defs/GammaDistribution"
},
{
"$ref": "#/$defs/PdfDistribution"
}
],
"title": "Distribution",
"x-sgen-typename": "AllenNeuralDynamics.AindBehaviorServices.Distributions.Distribution"
},
"DynamicForagingSoundCard": {
"description": "A calibrated sound card for the dynamic foraging rig. This is a subclass of the HarpSoundCard that includes the sound card calibration.",
"properties": {
Expand Down Expand Up @@ -1946,6 +1894,32 @@
"type": "object",
"x-sgen-typename": "AllenNeuralDynamics.AindBehaviorServices.Distributions.PoissonDistributionParameters"
},
"QuickRetractSettings": {
"description": "Settings for the quick retract feature.",
"properties": {
"enable_during_quiescence": {
"default": false,
"description": "If true, the quick retract feature is enabled during the quiescence period.",
"title": "Enable During Quiescence",
"type": "boolean"
},
"time_to_reset_during_quiescence": {
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__2",
"default": 1.0,
"description": "If enable_during_quiescence is true, this is the time the spout will take to reset. If the quiescence period is shorter than this time, the spout will retract at the end of the period.",
"ge": 0,
"x-sgen-typename": "AllenNeuralDynamics.AindBehaviorServices.Distributions.Distribution"
},
"enable_on_response": {
"default": false,
"description": "If true, the quick retract feature is enabled immediately after a response is registered.",
"title": "Enable On Response",
"type": "boolean"
}
},
"title": "QuickRetractSettings",
"type": "object"
},
"Rect": {
"description": "Represents a rectangle defined by its top-left corner, width, and height.",
"properties": {
Expand Down Expand Up @@ -2778,11 +2752,17 @@
"title": "Response Deadline Duration",
"type": "number"
},
"enable_fast_retract": {
"default": false,
"description": "If true, the opposite lickspout retracts quickly after a response is made.",
"title": "Enable Fast Retract",
"type": "boolean"
"fast_retract_settings": {
"default": null,
"description": "Settings for the quick retract feature. If null, the feature will be disabled for this trial.",
"oneOf": [
{
"$ref": "#/$defs/QuickRetractSettings"
},
{
"type": "null"
}
]
},
"quiescence_period_duration": {
"default": 0.5,
Expand Down Expand Up @@ -3150,7 +3130,7 @@
"type": "string"
},
"quiescent_duration": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Exponential",
"distribution_parameters": {
Expand Down Expand Up @@ -3181,7 +3161,7 @@
"type": "number"
},
"inter_trial_interval_duration": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Exponential",
"distribution_parameters": {
Expand All @@ -3198,7 +3178,7 @@
"description": "Distribution describing the inter-trial interval (in seconds)."
},
"block_len": {
"$ref": "#/$defs/Distribution",
"$ref": "#/$defs/aind_behavior_services__task__distributions__Distribution__1",
"default": {
"family": "Scalar",
"distribution_parameters": {
Expand Down Expand Up @@ -3440,6 +3420,109 @@
},
"title": "WebCamera",
"type": "object"
},
"aind_behavior_services__task__distributions__Distribution__1": {
"description": "Available distributions",
"discriminator": {
"mapping": {
"Beta": "#/$defs/BetaDistribution",
"Binomial": "#/$defs/BinomialDistribution",
"Exponential": "#/$defs/ExponentialDistribution",
"Gamma": "#/$defs/GammaDistribution",
"LogNormal": "#/$defs/LogNormalDistribution",
"Normal": "#/$defs/NormalDistribution",
"Pdf": "#/$defs/PdfDistribution",
"Poisson": "#/$defs/PoissonDistribution",
"Scalar": "#/$defs/Scalar",
"Uniform": "#/$defs/UniformDistribution"
},
"propertyName": "family"
},
"oneOf": [
{
"$ref": "#/$defs/Scalar"
},
{
"$ref": "#/$defs/NormalDistribution"
},
{
"$ref": "#/$defs/LogNormalDistribution"
},
{
"$ref": "#/$defs/ExponentialDistribution"
},
{
"$ref": "#/$defs/UniformDistribution"
},
{
"$ref": "#/$defs/PoissonDistribution"
},
{
"$ref": "#/$defs/BinomialDistribution"
},
{
"$ref": "#/$defs/BetaDistribution"
},
{
"$ref": "#/$defs/GammaDistribution"
},
{
"$ref": "#/$defs/PdfDistribution"
}
],
"title": "Distribution",
"x-sgen-typename": "AllenNeuralDynamics.AindBehaviorServices.Distributions.Distribution"
},
"aind_behavior_services__task__distributions__Distribution__2": {
"description": "Available distributions",
"discriminator": {
"mapping": {
"Beta": "#/$defs/BetaDistribution",
"Binomial": "#/$defs/BinomialDistribution",
"Exponential": "#/$defs/ExponentialDistribution",
"Gamma": "#/$defs/GammaDistribution",
"LogNormal": "#/$defs/LogNormalDistribution",
"Normal": "#/$defs/NormalDistribution",
"Pdf": "#/$defs/PdfDistribution",
"Poisson": "#/$defs/PoissonDistribution",
"Scalar": "#/$defs/Scalar",
"Uniform": "#/$defs/UniformDistribution"
},
"propertyName": "family"
},
"oneOf": [
{
"$ref": "#/$defs/Scalar"
},
{
"$ref": "#/$defs/NormalDistribution"
},
{
"$ref": "#/$defs/LogNormalDistribution"
},
{
"$ref": "#/$defs/ExponentialDistribution"
},
{
"$ref": "#/$defs/UniformDistribution"
},
{
"$ref": "#/$defs/PoissonDistribution"
},
{
"$ref": "#/$defs/BinomialDistribution"
},
{
"$ref": "#/$defs/BetaDistribution"
},
{
"$ref": "#/$defs/GammaDistribution"
},
{
"$ref": "#/$defs/PdfDistribution"
}
],
"title": "Distribution"
}
}
}
Loading
Loading