json-schemas.task_logic¶
AindForceForagingTaskLogic¶
type |
object |
||
properties |
|||
|
Name |
||
Name of the task logic |
|||
type |
string |
||
default |
AindForceForaging |
||
|
Description |
||
Description of the task. |
|||
type |
string |
||
default |
|||
|
Parameters of the task logic |
||
allOf |
|||
|
Version |
||
type |
string |
||
default |
0.1.0-preview01 |
||
const |
0.1.0-preview01 |
||
|
Stage Name |
||
Optional stage name the Task object instance represents. |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
additionalProperties |
False |
ActionUpdater¶
type |
object |
|
properties |
||
|
Target parameter |
|
default |
Probability |
|
allOf |
||
|
Independent variable |
|
default |
Time |
|
allOf |
||
|
Updater |
|
allOf |
AindForceForagingTaskParameters¶
type |
object |
|||
properties |
||||
|
Rng Seed |
|||
Seed of the random number generator |
||||
default |
null |
|||
oneOf |
type |
number |
||
type |
null |
|||
|
Environment settings |
|||
allOf |
||||
|
Updaters |
|||
List of numerical updaters |
||||
type |
object |
|||
additionalProperties |
||||
|
Operation control |
|||
default |
force |
force_lookup_table |
null |
|
left_index |
0 |
|||
press_mode |
Double |
|||
right_index |
1 |
|||
spout |
default_extended_position |
0.0 |
||
default_retracted_position |
0.0 |
|||
enabled |
True |
|||
allOf |
||||
additionalProperties |
True |
AudioFeedback¶
type |
object |
||
properties |
|||
|
Continuous Feedback Mode |
||
type |
string |
||
default |
Audio |
||
const |
Audio |
||
|
Converter Lut Input |
||
Input domain. All values should be between 0 and 1 |
|||
type |
array |
||
default |
0 |
||
1 |
|||
items |
type |
number |
|
maximum |
1.0 |
||
minimum |
0.0 |
||
minItems |
2 |
||
|
Converter Lut Output |
||
Output domain used to linearly interpolate the input values to the output values |
|||
type |
array |
||
default |
0 |
||
1 |
|||
items |
type |
number |
|
minItems |
2 |
BetaDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Beta |
||
const |
Beta |
||
|
Parameters of the distribution |
||
default |
family |
Beta |
|
alpha |
5.0 |
||
beta |
5.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
BetaDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Beta |
|
const |
Beta |
|
|
Alpha |
|
Alpha parameter of the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
5 |
|
|
Beta |
|
Beta parameter of the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
5 |
BinomialDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Binomial |
||
const |
Binomial |
||
|
Parameters of the distribution |
||
default |
family |
Binomial |
|
n |
1 |
||
p |
0.5 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
BinomialDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Binomial |
|
const |
Binomial |
|
|
N |
|
Number of trials |
||
type |
integer |
|
minimum |
0 |
|
default |
1 |
|
|
P |
|
Probability of success |
||
type |
number |
|
maximum |
1.0 |
|
minimum |
0.0 |
|
default |
0.5 |
Block¶
type |
object |
||
properties |
|||
|
Mode |
||
type |
string |
||
default |
Block |
||
const |
Block |
||
|
Is Baited |
||
Whether the trials are baited |
|||
type |
boolean |
||
default |
False |
||
|
Trials |
||
List of trials in the block |
|||
type |
array |
||
default |
|||
items |
|||
|
Shuffle |
||
Whether to shuffle the trials in the block |
|||
type |
boolean |
||
default |
False |
||
|
Repeat Count |
||
Number of times to repeat the block. If null, the block will be repeated indefinitely |
|||
default |
0 |
||
oneOf |
type |
integer |
|
type |
null |
BlockGenerator¶
type |
object |
|||
properties |
||||
|
Mode |
|||
type |
string |
|||
default |
BlockGenerator |
|||
const |
BlockGenerator |
|||
|
Is Baited |
|||
Whether the trials are baited |
||||
type |
boolean |
|||
default |
False |
|||
|
Size of the block |
|||
default |
family |
Uniform |
||
distribution_parameters |
family |
Uniform |
||
max |
60.0 |
|||
min |
50.0 |
|||
truncation_parameters |
null |
|||
scaling_parameters |
null |
|||
allOf |
||||
|
Statistics of the trials in the block |
|||
allOf |
BlockStatistics¶
BrownianRandomWalk¶
type |
object |
|||
properties |
||||
|
Mode |
|||
type |
string |
|||
default |
BrownianRandomWalk |
|||
const |
BrownianRandomWalk |
|||
|
Is Baited |
|||
Whether the trials are baited |
||||
type |
boolean |
|||
default |
False |
|||
|
Size of the block |
|||
default |
family |
Uniform |
||
distribution_parameters |
family |
Uniform |
||
max |
60.0 |
|||
min |
50.0 |
|||
truncation_parameters |
null |
|||
scaling_parameters |
null |
|||
allOf |
||||
|
Statistics of the trials in the block |
|||
allOf |
ContinuousFeedback¶
Distribution¶
Environment¶
type |
object |
||
properties |
|||
|
Block Statistics |
||
Statistics of the environment |
|||
type |
array |
||
items |
|||
|
Shuffle |
||
Whether to shuffle the blocks |
|||
type |
boolean |
||
default |
False |
||
|
Repeat Count |
||
Number of times to repeat the environment. If null, the environment will be repeated indefinitely |
|||
default |
0 |
||
oneOf |
type |
integer |
|
type |
null |
ExponentialDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Exponential |
||
const |
Exponential |
||
|
Parameters of the distribution |
||
default |
family |
Exponential |
|
rate |
0.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
ExponentialDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Exponential |
|
const |
Exponential |
|
|
Rate |
|
Rate parameter of the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
0 |
ForceLookUpTable¶
type |
object |
|
properties |
||
|
Path |
|
Reference to the look up table image. Should be a 1 channel image. Value = LUT[Left, Right] |
||
type |
string |
|
|
Offset |
|
Offset to add to the look up table value |
||
type |
number |
|
default |
0 |
|
|
Scale |
|
Scale to multiply the look up table value |
||
type |
number |
|
default |
1 |
|
|
Left Min |
|
The lower value of Left force used to linearly scale the input coordinate to. |
||
type |
number |
|
|
Left Max |
|
The upper value of Left force used to linearly scale the input coordinate to. |
||
type |
number |
|
|
Right Min |
|
The lower value of Right force used to linearly scale the input coordinate to. |
||
type |
number |
|
|
Right Max |
|
The upper value of Right force used to linearly scale the input coordinate to. |
||
type |
number |
ForceOperationControl¶
type |
object |
||
properties |
|||
|
Defines the press mode. Default is to use both sensors individually |
||
default |
Double |
||
allOf |
|||
|
Left Index |
||
Index of the left sensor |
|||
type |
integer |
||
default |
0 |
||
|
Right Index |
||
Index of the right sensor |
|||
type |
integer |
||
default |
1 |
||
|
Look up table for force projection |
||
default |
null |
||
oneOf |
|||
type |
null |
GammaDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Gamma |
||
const |
Gamma |
||
|
Parameters of the distribution |
||
default |
family |
Gamma |
|
shape |
1.0 |
||
rate |
1.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
GammaDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Gamma |
|
const |
Gamma |
|
|
Shape |
|
Shape parameter of the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
1 |
|
|
Rate |
|
Rate parameter of the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
1 |
HarvestAction¶
Defines an abstract class for an harvest action |
|||
type |
object |
||
properties |
|||
|
Label of the action |
||
default |
None |
||
allOf |
|||
|
Type of the trial |
||
default |
None |
||
allOf |
|||
|
Probability |
||
Probability of reward |
|||
type |
number |
||
default |
1 |
||
|
Amount |
||
Amount of reward to be delivered |
|||
type |
number |
||
default |
1 |
||
|
Delay |
||
Delay between successful harvest and reward delivery |
|||
type |
number |
||
default |
0 |
||
|
Force Duration |
||
Duration that the force much stay above threshold |
|||
type |
number |
||
default |
0.5 |
||
|
Upper Force Threshold |
||
Upper bound of the force target region or the target cached force required. |
|||
type |
number |
||
maximum |
32768.0 |
||
minimum |
-32768.0 |
||
default |
32768 |
||
|
Lower Force Threshold |
||
Lower bound of the force target region. |
|||
type |
number |
||
maximum |
32768.0 |
||
minimum |
-32768.0 |
||
default |
5000 |
||
|
Is Operant |
||
Whether the reward delivery is contingent on licking. |
|||
type |
boolean |
||
default |
True |
||
|
Time To Collect |
||
Time to collect the reward after it is available. If null, the reward will be available indefinitely. |
|||
default |
null |
||
oneOf |
type |
number |
|
minimum |
0.0 |
||
type |
null |
||
|
Action Updaters |
||
List of action updaters. All updaters are called at the start of a new trial. |
|||
type |
array |
||
default |
|||
items |
|||
|
Continuous feedback settings |
||
default |
null |
||
oneOf |
|||
type |
null |
HarvestActionLabel¶
Defines the harvest actions |
|
type |
string |
enum |
Left, Right, None |
InitiationPeriod¶
Defines an initiation period |
||
type |
object |
|
properties |
||
|
Duration |
|
Duration of the initiation period |
||
type |
number |
|
minimum |
0.0 |
|
default |
0 |
|
|
Has Cue |
|
Whether to use a cue to signal the start of the period. |
||
type |
boolean |
|
default |
True |
|
|
Abort On Force |
|
Whether to abort the trial if a choice is made during the initiation period. |
||
type |
boolean |
|
default |
False |
|
|
Abort On Force Threshold |
|
Time out for the quiescence period |
||
type |
number |
|
maximum |
32768.0 |
|
minimum |
-32768.0 |
|
default |
0 |
LogNormalDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
LogNormal |
||
const |
LogNormal |
||
|
Parameters of the distribution |
||
default |
family |
LogNormal |
|
mean |
0.0 |
||
std |
0.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
LogNormalDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
LogNormal |
|
const |
LogNormal |
|
|
Mean |
|
Mean of the distribution |
||
type |
number |
|
default |
0 |
|
|
Std |
|
Standard deviation of the distribution |
||
type |
number |
|
default |
0 |
ManipulatorFeedback¶
type |
object |
||
properties |
|||
|
Continuous Feedback Mode |
||
type |
string |
||
default |
Manipulator |
||
const |
Manipulator |
||
|
Converter Lut Input |
||
Input domain. All values should be between 0 and 1 |
|||
type |
array |
||
default |
0 |
||
1 |
|||
items |
type |
number |
|
maximum |
1.0 |
||
minimum |
0.0 |
||
minItems |
2 |
||
|
Converter Lut Output |
||
Output domain used to linearly interpolate the input values to the output values |
|||
type |
array |
||
default |
0 |
||
1 |
|||
items |
type |
number |
|
minItems |
2 |
NormalDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Normal |
||
const |
Normal |
||
|
Parameters of the distribution |
||
default |
family |
Normal |
|
mean |
0.0 |
||
std |
0.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
NormalDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Normal |
|
const |
Normal |
|
|
Mean |
|
Mean of the distribution |
||
type |
number |
|
default |
0 |
|
|
Std |
|
Standard deviation of the distribution |
||
type |
number |
|
default |
0 |
NumericalUpdater¶
type |
object |
||||
properties |
|||||
|
Operation to perform on the parameter |
||||
default |
None |
||||
allOf |
|||||
|
Parameters of the updater |
||||
default |
value |
distribution_parameters |
family |
Scalar |
|
value |
0.0 |
||||
family |
Scalar |
||||
scaling_parameters |
null |
||||
truncation_parameters |
null |
||||
minimum |
0.0 |
||||
maximum |
0.0 |
||||
allOf |
NumericalUpdaterOperation¶
type |
string |
enum |
None, Offset, Gain, Set |
NumericalUpdaterParameters¶
type |
object |
|||
properties |
||||
|
The value of the update. This value will be multiplied by the optional input event value. |
|||
default |
family |
Scalar |
||
distribution_parameters |
family |
Scalar |
||
value |
0.0 |
|||
truncation_parameters |
null |
|||
scaling_parameters |
null |
|||
allOf |
||||
|
Minimum |
|||
Minimum value of the parameter |
||||
type |
number |
|||
default |
0 |
|||
|
Maximum |
|||
Maximum value of the parameter |
||||
type |
number |
|||
default |
0 |
OperationControl¶
type |
object |
||
properties |
|||
|
Operation control for force sensor |
||
default |
press_mode |
Double |
|
left_index |
0 |
||
right_index |
1 |
||
force_lookup_table |
null |
||
allOf |
|||
|
Operation control for spout |
||
default |
default_retracted_position |
0.0 |
|
default_extended_position |
0.0 |
||
enabled |
True |
||
allOf |
PoissonDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Poisson |
||
const |
Poisson |
||
|
Parameters of the distribution |
||
default |
family |
Poisson |
|
rate |
1.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
PoissonDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Poisson |
|
const |
Poisson |
|
|
Rate |
|
Rate parameter of the Poisson process that generates the distribution |
||
type |
number |
|
minimum |
0.0 |
|
default |
1 |
PressMode¶
Defines the press mode |
|
type |
string |
enum |
Double, SingleAverage, SingleMax, SingleMin, SingleLeft, SingleRight, SingleLookupTable |
QuiescencePeriod¶
Defines a quiescence settings |
||
type |
object |
|
properties |
||
|
Duration |
|
Duration of the quiescence period |
||
type |
number |
|
minimum |
0.0 |
|
default |
0 |
|
|
Force Threshold |
|
Time out for the quiescence period |
||
type |
number |
|
maximum |
32768.0 |
|
minimum |
-32768.0 |
|
default |
0 |
|
|
Has Cue |
|
Whether to use a cue to signal the start of the period. |
||
type |
boolean |
|
default |
False |
ResponsePeriod¶
Defines a response period |
||
type |
object |
|
properties |
||
|
Duration |
|
Duration of the response period. I.e. the time the animal has to make a choice. |
||
type |
number |
|
minimum |
0.0 |
|
default |
0 |
|
|
Has Cue |
|
Whether to use a cue to signal the start of the period. |
||
type |
boolean |
|
default |
True |
|
|
Has Feedback |
|
Whether to provide feedback to the animal after the response period. |
||
type |
boolean |
|
default |
False |
Scalar¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Scalar |
||
const |
Scalar |
||
|
Parameters of the distribution |
||
default |
family |
Scalar |
|
value |
0.0 |
||
allOf |
|||
|
Truncation Parameters |
||
type |
null |
||
default |
null |
||
const |
None |
||
|
Scaling Parameters |
||
type |
null |
||
default |
null |
||
const |
None |
ScalarDistributionParameter¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Scalar |
|
const |
Scalar |
|
|
Value |
|
The static value of the distribution |
||
type |
number |
|
default |
0 |
ScalingParameters¶
type |
object |
|
properties |
||
|
Scale |
|
Scaling factor to apply on the sampled distribution |
||
type |
number |
|
default |
1 |
|
|
Offset |
|
Offset factor to apply on the sampled distribution |
||
type |
number |
|
default |
0 |
SpoutOperationControl¶
type |
object |
|
properties |
||
|
Default Retracted Position |
|
Default retracted position (mm) |
||
type |
number |
|
default |
0 |
|
|
Default Extended Position |
|
Default extended position (mm) |
||
type |
number |
|
default |
0 |
|
|
Enabled |
|
Whether the spout control is enabled |
||
type |
boolean |
|
default |
True |
Trial¶
Defines a trial |
|||
type |
object |
||
properties |
|||
|
Inter Trial Interval |
||
Time between trials |
|||
type |
number |
||
minimum |
0.0 |
||
default |
0 |
||
|
Quiescence settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Initiation settings |
||
default |
duration |
0.0 |
|
has_cue |
True |
||
abort_on_force |
False |
||
abort_on_force_threshold |
0.0 |
||
allOf |
|||
|
Response settings |
||
default |
duration |
0.0 |
|
has_cue |
True |
||
has_feedback |
False |
||
allOf |
|||
|
Specification of the left action |
||
default |
action |
Left |
|
trial_type |
None |
||
probability |
1.0 |
||
amount |
1.0 |
||
delay |
0.0 |
||
force_duration |
0.5 |
||
upper_force_threshold |
32768.0 |
||
lower_force_threshold |
5000.0 |
||
is_operant |
True |
||
time_to_collect |
null |
||
action_updaters |
|||
continuous_feedback |
null |
||
oneOf |
|||
type |
null |
||
|
Specification of the right action |
||
default |
action |
Right |
|
trial_type |
None |
||
probability |
1.0 |
||
amount |
1.0 |
||
delay |
0.0 |
||
force_duration |
0.5 |
||
upper_force_threshold |
32768.0 |
||
lower_force_threshold |
5000.0 |
||
is_operant |
True |
||
time_to_collect |
null |
||
action_updaters |
|||
continuous_feedback |
null |
||
oneOf |
|||
type |
null |
TrialType¶
Defines the trial types |
|
type |
string |
enum |
None, Accumulation, RegionOfInterest |
TruncationParameters¶
type |
object |
|
properties |
||
|
Is Truncated |
|
Whether the distribution is truncated |
||
type |
boolean |
|
default |
False |
|
|
Min |
|
Minimum value of the sampled distribution |
||
type |
number |
|
default |
0 |
|
|
Max |
|
Maximum value of the sampled distribution |
||
type |
number |
|
default |
0 |
UniformDistribution¶
type |
object |
||
properties |
|||
|
Family |
||
type |
string |
||
default |
Uniform |
||
const |
Uniform |
||
|
Parameters of the distribution |
||
default |
family |
Uniform |
|
min |
0.0 |
||
max |
0.0 |
||
allOf |
|||
|
Truncation parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Scaling parameters of the distribution |
||
default |
null |
||
oneOf |
|||
type |
null |
UniformDistributionParameters¶
type |
object |
|
properties |
||
|
Family |
|
type |
string |
|
default |
Uniform |
|
const |
Uniform |
|
|
Min |
|
Minimum value of the distribution |
||
type |
number |
|
default |
0 |
|
|
Max |
|
Maximum value of the distribution |
||
type |
number |
|
default |
0 |
UpdateTargetParameter¶
Defines the target parameters |
|
type |
string |
enum |
LowerForceThreshold, UpperForceThreshold, Probability, Amount, ForceDuration, Delay |
UpdateTargetParameterBy¶
Defines the independent variable used for the update |
|
type |
string |
enum |
Time, Reward, Trial |