json-schemas.task_logic

Download Schema

AindForceForagingTaskLogic

type

object

properties

  • name

Name

Name of the task logic

type

string

default

AindForceForaging

  • description

Description

Description of the task.

type

string

default

  • task_parameters

Parameters of the task logic

allOf

AindForceForagingTaskParameters

  • version

Version

type

string

default

0.1.0-preview01

const

0.1.0-preview01

  • stage_name

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

Target parameter

default

Probability

allOf

UpdateTargetParameter

  • updated_by

Independent variable

default

Time

allOf

UpdateTargetParameterBy

  • updater

Updater

allOf

NumericalUpdater

AindForceForagingTaskParameters

type

object

properties

  • rng_seed

Rng Seed

Seed of the random number generator

default

null

oneOf

type

number

type

null

  • environment

Environment settings

allOf

Environment

  • updaters

Updaters

List of numerical updaters

type

object

additionalProperties

NumericalUpdater

  • operation_control

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

OperationControl

additionalProperties

True

AudioFeedback

type

object

properties

  • continuous_feedback_mode

Continuous Feedback Mode

type

string

default

Audio

const

Audio

  • converter_lut_input

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

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

Family

type

string

default

Beta

const

Beta

  • distribution_parameters

Parameters of the distribution

default

family

Beta

alpha

5.0

beta

5.0

allOf

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.0

default

5

  • beta

Beta

Beta parameter of the distribution

type

number

minimum

0.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

allOf

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.0

minimum

0.0

default

0.5

Block

type

object

properties

  • mode

Mode

type

string

default

Block

const

Block

  • is_baited

Is Baited

Whether the trials are baited

type

boolean

default

False

  • trials

Trials

List of trials in the block

type

array

default

items

Trial

  • shuffle

Shuffle

Whether to shuffle the trials in the block

type

boolean

default

False

  • repeat_count

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

Mode

type

string

default

BlockGenerator

const

BlockGenerator

  • is_baited

Is Baited

Whether the trials are baited

type

boolean

default

False

  • block_size

Size of the block

default

family

Uniform

distribution_parameters

family

Uniform

max

60.0

min

50.0

truncation_parameters

null

scaling_parameters

null

allOf

Distribution

  • trial_statistics

Statistics of the trials in the block

allOf

Trial

BlockStatistics

BrownianRandomWalk

type

object

properties

  • mode

Mode

type

string

default

BrownianRandomWalk

const

BrownianRandomWalk

  • is_baited

Is Baited

Whether the trials are baited

type

boolean

default

False

  • block_size

Size of the block

default

family

Uniform

distribution_parameters

family

Uniform

max

60.0

min

50.0

truncation_parameters

null

scaling_parameters

null

allOf

Distribution

  • trial_statistics

Statistics of the trials in the block

allOf

Trial

ContinuousFeedback

Distribution

Environment

type

object

properties

  • block_statistics

Block Statistics

Statistics of the environment

type

array

items

BlockStatistics

  • shuffle

Shuffle

Whether to shuffle the blocks

type

boolean

default

False

  • repeat_count

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

Family

type

string

default

Exponential

const

Exponential

  • distribution_parameters

Parameters of the distribution

default

family

Exponential

rate

0.0

allOf

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.0

default

0

ForceLookUpTable

type

object

properties

  • path

Path

Reference to the look up table image. Should be a 1 channel image. Value = LUT[Left, Right]

type

string

  • offset

Offset

Offset to add to the look up table value

type

number

default

0

  • scale

Scale

Scale to multiply the look up table value

type

number

default

1

  • left_min

Left Min

The lower value of Left force used to linearly scale the input coordinate to.

type

number

  • left_max

Left Max

The upper value of Left force used to linearly scale the input coordinate to.

type

number

  • right_min

Right Min

The lower value of Right force used to linearly scale the input coordinate to.

type

number

  • right_max

Right Max

The upper value of Right force used to linearly scale the input coordinate to.

type

number

ForceOperationControl

type

object

properties

  • press_mode

Defines the press mode. Default is to use both sensors individually

default

Double

allOf

PressMode

  • left_index

Left Index

Index of the left sensor

type

integer

default

0

  • right_index

Right Index

Index of the right sensor

type

integer

default

1

  • force_lookup_table

Look up table for force projection

default

null

oneOf

ForceLookUpTable

type

null

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

allOf

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.0

default

1

  • rate

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

  • action

Label of the action

default

None

allOf

