json-schemas.task_logic

Download Schema

AindVrForagingTaskLogic

type	object
properties
name	Name
	Name of the task logic
	type	string
	default	AindVrForaging
	const	AindVrForaging
description	Description
	Description of the task.
	type	string
	default
task_parameters	Parameters of the task logic
	AindVrForagingTaskParameters
version	Version
	type	string
	default	0.6.0
	const	0.6.0
stage_name	Stage Name
	Optional stage name the Task object instance represents.
	default	null
	oneOf	type	string
		type	null
additionalProperties	False

AindVrForagingTaskParameters

type	object
properties
rng_seed	Rng Seed
	Seed of the random number generator
	default	null
	oneOf	type	number
		type	null
aind_behavior_services_pkg_version	aind_behavior_services package version
	type	string
	pattern	^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
	default	0.11.0
updaters	Updaters
	Look-up table for numeric updaters
	type	object
	additionalProperties	NumericalUpdater
environment	Statistics of the environment
	BlockStructure
task_mode_settings	Settings of the task stage
	default	task_mode	FORAGING
	TaskModeSettings
operation_control	Control of the operation
	OperationControl
additionalProperties	True

AudioControl

type	object
properties
duration	Duration
	Duration
	type	number
	minimum	0
	default	0.2
frequency	Frequency
	Frequency
	type	number
	minimum	100
	default	1000

BetaDistribution

type	object
properties
family	Family
	type	string
	default	Beta
	const	Beta
distribution_parameters	Parameters of the distribution
	default	family	Beta
		alpha	5.0
		beta	5.0
	BetaDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

BetaDistributionParameters

type	object
properties
family	Family
	type	string
	default	Beta
	const	Beta
alpha	Alpha
	Alpha parameter of the distribution
	type	number
	minimum	0
	default	5
beta	Beta
	Beta parameter of the distribution
	type	number
	minimum	0
	default	5

BinomialDistribution

type	object
properties
family	Family
	type	string
	default	Binomial
	const	Binomial
distribution_parameters	Parameters of the distribution
	default	family	Binomial
		n	1
		p	0.5
	BinomialDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

BinomialDistributionParameters

type	object
properties
family	Family
	type	string
	default	Binomial
	const	Binomial
n	N
	Number of trials
	type	integer
	minimum	0
	default	1
p	P
	Probability of success
	type	number
	maximum	1
	minimum	0
	default	0.5

Block

type	object
properties
environment_statistics	Statistics of the environment
	EnvironmentStatistics
end_conditions	End Conditions
	List of end conditions that must be true for the block to end.
	type	array
	default
	items	BlockEndCondition

BlockEndCondition

oneOf	BlockEndConditionDuration
	BlockEndConditionDistance
	BlockEndConditionChoice
	BlockEndConditionReward
	BlockEndConditionPatchCount

BlockEndConditionChoice

type	object
properties
condition_type	Condition Type
	type	string
	default	Choice
	const	Choice
value	Number of choices after which the block ends.
	Distribution

BlockEndConditionDistance

type	object
properties
condition_type	Condition Type
	type	string
	default	Distance
	const	Distance
value	Distance after which the block ends.
	Distribution

BlockEndConditionDuration

type	object
properties
condition_type	Condition Type
	type	string
	default	Duration
	const	Duration
value	Time after which the block ends.
	Distribution

BlockEndConditionPatchCount

type	object
properties
condition_type	Condition Type
	type	string
	default	PatchCount
	const	PatchCount
value	Number of patches after which the block will end.
	Distribution

BlockEndConditionReward

type	object
properties
condition_type	Condition Type
	type	string
	default	Reward
	const	Reward
value	Number of rewards after which the block ends.
	Distribution

BlockStructure

type	object
properties
blocks	Blocks
	Statistics of the environment
	type	array
	items	Block
	minItems	1
sampling_mode	Sampling Mode
	Sampling mode of the blocks.
	type	string
	enum	Random, Sequential
	default	Sequential

ConstantFunction

type	object
properties
function_type	Function Type
	type	string
	default	ConstantFunction
	const	ConstantFunction
value	Value
	Value of the function
	type	number
	default	1

DebugSettings

This class is not currently implemented
type	object
properties
task_mode	Task Mode
	type	string
	default	DEBUG
	const	DEBUG
visual_corridors	Visual Corridors
	type	array
	items	VisualCorridor
virtual_sites	Virtual Sites
	type	array
	items	VirtualSite

DepletionRule

type	string
enum	OnReward, OnChoice, OnTime, OnDistance

Distribution

