brain_pipe.preprocessing.brain.link.BasenameComparisonFn

class BasenameComparisonFn(stim_path_key: str = 'stimulus_path', ignore_extension: bool = False)

Bases: object

Compare the basename of the stimulus path to the brain data path.

__init__(stim_path_key: str = 'stimulus_path', ignore_extension: bool = False)

Create a new BasenameComparisonFn instance.

Parameters:

• stim_path_key (str) – The key of the stimulus path in the data dict. Defaults to “stimulus_path”.

• ignore_extension (bool) – Whether to ignore the extension of the stimulus path. Defaults to False.

Methods

__init__([stim_path_key, ignore_extension])	Create a new BasenameComparisonFn instance.
process_path(path)	Process a path so that it can be compared to the brain data path.

process_path(path: Any) → str | None

Process a path so that it can be compared to the brain data path.

Parameters:

path (Any) – The path to process.

Returns:

The processed path or None if the path is not valid.

Return type:

Optional[str]