HarvestActionLabel

  • trial_type

Type of the trial

default

None

allOf

TrialType

  • probability

Probability

Probability of reward

type

number

default

1

  • amount

Amount

Amount of reward to be delivered

type

number

default

1

  • delay

Delay

Delay between successful harvest and reward delivery

type

number

default

0

  • force_duration

Force Duration

Duration that the force much stay above threshold

type

number

default

0.5

  • upper_force_threshold

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 Force Threshold

Lower bound of the force target region.

type

number

maximum

32768.0

minimum

-32768.0

default

5000

  • is_operant

Is Operant

Whether the reward delivery is contingent on licking.

type

boolean

default

True

  • time_to_collect

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

Action Updaters

List of action updaters. All updaters are called at the start of a new trial.

type

array

default

items

ActionUpdater

  • continuous_feedback

Continuous feedback settings

default

null

oneOf

ContinuousFeedback

type

null

HarvestActionLabel

Defines the harvest actions

type

string

enum

Left, Right, None

InitiationPeriod

Defines an initiation period

type

object

properties

  • duration

Duration

Duration of the initiation period

type

number

minimum

0.0

default

0

  • has_cue

Has Cue

Whether to use a cue to signal the start of the period.

type

boolean

default

True

  • abort_on_force

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

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

Family

type

string

default

LogNormal

const

LogNormal

  • distribution_parameters

Parameters of the distribution

default

family

LogNormal

mean

0.0

std

0.0

allOf

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

ManipulatorFeedback

type

object

properties

  • continuous_feedback_mode

Continuous Feedback Mode

type

string

default

Manipulator

const

Manipulator

  • converter_lut_input

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

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

Family

type

string

default

Normal

const

Normal

  • distribution_parameters

Parameters of the distribution

default

family

Normal

mean

0.0

std

0.0

allOf

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

allOf

NumericalUpdaterOperation

  • parameters

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

NumericalUpdaterParameters

NumericalUpdaterOperation

type

string

enum

None, Offset, Gain, Set

NumericalUpdaterParameters

type

object

properties

  • value

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

Distribution

  • minimum

Minimum

Minimum value of the parameter

type

number

default

0

  • maximum

Maximum

Maximum value of the parameter

type

number

default

0

OperationControl

type

object

properties

  • force

Operation control for force sensor

default

press_mode

Double

left_index

0

right_index

1

force_lookup_table

null

allOf

ForceOperationControl

  • spout

Operation control for spout

default

default_retracted_position

0.0

default_extended_position

0.0

enabled

True

allOf

SpoutOperationControl

PoissonDistribution

type

object

properties

  • family

Family

type

string

default

Poisson

const

Poisson

  • distribution_parameters

Parameters of the distribution

default

family

Poisson

rate

1.0

allOf

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.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

Duration of the quiescence period

type

number

minimum

0.0

default

0

  • force_threshold

Force Threshold

Time out for the quiescence period

type

number

maximum

32768.0

minimum

-32768.0

default

0

  • has_cue

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

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

Has Cue

Whether to use a cue to signal the start of the period.

type

boolean

default

True

  • has_feedback

Has Feedback

Whether to provide feedback to the animal after the response period.

type

boolean

default

False

Scalar

type

object

properties

  • family

Family

type

string

default

Scalar

const

Scalar

  • distribution_parameters

Parameters of the distribution

default

family

Scalar

value

0.0

allOf

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

SpoutOperationControl

type

object

properties

  • default_retracted_position

Default Retracted Position

Default retracted position (mm)

type

number

default

0

  • default_extended_position

Default Extended Position

Default extended position (mm)

type

number

default

0

  • enabled

Enabled

Whether the spout control is enabled

type

boolean

default

True

Trial

Defines a trial

type

object

properties

  • inter_trial_interval

Inter Trial Interval

Time between trials

type

number

minimum

0.0

default

0

  • quiescence_period

Quiescence settings

default

null

oneOf

QuiescencePeriod

type

null

  • initiation_period

Initiation settings

default

duration

0.0

has_cue

True

abort_on_force

False

abort_on_force_threshold

0.0

allOf

InitiationPeriod

  • response_period

Response settings

default

duration

0.0

has_cue

True

has_feedback

False

allOf

ResponsePeriod

  • left_harvest

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

HarvestAction

type

null

  • right_harvest

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

HarvestAction

type

null

TrialType

Defines the trial types

type

string

enum

None, Accumulation, RegionOfInterest

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

allOf

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

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