Available distributions
oneOf	Scalar
	NormalDistribution
	LogNormalDistribution
	ExponentialDistribution
	UniformDistribution
	PoissonDistribution
	BinomialDistribution
	BetaDistribution
	GammaDistribution
	PdfDistribution

EnvironmentStatistics

type	object
properties
patches	Patches
	List of patches
	type	array
	items	PatchStatistics
	minItems	1
transition_matrix	Transition Matrix
	Determines the transition probabilities between patches
	type	array
	default	1
	items	type	array
		items	type	number
			minimum	0
first_state_occupancy	First State Occupancy
	Determines the first state the animal will be in. If null, it will be randomly drawn.
	default	null
	oneOf	type	array
		items	type	number
			minimum	0
		type	null

ExponentialDistribution

type	object
properties
family	Family
	type	string
	default	Exponential
	const	Exponential
distribution_parameters	Parameters of the distribution
	default	family	Exponential
		rate	0.0
	ExponentialDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

ExponentialDistributionParameters

type	object
properties
family	Family
	type	string
	default	Exponential
	const	Exponential
rate	Rate
	Rate parameter of the distribution
	type	number
	minimum	0
	default	0

ForagingSettings

type	object
properties
task_mode	Task Mode
	type	string
	default	FORAGING
	const	FORAGING

GammaDistribution

type	object
properties
family	Family
	type	string
	default	Gamma
	const	Gamma
distribution_parameters	Parameters of the distribution
	default	family	Gamma
		shape	1.0
		rate	1.0
	GammaDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

GammaDistributionParameters

type	object
properties
family	Family
	type	string
	default	Gamma
	const	Gamma
shape	Shape
	Shape parameter of the distribution
	type	number
	minimum	0
	default	1
rate	Rate
	Rate parameter of the distribution
	type	number
	minimum	0
	default	1

HabituationSettings

type	object
properties
task_mode	Task Mode
	type	string
	default	HABITUATION
	const	HABITUATION
distance_to_reward	Distance (cm) to the reward
	Distribution
render_specification	The optional render specification of the virtual site
	default	contrast	null
	RenderSpecification

LinearFunction

type	object
properties
function_type	Function Type
	type	string
	default	LinearFunction
	const	LinearFunction
minimum	Minimum
	Minimum value of the function
	type	number
	default	0
maximum	Maximum
	Maximum value of the function
	type	number
	default	9999
a	A
	Coefficient a of the function: value = a * x + b
	type	number
	default	1
b	B
	Coefficient b of the function: value = a * x + b
	type	number
	default	0

LogNormalDistribution

type	object
properties
family	Family
	type	string
	default	LogNormal
	const	LogNormal
distribution_parameters	Parameters of the distribution
	default	family	LogNormal
		mean	0.0
		std	0.0
	LogNormalDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

LogNormalDistributionParameters

type	object
properties
family	Family
	type	string
	default	LogNormal
	const	LogNormal
mean	Mean
	Mean of the distribution
	type	number
	default	0
std	Std
	Standard deviation of the distribution
	type	number
	default	0

LookupTableFunction

type	object
properties
function_type	Function Type
	type	string
	default	LookupTableFunction
	const	LookupTableFunction
lut_keys	Lut Keys
	List of keys of the lookup table
	type	array
	items	type	number
	minItems	1
lut_values	Lut Values
	List of values of the lookup table
	type	array
	items	type	number
	minItems	1

MovableSpoutControl

type	object
properties
enabled	Enabled
	Whether the movable spout is enabled
	type	boolean
	default	False
time_to_collect_after_reward	Time To Collect After Reward
	Time (s) to collect after reward
	type	number
	minimum	0
	default	1
retracting_distance	Retracting Distance
	The distance, relative to the default position, the spout will be retracted by
	type	number
	minimum	0
	default	0

NormalDistribution

type	object
properties
family	Family
	type	string
	default	Normal
	const	Normal
distribution_parameters	Parameters of the distribution
	default	family	Normal
		mean	0.0
		std	0.0
	NormalDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

NormalDistributionParameters

type	object
properties
family	Family
	type	string
	default	Normal
	const	Normal
mean	Mean
	Mean of the distribution
	type	number
	default	0
std	Std
	Standard deviation of the distribution
	type	number
	default	0

NumericalUpdater

type	object
properties
operation	Operation to perform on the parameter
	default	None
	NumericalUpdaterOperation
parameters	Parameters of the updater
	default	initial_value	0.0
		increment	0.0
		decrement	0.0
		minimum	0.0
		maximum	0.0
	NumericalUpdaterParameters

