api.task_logic

pydantic model aind_bci_no_movement.task_logic.BciNoMovementTaskLogic

Bases: AindBehaviorTaskLogicModel

Config:

• extra: str = forbid

• validate_assignment: bool = True

• validate_defaults: bool = True

• strict: bool = True

• str_strip_whitespace: bool = True

Fields:

• name (str)

• task_parameters (aind_bci_no_movement.task_logic.BciNoMovementTaskParameters)

• version (Literal['0.0.1'])

Validators:

• coerce_version » version

field name: str = 'bci-no-movement'

Task name

field task_parameters: BciNoMovementTaskParameters [Required]

Parameters of the task logic

field version: Literal['0.0.1'] = '0.0.1'

Validated by:

• coerce_version

pydantic model aind_bci_no_movement.task_logic.BciNoMovementTaskParameters

Bases: TaskParameters

Config:

• extra: str = allow

• validate_assignment: bool = True

• validate_defaults: bool = True

• strict: bool = True

• str_strip_whitespace: bool = True

Fields:

• bci_active_control (aind_bci_no_movement.task_logic.SignalProcessing)

• bci_passive_control (aind_bci_no_movement.task_logic.SignalProcessing)

• delay_after_handshake (float)

• enable_sound_on_reward_zone_entry (bool)

• far_position_offset (float)

• inter_trial_interval (float)

• lick_response_time (float)

• low_activity_time (float)

• manipulator_reset_position (aind_bci_no_movement.task_logic.Point3d)

• max_trial_duration (float)

• no_movement_passive_control (aind_bci_no_movement.task_logic.SignalProcessing)

• no_movement_time_before_trial (float)

• punish_on_movement_duration (float)

• reward_consume_time (float)

• skip_2p_handshake (bool)

• valve_open_time (float)

• wait_for_lick (bool)

• wait_microscope_time (float)

field bci_active_control: SignalProcessing = SignalProcessing(baseline_threshold=0, gain=1, low_pass_cut_off=None, high_pass_cut_off=None)

BCI active control parameters

field bci_passive_control: SignalProcessing = SignalProcessing(baseline_threshold=0, gain=1, low_pass_cut_off=None, high_pass_cut_off=None)

BCI control parameters

field delay_after_handshake: float = 0.5

Delay after handshake (s). It will still be used if skip_2p_handshake is False.

Constraints:

• ge = 0

field enable_sound_on_reward_zone_entry: bool = True

Enables audio feedback on reward zone entry.

field far_position_offset: float = 8

Offset (mm) from the close position to the far position.

Constraints:

• ge = 0

field inter_trial_interval: float = 0

Interval (s) between trials.

Constraints:

• ge = 0

field lick_response_time: float = 2

Interval (s) for the animal to collect reward. Only applies if waitForLick is true.

Constraints:

• ge = 0

field low_activity_time: float = 1

Duration (s) BCI activity must stay low before starting a new trial.

Constraints:

• ge = 0

field manipulator_reset_position: Point3d = Point3d(x=0, y=0, z=0)

Position (mm) to reset the manipulator to.

field max_trial_duration: float = 20

Maximum duration (s) of a trial.

Constraints:

• ge = 0

field no_movement_passive_control: SignalProcessing = SignalProcessing(baseline_threshold=0, gain=1, low_pass_cut_off=None, high_pass_cut_off=None)

No movement control parameters

field no_movement_time_before_trial: float = 0

Interval (s) subjects must not move for to start a new trial.

Constraints:

• ge = 0

field punish_on_movement_duration: float = 0

The duration (s) that the spout will stop updating if the animal moves during the trial.

Constraints:

• ge = 0

field reward_consume_time: float = 2

Duration (s) for the animal to consume reward.

Constraints:

• ge = 0

field skip_2p_handshake: bool = False

Skip 2p handshake

field valve_open_time: float = 0.01

Time valve remains open (s)

Constraints:

• ge = 0

field wait_for_lick: bool = True

Determines whether the animal must lick to trigger reward delivery. If false, reward is immediately delivered.

field wait_microscope_time: float = 0

Interval (s) after the animal successfully exists the quiescence period.

Constraints:

• ge = 0

pydantic model aind_bci_no_movement.task_logic.Point3d

Bases: BaseModel

Fields:

• x (float)

• y (float)

• z (float)

field x: float = 0

X coordinate

field y: float = 0

Y coordinate

field z: float = 0

Z coordinate

pydantic model aind_bci_no_movement.task_logic.SignalProcessing

Bases: BaseModel

Fields:

• baseline_threshold (float)

• gain (float)

• high_pass_cut_off (float | None)

• low_pass_cut_off (float | None)

field baseline_threshold: float = 0

The threshold to be applied to the signal to define baseline

Constraints:

• ge = 0

field gain: float = 1

The gain to be applied to the signal

field high_pass_cut_off: float | None = None

High pass cut off frequency(Hz)

field low_pass_cut_off: float | None = None

Low pass cut off frequency(Hz)