2 step soundcat arpit

[arpit99ag]

Description

Merge Request: Introduce Arpit_CentrePokeTraining Protocol

This merge request introduces a new protocol, Arpit_CentrePokeTraining, designed to automate the training of rats to perform centre pokes. This protocol is based on the existing SoundCatContinuous protocol but incorporates several significant modifications and improvements.

Key Changes and Features:

• New Automated Training Protocol:

  • Introduces Arpit_CentrePokeTraining for centre poke training.
  • Features automated, multi-step training stages.
  • Utilizes sessionmodel2 instead of the previous sessionmodel.

• Configurable Training Stages:

  • Training steps, stage progression logic, and completion criteria are defined within SessionDefinition.
  • These settings can be modified directly in SessionDefinition or configured via a .mat file: Arpit_CentrePokeTraining_SessionDefinition_AutoTrainingStages.m.
  • Important: If using the .m file, remember to load it before making changes and save it afterward for the changes to take effect.

• Flexible Stimulus Presentation:

  • Includes an option (configurable after Stage 5) to use either fixed or variable sound/stimuli distributions during centre poke training.
  • Randomizes pre-stimulus time, stimulus duration, and pre-go signal time to prevent rats from learning based on timing cues alone.

• Updated State Machine Logic:

  • The system now checks the poke state before the designated "legal poke" period begins (i.e., before the settling time ends).
  • It also checks the poke state after the legal poke period ends.
  • Rats are no longer required to maintain the centre poke until the Go cue ends; they can withdraw anytime after the Go cue starts.

• Time-Limited Reward Collection:

  • A time limit is imposed for collecting the reward from the side port after delivery. Failure to collect within this window is recorded as a violation.

• New Panel To Change Training Params::

  • A dedicated panel has been added to the UI.
  • This allows users to adjust training parameters during a session for different stages.
  • It also includes functionality to test for stage completion criteria.

• Improved Performance Tracking:

  • This section now includes additional metrics such as violation rate, timeout rate, and the number of sessions completed per stage and per day.

• Enhanced Stimuli Configuration (Work in Progress):

  • The stimuli configuration section has been significantly remodelled to offer more parameters, including control over distribution and range.
  • Note: This section is still under development and will receive further updates.

This new protocol aims to provide a more robust and flexible framework for automated centre poke training.

Additionally, edited the m file in Plugin>sessionmodel2>CreateHelperVars as there was a conflict with same name for a variable and a function and therefore changed the name of the variable.

Type of Change

• Bug fix
• New feature
• Documentation update
• Breaking change
• Other (please specify):

Checklist

• I have tested the changes locally.
• I have updated the documentation accordingly.
• I have added necessary tests to cover the changes.
• I have followed the code style guidelines.
• I have verified that the code works in all target environments.

Related Issues

Closes # (issue number)