medrs 0.1.2

Ultra-high-performance medical imaging I/O for deep learning
Documentation
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
//! Random augmentation transforms for data augmentation in ML training.
//!
//! These transforms apply random perturbations to images for training
//! neural networks on medical imaging data.

use crate::error::{Error, Result};
use crate::nifti::image::ArrayData;
use crate::nifti::{DataType, NiftiImage};
use crate::pipeline::acquire_buffer;
use ndarray::{ArrayD, IxDyn, ShapeBuilder};
use rand::prelude::*;
use rand_chacha::ChaCha8Rng;
use rayon::prelude::*;

/// Random number generator with optional seeding for reproducibility.
#[allow(clippy::option_if_let_else)] // match is clearer than map_or_else here
fn get_rng(seed: Option<u64>) -> ChaCha8Rng {
    match seed {
        Some(s) => ChaCha8Rng::seed_from_u64(s),
        None => ChaCha8Rng::from_entropy(),
    }
}

/// Randomly flip the image along specified axes with given probability.
///
/// # Arguments
///
/// * `image` - Input image
/// * `axes` - Axes that may be flipped (0=depth, 1=height, 2=width)
/// * `prob` - Probability of flipping each axis (default: 0.5)
/// * `seed` - Optional random seed for reproducibility
///
/// # Example
///
/// ```ignore
/// let augmented = random_flip(&img, &[0, 1, 2], Some(0.5), None);
/// ```
#[must_use = "this function returns a new image and does not modify the original"]
pub fn random_flip(
    image: &NiftiImage,
    axes: &[usize],
    prob: Option<f32>,
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let prob = prob.unwrap_or(0.5);
    let mut rng = get_rng(seed);

    let flip_axes: Vec<usize> = axes
        .iter()
        .filter(|_| rng.gen::<f32>() < prob)
        .copied()
        .collect();

    if flip_axes.is_empty() {
        // No flip - return clone
        Ok(image.clone())
    } else {
        crate::transforms::flip(image, &flip_axes)
    }
}

/// Add random Gaussian noise to the image.
///
/// # Arguments
///
/// * `image` - Input image
/// * `std` - Standard deviation of the noise (default: 0.1)
/// * `seed` - Optional random seed for reproducibility
///
/// # Example
///
/// ```ignore
/// let noisy = random_gaussian_noise(&img, Some(0.05), None)?;
/// ```
#[must_use = "this function returns a Result and does not modify the original"]
pub fn random_gaussian_noise(
    image: &NiftiImage,
    std: Option<f32>,
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let std = std.unwrap_or(0.1);
    let mut rng = get_rng(seed);

    let data = image.to_f32()?;
    let slice = data.as_slice_memory_order().ok_or_else(|| {
        Error::NonContiguousArray("Array must be contiguous for noise operation".to_string())
    })?;
    let len = slice.len();

    // Generate noise in parallel chunks for large arrays
    let mut output = acquire_buffer(len);

    // Use Box-Muller transform for Gaussian noise
    for (i, out) in output.iter_mut().enumerate() {
        let u1: f32 = rng.gen();
        let u2: f32 = rng.gen();
        // Avoid log(0)
        let u1 = u1.max(1e-10);
        let noise = (-2.0 * u1.ln()).sqrt() * (2.0 * std::f32::consts::PI * u2).cos() * std;
        *out = slice[i] + noise;
    }

    // F-order to match NIfTI convention
    let shape = data.shape();
    let out_array = ArrayD::from_shape_vec(IxDyn(shape).f(), output)
        .map_err(|e| Error::MemoryAllocation(format!("Failed to create output array: {}", e)))?;
    let mut header = image.header().clone();
    header.datatype = DataType::Float32;
    header.scl_slope = 1.0;
    header.scl_inter = 0.0;

    Ok(NiftiImage::from_parts(header, ArrayData::F32(out_array)))
}

