feat: add text stimulus class

[SiQube]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (dc90857) to head (05acea0).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #676   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           55        57    +2     
  Lines         2530      2559   +29     
  Branches       644       647    +3     
=========================================
+ Hits          2530      2559   +29     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dkrako]

Thank you so much for working on this task! I think the current startout supposes too big of a scope of this PR. We should keep the scope very limited and work iteratively on adding new functionalities in distinct PRs. The TextStimulus class will be experimental for a while, but I think this strategy is better than having too big of a scope in this big project.

This PR should focus on the basics first and only, returning a TextStimulus class which has an aoi attribute when calling pymovements.stimulus.text.from_file().

[dkrako]

We'll discuss next friday if it should be pymovements.stimulus or pymovements.stimuli.

The class TextStimulus should be available via pymovements.TextStimulus anyway.

[dkrako]

Thanks a lot, that's a good direction the PR is taking!
There is some more work needed around the edges but we're getting to it soon!

[dkrako]

Great! Just two minor things and then there's the question about if we should clone a input dataframe.

On a more general note, I would like to discuss tomorrow if we want the naming to be

1. Stimulus.aois
2. or Stimulus.areas

I orignally proposed aois, but somehow I think areas would be a better fit.

[dkrako]

Excellent! There are some tiny bits in the __init__.py and the docstrings need parameter specifications but that's about it.

[dkrako]

Excellent! Thank you so much for this work!