File size: 16,339 Bytes
b4d7ac8 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
# Copyright (c) MONAI Consortium
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
A collection of transforms for signal operations.
"""
from __future__ import annotations
import warnings
from collections.abc import Sequence
from typing import Any
import numpy as np
import torch
from monai.config.type_definitions import NdarrayOrTensor
from monai.transforms.transform import RandomizableTransform, Transform
from monai.transforms.utils import check_boundaries, paste, squarepulse
from monai.utils import optional_import
from monai.utils.enums import TransformBackends
from monai.utils.type_conversion import convert_data_type, convert_to_tensor
shift, has_shift = optional_import("scipy.ndimage.interpolation", name="shift")
iirnotch, has_iirnotch = optional_import("scipy.signal", name="iirnotch")
with warnings.catch_warnings():
warnings.simplefilter("ignore", UserWarning) # project-monai/monai#5204
filtfilt, has_filtfilt = optional_import("torchaudio.functional", name="filtfilt")
central_frequency, has_central_frequency = optional_import("pywt", name="central_frequency")
cwt, has_cwt = optional_import("pywt", name="cwt")
__all__ = [
"SignalRandDrop",
"SignalRandScale",
"SignalRandShift",
"SignalRandAddSine",
"SignalRandAddSquarePulse",
"SignalRandAddGaussianNoise",
"SignalRandAddSinePartial",
"SignalRandAddSquarePulsePartial",
"SignalFillEmpty",
"SignalRemoveFrequency",
"SignalContinuousWavelet",
]
class SignalRandShift(RandomizableTransform):
"""
Apply a random shift on a signal
"""
backend = [TransformBackends.NUMPY, TransformBackends.TORCH]
def __init__(
self, mode: str | None = "wrap", filling: float | None = 0.0, boundaries: Sequence[float] = (-1.0, 1.0)
) -> None:
"""
Args:
mode: define how the extension of the input array is done beyond its boundaries, see for more details :
https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.shift.html.
filling: value to fill past edges of input if mode is ‘constant’. Default is 0.0. see for mode details :
https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.shift.html.
boundaries: list defining lower and upper boundaries for the signal shift, default : ``[-1.0, 1.0]``
"""
super().__init__()
check_boundaries(boundaries)
self.filling = filling
self.mode = mode
self.boundaries = boundaries
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to be shifted
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
length = signal.shape[1]
shift_idx = round(self.magnitude * length)
sig = convert_data_type(signal, np.ndarray)[0]
signal = convert_to_tensor(shift(input=sig, mode=self.mode, shift=shift_idx, cval=self.filling))
return signal
class SignalRandScale(RandomizableTransform):
"""
Apply a random rescaling on a signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, boundaries: Sequence[float] = (-1.0, 1.0)) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the signal scaling, default : ``[-1.0, 1.0]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to be scaled
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
signal = convert_to_tensor(self.magnitude * signal)
return signal
class SignalRandDrop(RandomizableTransform):
"""
Randomly drop a portion of a signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, boundaries: Sequence[float] = (0.0, 1.0)) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the signal drop,
lower and upper values need to be positive default : ``[0.0, 1.0]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to be dropped
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
length = signal.shape[-1]
mask = torch.zeros(round(self.magnitude * length))
trange = torch.arange(length)
loc = trange[torch.randint(0, trange.size(0), (1,))]
signal = convert_to_tensor(paste(signal, mask, (loc,)))
return signal
class SignalRandAddSine(RandomizableTransform):
"""
Add a random sinusoidal signal to the input signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, boundaries: Sequence[float] = (0.1, 0.3), frequencies: Sequence[float] = (0.001, 0.02)) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the sinusoidal magnitude,
lower and upper values need to be positive ,default : ``[0.1, 0.3]``
frequencies: list defining lower and upper frequencies for sinusoidal
signal generation ,default : ``[0.001, 0.02]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
self.frequencies = frequencies
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to which sinusoidal signal will be added
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
self.freqs = self.R.uniform(low=self.frequencies[0], high=self.frequencies[1])
length = signal.shape[1]
time = np.arange(0, length, 1)
data = convert_to_tensor(self.freqs * time)
sine = self.magnitude * torch.sin(data)
signal = convert_to_tensor(signal) + sine
return signal
class SignalRandAddSquarePulse(RandomizableTransform):
"""
Add a random square pulse signal to the input signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, boundaries: Sequence[float] = (0.01, 0.2), frequencies: Sequence[float] = (0.001, 0.02)) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the square pulse magnitude,
lower and upper values need to be positive , default : ``[0.01, 0.2]``
frequencies: list defining lower and upper frequencies for the square pulse
signal generation , default : ``[0.001, 0.02]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
self.frequencies = frequencies
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to which square pulse will be added
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
self.freqs = self.R.uniform(low=self.frequencies[0], high=self.frequencies[1])
length = signal.shape[1]
time = np.arange(0, length, 1)
squaredpulse = self.magnitude * squarepulse(self.freqs * time)
signal = convert_to_tensor(signal) + squaredpulse
return signal
class SignalRandAddSinePartial(RandomizableTransform):
"""
Add a random partial sinusoidal signal to the input signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(
self,
boundaries: Sequence[float] = (0.1, 0.3),
frequencies: Sequence[float] = (0.001, 0.02),
fraction: Sequence[float] = (0.01, 0.2),
) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the sinusoidal magnitude,
lower and upper values need to be positive , default : ``[0.1, 0.3]``
frequencies: list defining lower and upper frequencies for sinusoidal
signal generation , default : ``[0.001, 0.02]``
fraction: list defining lower and upper boundaries for partial signal generation
default : ``[0.01, 0.2]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
self.frequencies = frequencies
self.fraction = fraction
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to which a partial sinusoidal signal
will be added
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
self.fracs = self.R.uniform(low=self.fraction[0], high=self.fraction[1])
self.freqs = self.R.uniform(low=self.frequencies[0], high=self.frequencies[1])
length = signal.shape[-1]
time_partial = np.arange(0, round(self.fracs * length), 1)
data = convert_to_tensor(self.freqs * time_partial)
sine_partial = self.magnitude * torch.sin(data)
loc = np.random.choice(range(length))
signal = paste(signal, sine_partial, (loc,))
return signal
class SignalRandAddGaussianNoise(RandomizableTransform):
"""
Add a random gaussian noise to the input signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, boundaries: Sequence[float] = (0.001, 0.02)) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the signal magnitude,
default : ``[0.001,0.02]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to which gaussian noise will be added
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
length = signal.shape[1]
gaussiannoise = self.magnitude * torch.randn(length)
signal = convert_to_tensor(signal) + gaussiannoise
return signal
class SignalRandAddSquarePulsePartial(RandomizableTransform):
"""
Add a random partial square pulse to a signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(
self,
boundaries: Sequence[float] = (0.01, 0.2),
frequencies: Sequence[float] = (0.001, 0.02),
fraction: Sequence[float] = (0.01, 0.2),
) -> None:
"""
Args:
boundaries: list defining lower and upper boundaries for the square pulse magnitude,
lower and upper values need to be positive , default : ``[0.01, 0.2]``
frequencies: list defining lower and upper frequencies for square pulse
signal generation example : ``[0.001, 0.02]``
fraction: list defining lower and upper boundaries for partial square pulse generation
default: ``[0.01, 0.2]``
"""
super().__init__()
check_boundaries(boundaries)
self.boundaries = boundaries
self.frequencies = frequencies
self.fraction = fraction
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: input 1 dimension signal to which a partial square pulse will be added
"""
self.randomize(None)
self.magnitude = self.R.uniform(low=self.boundaries[0], high=self.boundaries[1])
self.fracs = self.R.uniform(low=self.fraction[0], high=self.fraction[1])
self.freqs = self.R.uniform(low=self.frequencies[0], high=self.frequencies[1])
length = signal.shape[-1]
time_partial = np.arange(0, round(self.fracs * length), 1)
squaredpulse_partial = self.magnitude * squarepulse(self.freqs * time_partial)
loc = np.random.choice(range(length))
signal = paste(signal, squaredpulse_partial, (loc,))
return signal
class SignalFillEmpty(Transform):
"""
replace empty part of a signal (NaN)
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(self, replacement: float = 0.0) -> None:
"""
Args:
replacement: value to replace nan items in signal
"""
super().__init__()
self.replacement = replacement
def __call__(self, signal: NdarrayOrTensor) -> NdarrayOrTensor:
"""
Args:
signal: signal to be filled
"""
signal = torch.nan_to_num(convert_to_tensor(signal, track_meta=True), nan=self.replacement)
return signal
class SignalRemoveFrequency(Transform):
"""
Remove a frequency from a signal
"""
backend = [TransformBackends.TORCH, TransformBackends.NUMPY]
def __init__(
self, frequency: float | None = None, quality_factor: float | None = None, sampling_freq: float | None = None
) -> None:
"""
Args:
frequency: frequency to be removed from the signal
quality_factor: quality factor for notch filter
see : https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirnotch.html
sampling_freq: sampling frequency of the input signal
"""
super().__init__()
self.frequency = frequency
self.quality_factor = quality_factor
self.sampling_freq = sampling_freq
def __call__(self, signal: np.ndarray) -> Any:
"""
Args:
signal: signal to be frequency removed
"""
b_notch, a_notch = convert_to_tensor(
iirnotch(self.frequency, self.quality_factor, self.sampling_freq), dtype=torch.float
)
y_notched = filtfilt(convert_to_tensor(signal), a_notch, b_notch)
return y_notched
class SignalContinuousWavelet(Transform):
"""
Generate continuous wavelet transform of a signal
"""
backend = [TransformBackends.NUMPY]
def __init__(self, type: str = "mexh", length: float = 125.0, frequency: float = 500.0) -> None:
"""
Args:
type: mother wavelet type.
Available options are: {``"mexh"``, ``"morl"``, ``"cmorB-C"``, , ``"gausP"``}
see : https://pywavelets.readthedocs.io/en/latest/ref/cwt.html
length: expected length, default ``125.0``
frequency: signal frequency, default ``500.0``
"""
super().__init__()
self.frequency = frequency
self.length = length
self.type = type
def __call__(self, signal: np.ndarray) -> Any:
"""
Args:
signal: signal for which to generate continuous wavelet transform
"""
mother_wavelet = self.type
spread = np.arange(1, self.length + 1, 1)
scales = central_frequency(mother_wavelet) * self.frequency / spread
coeffs, _ = cwt(signal, scales, mother_wavelet, 1.0 / self.frequency)
coeffs = np.transpose(coeffs, [1, 0, 2])
return coeffs
|