/// Randomly scale image intensity.
///
/// Multiplies intensity by a random factor sampled from [1-scale_range, 1+scale_range].
///
/// # Arguments
///
/// * `image` - Input image
/// * `scale_range` - Range for random scaling factor (default: 0.1, meaning 0.9-1.1)
/// * `seed` - Optional random seed for reproducibility
#[must_use = "this function returns a Result and does not modify the original"]
pub fn random_intensity_scale(
    image: &NiftiImage,
    scale_range: Option<f32>,
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let scale_range = scale_range.unwrap_or(0.1);
    let mut rng = get_rng(seed);

    // Sample scale factor uniformly from [1-range, 1+range]
    let scale = 1.0 + rng.gen_range(-scale_range..=scale_range);

    let data = image.to_f32()?;
    let slice = data.as_slice_memory_order().ok_or_else(|| {
        Error::NonContiguousArray("Array must be contiguous for scale operation".to_string())
    })?;

    let mut output = acquire_buffer(slice.len());
    output
        .par_iter_mut()
        .zip(slice.par_iter())
        .for_each(|(out, &v)| {
            *out = v * scale;
        });

    // F-order to match NIfTI convention
    let shape = data.shape();
    let out_array = ArrayD::from_shape_vec(IxDyn(shape).f(), output)
        .map_err(|e| Error::MemoryAllocation(format!("Failed to create output array: {}", e)))?;
    let mut header = image.header().clone();
    header.datatype = DataType::Float32;
    header.scl_slope = 1.0;
    header.scl_inter = 0.0;

    Ok(NiftiImage::from_parts(header, ArrayData::F32(out_array)))
}

/// Randomly shift image intensity.
///
/// Adds a random offset sampled from [-shift_range, shift_range].
///
/// # Arguments
///
/// * `image` - Input image
/// * `shift_range` - Range for random shift (default: 0.1)
/// * `seed` - Optional random seed for reproducibility
#[must_use = "this function returns a Result and does not modify the original"]
pub fn random_intensity_shift(
    image: &NiftiImage,
    shift_range: Option<f32>,
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let shift_range = shift_range.unwrap_or(0.1);
    let mut rng = get_rng(seed);

    // Sample shift uniformly from [-range, range]
    let shift = rng.gen_range(-shift_range..=shift_range);

    let data = image.to_f32()?;
    let slice = data.as_slice_memory_order().ok_or_else(|| {
        Error::NonContiguousArray("Array must be contiguous for shift operation".to_string())
    })?;

    let mut output = acquire_buffer(slice.len());
    output
        .par_iter_mut()
        .zip(slice.par_iter())
        .for_each(|(out, &v)| {
            *out = v + shift;
        });

    // F-order to match NIfTI convention
    let shape = data.shape();
    let out_array = ArrayD::from_shape_vec(IxDyn(shape).f(), output)
        .map_err(|e| Error::MemoryAllocation(format!("Failed to create output array: {}", e)))?;
    let mut header = image.header().clone();
    header.datatype = DataType::Float32;
    header.scl_slope = 1.0;
    header.scl_inter = 0.0;

    Ok(NiftiImage::from_parts(header, ArrayData::F32(out_array)))
}

/// Randomly rotate the image by 90-degree increments.
///
/// Performs random rotation in the specified plane by 0, 90, 180, or 270 degrees.
///
/// # Arguments
///
/// * `image` - Input image
/// * `axes` - Tuple of two axes defining the rotation plane (e.g., (0, 1) for depth-height plane)
/// * `seed` - Optional random seed for reproducibility
#[must_use = "this function returns a new image and does not modify the original"]
pub fn random_rotate_90(
    image: &NiftiImage,
    axes: (usize, usize),
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let mut rng = get_rng(seed);

    // Choose random number of 90-degree rotations (0, 1, 2, or 3)
    let k: usize = rng.gen_range(0..4);

    if k == 0 {
        return Ok(image.clone());
    }

    rotate_90(image, axes, k)
}

