Update octagon.py

[jerlich]

We extended the API to include a new stimulus type.

Summary by CodeRabbit

• New Feature: Added a new functionality to the Stimulus class in the aeon/schema/octagon.py file. This feature introduces a static method checkerboard_slice_onset that extends our API's capabilities to support checkerboard slice onset stimuli. This enhancement will provide users with more flexibility and control when working with different types of stimuli.

[github-actions]

CodeRabbit

Walkthrough

The proposed changeset introduces a new static method checkerboard_slice_onset to the Stimulus class in the aeon/schema/octagon.py file. This method returns a dictionary with a key-value pair, where the key is "CheckerboardSliceOnset" and the value is an instance of _reader.Harp. The change extends the API's functionality to support checkerboard slice onset stimuli.

Changes

File	Summary
aeon/schema/octagon.py	A new static method checkerboard_slice_onset has been added to the Stimulus class. This method returns a dictionary with the key "CheckerboardSliceOnset" and a value of an instance of _reader.Harp, extending the API to support checkerboard slice onset stimuli.

---

Uplevel your code reviews with CodeRabbit Pro

CodeRabbit Pro

If you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects.

[github-actions]

CodeRabbit

Commits

Files that changed from the base of the PR and between 616155b and 5502629 commits.

Files selected (1)

• aeon/schema/octagon.py (1)

Review comments generated (1)

• Review: 1
• LGTM: 0

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
• Invite the bot into a review comment chain by tagging @coderabbitai in a reply.

Code suggestions

• The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
• You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

• Add @coderabbitai: ignore anywhere in the PR description to pause further reviews from the bot.

[github-actions]

CodeRabbit

The new method checkerboard_slice_onset is almost identical to the existing method gratings_slice_onset. This violates the DRY (Don't Repeat Yourself) principle. You can refactor these methods into a single method that takes an additional parameter for the stimulus type. Here's a suggested change:

-    @staticmethod
-    def gratings_slice_onset(pattern):
-        return {"GratingsSliceOnset": _reader.Harp(f"{pattern}_12_*", columns=["wall_id"])}
-
-    @staticmethod
-    def checkerboard_slice_onset(pattern):
-        return {"CheckerboardSliceOnset": _reader.Harp(f"{pattern}_14_*", columns=["wall_id"])}

+    @staticmethod
+    def slice_onset(stimulus_type, pattern):
+        if stimulus_type == "Gratings":
+            return {f"{stimulus_type}SliceOnset": _reader.Harp(f"{pattern}_12_*", columns=["wall_id"])}
+        elif stimulus_type == "Checkerboard":
+            return {f"{stimulus_type}SliceOnset": _reader.Harp(f"{pattern}_14_*", columns=["wall_id"])}
+        else:
+            raise ValueError("Invalid stimulus type")

This way, you can add more stimulus types in the future without adding more methods.