neuralset.extractors.neuro.HrfConvolve¶

class neuralset.extractors.neuro.HrfConvolve(*, event_types: str | tuple[str, ...] = 'Event', aggregation: Literal['mean'] = 'mean', allow_missing: bool = False, frequency: Annotated[float, Gt(gt=0)], extractor: BaseExtractor, offset: float = 0, duration: Annotated[float, Gt(gt=0)] | None = None, infra: MapInfra = MapInfra(folder=None, cluster=None, logs='{folder}/logs/{user}/%j', job_name=None, timeout_min=None, nodes=1, tasks_per_node=1, cpus_per_task=None, gpus_per_node=None, mem_gb=None, max_pickle_size_gb=None, slurm_constraint=None, slurm_partition=None, slurm_account=None, slurm_qos=None, slurm_use_srun=False, slurm_additional_parameters=None, conda_env=None, workdir=None, permissions=511, version='0', keep_in_ram=True, max_jobs=128, min_samples_per_job=1, forbid_single_item_computation=False, mode='cached'))[source][source]¶

Convolve the output of an extractor by the Hemodynamic Response Function.

Note that this extractor does not support timelines with events.start < 0. Note that this is stored by timeline. If the events change in a timeline, e.g. by using different transform with a similar, then there will be a silent bug.

Parameters:

extractor (BaseExtractor) – the extractor used for feature extraction
frequency (Literal["native"]) – The frequency of the cropped extractor. Must be “native”. Never used