/// Rotate the image by k * 90 degrees in the specified plane.
fn rotate_90(image: &NiftiImage, axes: (usize, usize), k: usize) -> Result<NiftiImage> {
    let ndim = image.ndim();
    if axes.0 >= ndim || axes.1 >= ndim {
        return Err(Error::InvalidDimensions(format!(
            "Rotation axes ({}, {}) out of bounds for {}D image",
            axes.0, axes.1, ndim
        )));
    }

    if axes.0 == axes.1 {
        return Err(Error::InvalidDimensions(
            "Rotation axes must be different".into(),
        ));
    }

    let k = k % 4;
    if k == 0 {
        return Ok(image.clone());
    }

    // Use ndarray's built-in rotation
    macro_rules! rotate_array {
        ($arr:expr, $variant:ident) => {{
            use ndarray::Axis;

            let mut arr = $arr.clone();

            for _ in 0..k {
                // Swap axes and reverse one of them to achieve 90-degree rotation
                arr.swap_axes(axes.0, axes.1);
                arr.invert_axis(Axis(axes.1));
            }

            // Convert to contiguous layout
            ArrayData::$variant(arr.as_standard_layout().to_owned())
        }};
    }

    let data = image.data_cow()?;
    let new_data = match data.as_ref() {
        ArrayData::U8(a) => rotate_array!(a, U8),
        ArrayData::I8(a) => rotate_array!(a, I8),
        ArrayData::I16(a) => rotate_array!(a, I16),
        ArrayData::U16(a) => rotate_array!(a, U16),
        ArrayData::I32(a) => rotate_array!(a, I32),
        ArrayData::U32(a) => rotate_array!(a, U32),
        ArrayData::I64(a) => rotate_array!(a, I64),
        ArrayData::U64(a) => rotate_array!(a, U64),
        ArrayData::F16(a) => rotate_array!(a, F16),
        ArrayData::BF16(a) => rotate_array!(a, BF16),
        ArrayData::F32(a) => rotate_array!(a, F32),
        ArrayData::F64(a) => rotate_array!(a, F64),
    };

    // Update header with rotated dimensions
    let mut header = image.header().clone();
    let old_shape = image.shape();
    let mut new_shape = old_shape.to_vec();

    // For odd k (90 or 270 degrees), swap dimensions
    if k % 2 == 1 {
        new_shape.swap(axes.0, axes.1);
    }

    header.ndim = new_shape.len() as u8;
    header.dim = [1u16; 7];
    for (i, &s) in new_shape.iter().enumerate() {
        if s > u16::MAX as usize {
            return Err(Error::InvalidDimensions(format!(
                "Rotated dimension {} ({}) exceeds maximum value {}",
                i,
                s,
                u16::MAX
            )));
        }
        header.dim[i] = s as u16;
    }

    Ok(NiftiImage::from_parts(header, new_data))
}

/// Apply random gamma correction to image intensity.
///
/// Applies the transform: output = input^gamma where gamma is randomly sampled.
///
/// # Arguments
///
/// * `image` - Input image (should be normalized to [0, 1] for best results)
/// * `gamma_range` - Range for gamma sampling (default: (0.7, 1.5))
/// * `seed` - Optional random seed for reproducibility
#[must_use = "this function returns a Result and does not modify the original"]
pub fn random_gamma(
    image: &NiftiImage,
    gamma_range: Option<(f32, f32)>,
    seed: Option<u64>,
) -> Result<NiftiImage> {
    let (gamma_min, gamma_max) = gamma_range.unwrap_or((0.7, 1.5));
    let mut rng = get_rng(seed);

    let gamma = rng.gen_range(gamma_min..=gamma_max);

    let data = image.to_f32()?;
    let slice = data.as_slice_memory_order().ok_or_else(|| {
        Error::NonContiguousArray("Array must be contiguous for gamma operation".to_string())
    })?;

    let mut output = acquire_buffer(slice.len());
    output
        .par_iter_mut()
        .zip(slice.par_iter())
        .for_each(|(out, &v)| {
            // Clamp to non-negative for gamma correction
            let v_clamped = v.max(0.0);
            *out = v_clamped.powf(gamma);
        });

    // F-order to match NIfTI convention
    let shape = data.shape();
    let out_array = ArrayD::from_shape_vec(IxDyn(shape).f(), output)
        .map_err(|e| Error::MemoryAllocation(format!("Failed to create output array: {}", e)))?;
    let mut header = image.header().clone();
    header.datatype = DataType::Float32;
    header.scl_slope = 1.0;
    header.scl_inter = 0.0;

    Ok(NiftiImage::from_parts(header, ArrayData::F32(out_array)))
}