NumericalUpdaterOperation

type	string
enum	None, Offset, Gain, Set, OffsetPercentage

NumericalUpdaterParameters

type	object
properties
initial_value	Initial Value
	Initial value of the parameter
	type	number
	default	0.0
increment	Increment
	Value to increment the parameter by
	type	number
	default	0.0
decrement	Decrement
	Value to decrement the parameter by
	type	number
	default	0.0
minimum	Minimum
	Minimum value of the parameter
	type	number
	default	0.0
maximum	Maximum
	Minimum value of the parameter
	type	number
	default	0.0

OdorControl

type	object
properties
valve_max_open_time	Valve Max Open Time
	Maximum time (s) the valve can be open continuously
	type	number
	minimum	0
	default	10
target_total_flow	Target Total Flow
	Target total flow (ml/s) of the odor mixture
	type	number
	maximum	1000
	minimum	100
	default	1000
use_channel_3_as_carrier	Use Channel 3 As Carrier
	Whether to use channel 3 as carrier
	type	boolean
	default	True
target_odor_flow	Target Odor Flow
	Target odor flow (ml/s) in the odor mixture
	type	number
	maximum	100
	minimum	0
	default	100

OdorSpecification

type	object
properties
index	Index
	Index of the odor to be used
	type	integer
	maximum	3
	minimum	0
concentration	Concentration
	Concentration of the odor
	type	number
	maximum	1
	minimum	0
	default	1

OperantLogic

type	object
properties
is_operant	Is Operant
	Will the trial implement operant logic
	type	boolean
	default	True
stop_duration	Stop Duration
	Duration (s) the animal must stop for to lock its choice
	type	number
	minimum	0
	default	0
time_to_collect_reward	Time To Collect Reward
	Time(s) the animal has to collect the reward
	type	number
	minimum	0
	default	100000
grace_distance_threshold	Grace Distance Threshold
	Virtual distance (cm) the animal must be within to not abort the current choice
	type	number
	minimum	0
	default	10

OperationControl

type	object
properties
movable_spout_control	Control of the movable spout
	default	enabled	False
		time_to_collect_after_reward	1.0
		retracting_distance	0.0
	MovableSpoutControl
odor_control	Control of the odor
	default	valve_max_open_time	10.0
		target_total_flow	1000.0
		use_channel_3_as_carrier	True
		target_odor_flow	100.0
	OdorControl
position_control	Control of the position
	default	gain	x	1.0
			y	1.0
			z	1.0
		initial_position	x	0.0
			y	2.56
			z	0.0
		frequency_filter_cutoff	0.5
		velocity_threshold	1.0
	PositionControl
audio_control	Control of the audio
	default	duration	0.2
		frequency	1000.0
	AudioControl

PatchRewardFunction

type	object
properties
amount	Determines the amount of reward to be delivered. The value is in microliters
	default	function_type	ConstantFunction
		value	1.0
	RewardFunction
probability	Determines the probability that a reward will be delivered
	default	function_type	ConstantFunction
		value	1.0
	RewardFunction
available	Determines the total amount of reward available left in the patch. The value is in microliters
	default	function_type	LinearFunction
		minimum	0.0
		maximum	9999.0
		a	-1.0
		b	5.0
	RewardFunction
depletion_rule	Depletion
	default	OnChoice
	DepletionRule

PatchStatistics

type	object
properties
label	Label
	Label of the patch
	type	string
	default
state_index	State Index
	Index of the state
	type	integer
	minimum	0
	default	0
odor_specification	The optional odor specification of the patch
	default	null
	oneOf	OdorSpecification
		type	null
reward_specification	The optional reward specification of the patch
	default	null
	oneOf	RewardSpecification
		type	null
virtual_site_generation	Virtual site generation specification
	default	inter_site	label	InterSite
			length_distribution	distribution_parameters	family	Scalar
					value	20.0
				family	Scalar
				scaling_parameters	null
				truncation_parameters	null
			render_specification	contrast	null
			treadmill_specification	null
		inter_patch	label	InterPatch
			length_distribution	distribution_parameters	family	Scalar
					value	20.0
				family	Scalar
				scaling_parameters	null
				truncation_parameters	null
			render_specification	contrast	null
			treadmill_specification	null
		post_patch	null
		reward_site	label	RewardSite
			length_distribution	distribution_parameters	family	Scalar
					value	20.0
				family	Scalar
				scaling_parameters	null
				truncation_parameters	null
			render_specification	contrast	null
			treadmill_specification	null
	VirtualSiteGeneration

PdfDistribution

