Transforms

Base Transform

class neuroarcade.transforms.base.BaseTransform

Bases: ABC

A transform remaps a canonical Direction into another Direction.

This is the core of the visuomotor remapping logic.

abstractmethod apply(direction: Direction) → Direction

Return the remapped direction. This is like “the controller says left but I say right”.

Parameters:

direction (Direction) – Direction passed by the controller.

Returns:

Direction returned by the transformer, may be different.

Return type:

Direction

abstractmethod get_config_schema() → dict

Return a configuration schema for the transformer.

The UI uses this schema to dynamically generate configuration controls (e.g., sliders, dropdowns). The key of each parameter will be passed to the __init__ function of the subclasses, so those keys should match the name of the parameters expected by the constructor.

Returns:

A structured description of configurable parameters.

Return type:

dict

abstractmethod get_instructions() → dict

Return instructions the UI should expose, as HTML formatted text. Include the INSTRUCTIONS_HEAD variable from the neuroarcade.ui.instructions_html to load the styles.

The UI displays this information to explain:

• Transform logic

• Controls equivalencies

Returns:

Instructions for presentation in the UI.

Return type:

str

Available transforms

Note

To be added!