/// Apply a random combination of augmentations commonly used in medical imaging.
///
/// This is a convenience function that applies multiple augmentations:
/// - Random flip (prob=0.5 per axis)
/// - Random intensity scale
/// - Random intensity shift
/// - Random Gaussian noise
///
/// # Arguments
///
/// * `image` - Input image
/// * `seed` - Optional random seed for reproducibility
#[must_use = "this function returns a Result and does not modify the original"]
pub fn random_augment(image: &NiftiImage, seed: Option<u64>) -> Result<NiftiImage> {
    let mut rng = get_rng(seed);

    // Generate seeds for each sub-operation
    let flip_seed = rng.gen();
    let scale_seed = rng.gen();
    let shift_seed = rng.gen();
    let noise_seed = rng.gen();

    // Apply augmentations in sequence
    let result = random_flip(image, &[0, 1, 2], Some(0.5), Some(flip_seed))?;
    let result = random_intensity_scale(&result, Some(0.1), Some(scale_seed))?;
    let result = random_intensity_shift(&result, Some(0.1), Some(shift_seed))?;
    let result = random_gaussian_noise(&result, Some(0.05), Some(noise_seed))?;

    Ok(result)
}

#[cfg(test)]
mod tests {
    use super::*;
    use ndarray::ArrayD;

    fn create_test_image(data: Vec<f32>, shape: [usize; 3]) -> NiftiImage {
        use ndarray::ShapeBuilder;
        let c_order = ArrayD::from_shape_vec(shape.to_vec(), data).unwrap();
        let mut f_order = ArrayD::zeros(ndarray::IxDyn(&shape).f());
        f_order.assign(&c_order);
        let affine = [
            [1.0, 0.0, 0.0, 0.0],
            [0.0, 1.0, 0.0, 0.0],
            [0.0, 0.0, 1.0, 0.0],
            [0.0, 0.0, 0.0, 1.0],
        ];
        NiftiImage::from_array(f_order, affine)
    }

    #[test]
    fn test_random_flip_with_seed() {
        let data: Vec<f32> = (0..64).map(|i| i as f32).collect();
        let img = create_test_image(data, [4, 4, 4]);

        // Same seed should produce same result
        let result1 = random_flip(&img, &[0, 1, 2], Some(0.5), Some(42)).unwrap();
        let result2 = random_flip(&img, &[0, 1, 2], Some(0.5), Some(42)).unwrap();

        let d1 = result1.to_f32().unwrap();
        let d2 = result2.to_f32().unwrap();
        assert_eq!(d1, d2);
    }

    #[test]
    fn test_random_gaussian_noise() {
        let data = vec![0.5; 64];
        let img = create_test_image(data.clone(), [4, 4, 4]);

        let noisy = random_gaussian_noise(&img, Some(0.1), Some(42)).unwrap();
        let result = noisy.to_f32().unwrap();

        // Noise should change values
        let original_sum: f32 = data.iter().sum();
        let result_sum: f32 = result.iter().sum();
        assert!((original_sum - result_sum).abs() > 0.01);

        // Shape should be preserved
        assert_eq!(result.shape(), &[4, 4, 4]);
    }