type	object
properties
family	Family
	type	string
	default	Pdf
	const	Pdf
distribution_parameters	Parameters of the distribution
	default	family	Pdf
		pdf	1.0
		index	0.0
	PdfDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

PdfDistributionParameters

type	object
properties
family	Family
	type	string
	default	Pdf
	const	Pdf
pdf	Pdf
	The probability density function
	type	array
	default	1
	items	type	number
		minimum	0
index	Index
	The index of the probability density function
	type	array
	default	0
	items	type	number

PoissonDistribution

type	object
properties
family	Family
	type	string
	default	Poisson
	const	Poisson
distribution_parameters	Parameters of the distribution
	default	family	Poisson
		rate	1.0
	PoissonDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

PoissonDistributionParameters

type	object
properties
family	Family
	type	string
	default	Poisson
	const	Poisson
rate	Rate
	Rate parameter of the Poisson process that generates the distribution
	type	number
	minimum	0
	default	1

PositionControl

type	object
properties
gain	Gain of the position control.
	default	x	1.0
		y	1.0
		z	1.0
	Vector3
initial_position	Gain of the position control.
	default	x	0.0
		y	2.56
		z	0.0
	Vector3
frequency_filter_cutoff	Frequency Filter Cutoff
	Cutoff frequency (Hz) of the low-pass filter used to filter the velocity signal.
	type	number
	maximum	100
	minimum	0
	default	0.5
velocity_threshold	Velocity Threshold
	Threshold (cm/s) of the velocity signal used to detect when the animal is moving.
	type	number
	minimum	0
	default	1

PowerFunction

type	object
properties
function_type	Function Type
	type	string
	default	PowerFunction
	const	PowerFunction
minimum	Minimum
	Minimum value of the function
	type	number
	default	0
maximum	Maximum
	Maximum value of the function
	type	number
	default	1
a	A
	Coefficient a of the function: value = a * pow(b, c * x) + d
	type	number
	default	1
b	B
	Coefficient b of the function: value = a * pow(b, c * x) + d
	type	number
	default	2.718281828459045
c	C
	Coefficient c of the function: value = a * pow(b, c * x) + d
	type	number
	default	-1
d	D
	Coefficient d of the function: value = a * pow(b, c * x) + d
	type	number
	default	0

RenderSpecification

type	object
properties
contrast	Contrast
	Contrast of the texture
	default	null
	oneOf	type	number
		maximum	1
		minimum	0
		type	null

RewardFunction

oneOf	ConstantFunction
	LinearFunction
	PowerFunction
	LookupTableFunction

RewardSpecification

type	object
properties
operant_logic	The optional operant logic of the reward
	default	null
	oneOf	OperantLogic
		type	null
delay	The optional distribution where the delay to reward will be drawn from
	default	family	Scalar
		distribution_parameters	family	Scalar
			value	0.0
		truncation_parameters	null
		scaling_parameters	null
	Distribution
reward_function	Reward function of the patch.
	default	amount	function_type	ConstantFunction
			value	1.0
		probability	function_type	ConstantFunction
			value	1.0
		available	a	-1.0
			b	5.0
			function_type	LinearFunction
			maximum	9999.0
			minimum	0.0
		depletion_rule	OnChoice
	PatchRewardFunction

Scalar

type	object
properties
family	Family
	type	string
	default	Scalar
	const	Scalar
distribution_parameters	Parameters of the distribution
	default	family	Scalar
		value	0.0
	ScalarDistributionParameter
truncation_parameters	Truncation Parameters
	type	null
	default	null
	const	None
scaling_parameters	Scaling Parameters
	type	null
	default	null
	const	None

ScalarDistributionParameter

type	object
properties
family	Family
	type	string
	default	Scalar
	const	Scalar
value	Value
	The static value of the distribution
	type	number
	default	0

ScalingParameters

type	object
properties
scale	Scale
	Scaling factor to apply on the sampled distribution
	type	number
	default	1
offset	Offset
	Offset factor to apply on the sampled distribution
	type	number
	default	0

Size

type	object
properties
width	Width
	Width of the texture
	type	number
	default	0
height	Height
	Height of the texture
	type	number
	default	0

TaskModeSettings

oneOf	HabituationSettings
	ForagingSettings
	DebugSettings

Texture

type	object
properties
name	Name
	Name of the texture
	type	string
	default	default
size	Size of the texture
	default	width	40.0
		height	40.0
	Size

TreadmillSpecification

type	object
properties
friction	Friction of the treadmill (0-1). The drawn value must be between 0 and 1
	default	null
	oneOf	Distribution
		type	null

