Shortcuts

RandomShift

class torcheeg.transforms.RandomShift(p: float = 0.5, shift_min: int = 8, shift_max: int = 12, dim: int = -1, apply_to_baseline: bool = False)[source][source]

Apply a shift with a specified probability, after which the specified dimension is shifted backward, and the part shifted out of the Tensor is added to the front of that dimension.

transform = RandomShift(dim=-1, shift_min=8, shift_max=24)
transform(eeg=torch.randn(32, 128))['eeg'].shape
>>> (32, 128)
Parameters:
  • shift_min (float or int) – The minimum shift in the random transformation. (default: -2.0)

  • shift_max (float or int) – The maximum shift in random transformation. (default: 2.0)

  • dim (int) – Dimension to be shifted in the input tensor. (default: -1)

  • p (float) – Probability of applying random mask on EEG signal samples. Should be between 0.0 and 1.0, where 0.0 means no mask is applied to every sample and 1.0 means that masks are applied to every sample. (default: 0.5)

  • apply_to_baseline – (bool): Whether to act on the baseline signal at the same time, if the baseline is passed in when calling. (default: False)

__call__(*args, eeg: Tensor, baseline: Tensor | None = None, **kwargs) Dict[str, Tensor][source][source]
Parameters:
  • eeg (torch.Tensor) – The input EEG signal.

  • baseline (torch.Tensor, optional) – The corresponding baseline signal, if apply_to_baseline is set to True and baseline is passed, the baseline signal will be transformed with the same way as the experimental signal.

Returns:

The output EEG signal after applying a random shift.

Return type:

torch.Tensor

Read the Docs v: latest
Versions
latest
stable
v1.1.1
v1.1.0
v1.0.11
v1.0.10
v1.0.9
v1.0.8.post1
v1.0.8
v1.0.7
v1.0.6
v1.0.4
v1.0.3
v1.0.2
v1.0.1
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.

Docs

Access comprehensive developer documentation for PyTorch

View Docs

Tutorials

Get in-depth tutorials for beginners and advanced developers

View Tutorials

Resources

Find development resources and get your questions answered

View Resources