    #[test]
    fn test_random_intensity_scale() {
        let data: Vec<f32> = (1..=64).map(|i| i as f32).collect();
        let img = create_test_image(data, [4, 4, 4]);

        let scaled = random_intensity_scale(&img, Some(0.2), Some(42)).unwrap();
        let result = scaled.to_f32().unwrap();

        // Shape should be preserved
        assert_eq!(result.shape(), &[4, 4, 4]);

        // Values should be scaled (not identical to original)
        let original = img.to_f32().unwrap();
        assert_ne!(result, original);
    }

    #[test]
    fn test_random_intensity_shift() {
        let data: Vec<f32> = (1..=64).map(|i| i as f32).collect();
        let img = create_test_image(data, [4, 4, 4]);

        let shifted = random_intensity_shift(&img, Some(0.5), Some(42)).unwrap();
        let result = shifted.to_f32().unwrap();

        // Shape should be preserved
        assert_eq!(result.shape(), &[4, 4, 4]);
    }

    #[test]
    fn test_random_rotate_90() {
        let data: Vec<f32> = (0..24).map(|i| i as f32).collect();
        let img = create_test_image(data, [2, 3, 4]);

        // Test rotation in different planes
        let rotated = random_rotate_90(&img, (0, 1), Some(42)).unwrap();

        // Shape may change (dimensions might swap)
        let shape = rotated.shape();
        assert!(shape.iter().product::<usize>() == 24); // Total elements preserved
    }

    #[test]
    fn test_rotate_90_k0() {
        let data: Vec<f32> = (0..8).map(|i| i as f32).collect();
        let img = create_test_image(data.clone(), [2, 2, 2]);

        // k=0 should be identity
        let rotated = rotate_90(&img, (0, 1), 0).unwrap();
        assert_eq!(rotated.shape(), &[2, 2, 2]);
    }

    #[test]
    fn test_rotate_90_invalid_axes() {
        let data: Vec<f32> = (0..8).map(|i| i as f32).collect();
        let img = create_test_image(data, [2, 2, 2]);

        // Out of bounds
        let result = rotate_90(&img, (0, 5), 1);
        assert!(result.is_err());

        // Same axis
        let result = rotate_90(&img, (1, 1), 1);
        assert!(result.is_err());
    }

    #[test]
    fn test_random_gamma() {
        let data: Vec<f32> = (0..64).map(|i| (i as f32) / 63.0).collect();
        let img = create_test_image(data, [4, 4, 4]);

        let gamma_corrected = random_gamma(&img, Some((0.5, 2.0)), Some(42)).unwrap();
        let result = gamma_corrected.to_f32().unwrap();

        // Shape should be preserved
        assert_eq!(result.shape(), &[4, 4, 4]);

        // Values should be non-negative (gamma preserves non-negativity)
        for &v in result.iter() {
            assert!(v >= 0.0);
        }
    }

    #[test]
    fn test_random_augment() {
        let data: Vec<f32> = (0..64).map(|i| i as f32).collect();
        let img = create_test_image(data, [4, 4, 4]);

        let augmented = random_augment(&img, Some(42)).unwrap();

        // Shape should be preserved
        assert_eq!(augmented.shape(), &[4, 4, 4]);
    }

    #[test]
    fn test_reproducibility() {
        let data: Vec<f32> = (0..64).map(|i| i as f32).collect();
        let img = create_test_image(data, [4, 4, 4]);

        // Same seed should produce same result
        let aug1 = random_augment(&img, Some(12345)).unwrap();
        let aug2 = random_augment(&img, Some(12345)).unwrap();

        let d1 = aug1.to_f32().unwrap();
        let d2 = aug2.to_f32().unwrap();

        for (v1, v2) in d1.iter().zip(d2.iter()) {
            assert!((v1 - v2).abs() < 1e-6);
        }
    }
}