TruncationParameters

type	object
properties
is_truncated	Is Truncated
	Whether the distribution is truncated
	type	boolean
	default	False
min	Min
	Minimum value of the sampled distribution
	type	number
	default	0
max	Max
	Maximum value of the sampled distribution
	type	number
	default	0

UniformDistribution

type	object
properties
family	Family
	type	string
	default	Uniform
	const	Uniform
distribution_parameters	Parameters of the distribution
	default	family	Uniform
		min	0.0
		max	0.0
	UniformDistributionParameters
truncation_parameters	Truncation parameters of the distribution
	default	null
	oneOf	TruncationParameters
		type	null
scaling_parameters	Scaling parameters of the distribution
	default	null
	oneOf	ScalingParameters
		type	null

UniformDistributionParameters

type	object
properties
family	Family
	type	string
	default	Uniform
	const	Uniform
min	Min
	Minimum value of the distribution
	type	number
	default	0
max	Max
	Maximum value of the distribution
	type	number
	default	0

UpdaterTarget

type	string
enum	StopDurationOffset, StopVelocityThreshold, RewardDelayOffset

Vector3

type	object
properties
x	X
	X coordinate of the point
	type	number
	default	0
y	Y
	Y coordinate of the point
	type	number
	default	0
z	Z
	Z coordinate of the point
	type	number
	default	0

VirtualSite

type	object
properties
id	Id
	Id of the virtual site
	type	integer
	minimum	0
	default	0
label	Label of the virtual site
	default	Unspecified
	VirtualSiteLabels
length	Length
	Length of the virtual site (cm)
	type	number
	default	20
start_position	Start Position
	Start position of the virtual site (cm)
	type	number
	minimum	0
	default	0
odor_specification	The optional odor specification of the virtual site
	default	null
	oneOf	OdorSpecification
		type	null
reward_specification	The optional reward specification of the virtual site
	default	null
	oneOf	RewardSpecification
		type	null
render_specification	The optional render specification of the virtual site
	default	contrast	null
	RenderSpecification
treadmill_specification	Treadmill specification
	default	null
	oneOf	TreadmillSpecification
		type	null

VirtualSiteGeneration

type	object
properties
inter_site	Generator of the inter-site virtual sites
	default	render_specification	contrast	null
		label	InterSite
		length_distribution	distribution_parameters	family	Scalar
				value	20.0
			family	Scalar
			scaling_parameters	null
			truncation_parameters	null
		treadmill_specification	null
	VirtualSiteGenerator
inter_patch	Generator of the inter-patch virtual sites
	default	render_specification	contrast	null
		label	InterPatch
		length_distribution	distribution_parameters	family	Scalar
				value	20.0
			family	Scalar
			scaling_parameters	null
			truncation_parameters	null
		treadmill_specification	null
	VirtualSiteGenerator
post_patch	Generator of the post-patch virtual sites
	default	null
	oneOf	VirtualSiteGenerator
		type	null
reward_site	Generator of the reward-site virtual sites
	default	render_specification	contrast	null
		label	RewardSite
		length_distribution	distribution_parameters	family	Scalar
				value	20.0
			family	Scalar
			scaling_parameters	null
			truncation_parameters	null
		treadmill_specification	null
	VirtualSiteGenerator

VirtualSiteGenerator

type	object
properties
render_specification	Contrast of the environment
	default	contrast	null
	RenderSpecification
label	Label of the virtual site
	default	Unspecified
	VirtualSiteLabels
length_distribution	Distribution of the length of the virtual site
	default	family	Scalar
		distribution_parameters	family	Scalar
			value	20.0
		truncation_parameters	null
		scaling_parameters	null
	Distribution
treadmill_specification	Treadmill specification
	default	null
	oneOf	TreadmillSpecification
		type	null

VirtualSiteLabels

type	string
enum	Unspecified, InterPatch, PostPatch, RewardSite, InterSite

VisualCorridor

type	object
properties
id	Id
	Id of the visual corridor object
	type	integer
	minimum	0
	default	0
size	Size of the corridor (cm)
	default	width	40.0
		height	40.0
	Size
start_position	Start Position
	Start position of the corridor (cm)
	type	number
	minimum	0
	default	0
length	Length
	Length of the corridor site (cm)
	type	number
	minimum	0
	default	120
textures	The textures of the corridor
	WallTextures

WallTextures

type	object
properties
floor	The texture of the floor
	Texture
ceiling	The texture of the ceiling
	Texture
left	The texture of the left
	Texture
right	The texture of the right
	Texture