noobase 0.0.6

Foundational pure-function utilities for astronomy analysis
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
use ndarray::{Array1, ArrayView1};

use crate::axis::Grid;
use crate::float::Float;

/// Two-pointer sweep over source and target bin edges. The visitor is invoked
/// once for each non-empty linear-space intersection `(target_index,
/// source_index, overlap_width)`. Overlap is measured as a plain difference of
/// edge values, regardless of whether the underlying Grid was constructed with
/// `Linear` or `Log` spacing — log-uniform grids are not log-uniform once their
/// edges are taken, so a single convention (linear width on the edge axis)
/// keeps the semantics consistent across spacings.
///
/// The traversal is O(M + N) where M and N are the number of source and target
/// bins respectively. If the two grids do not overlap at all, the visitor is
/// simply never called — this is not considered an error.
pub fn for_each<T, F>(source: &Grid<T>, target: &Grid<T>, mut visitor: F)
where
    T: Float,
    F: FnMut(usize, usize, T),
{
    let source_edges_grid = source.to_edges();
    let target_edges_grid = target.to_edges();
    let source_edges = source_edges_grid.values();
    let target_edges = target_edges_grid.values();
    let source_bin_count = source_edges.len() - 1;
    let target_bin_count = target_edges.len() - 1;
    if source_bin_count == 0 || target_bin_count == 0 {
        return;
    }
    let mut source_index = 0usize;
    let mut target_index = 0usize;
    while source_index < source_bin_count && target_index < target_bin_count {
        let source_lo = source_edges[source_index];
        let source_hi = source_edges[source_index + 1];
        let target_lo = target_edges[target_index];
        let target_hi = target_edges[target_index + 1];
        let lo = if source_lo > target_lo {
            source_lo
        } else {
            target_lo
        };
        let hi = if source_hi < target_hi {
            source_hi
        } else {
            target_hi
        };
        if hi > lo {
            visitor(target_index, source_index, hi - lo);
        }
        // Advance whichever bin ends first; if both end at the same edge,
        // advance both to avoid emitting a zero-width pair on the next step.
        if source_hi < target_hi {
            source_index += 1;
        } else if target_hi < source_hi {
            target_index += 1;
        } else {
            source_index += 1;
            target_index += 1;
        }
    }
}

/// Flux-density-conserving rebin from `source` onto `target`.
///
/// For each target bin `i`,
/// ```text
/// out[i] = (Σ_j overlap[i, j] * source_values[j]) / target_width[i]
/// ```
/// where `overlap[i, j]` is the linear-space intersection width between target
/// bin `i` and source bin `j`, and `target_width[i]` is the full linear-space
/// width of target bin `i`. This preserves the integral
/// `Σ_i out[i] * target_width[i]` over the region where source and target
/// overlap, so the values behave like a density (flux per unit x).
///
/// Target bins that lie partially or fully outside the source range are NOT
/// treated as errors: the sum is simply taken over whatever overlap exists.
/// Callers that need to mask such bins should use [`coverage`].
///
/// Panics if `source_values.len()` does not match the number of source bins
/// (i.e. `source.to_edges().len() - 1`).
pub fn rebin<T: Float>(
    source: &Grid<T>,
    source_values: ArrayView1<T>,
    target: &Grid<T>,
) -> Array1<T> {
    let source_edges_grid = source.to_edges();
    let target_edges_grid = target.to_edges();
    let source_bin_count = source_edges_grid.len() - 1;
    let target_bin_count = target_edges_grid.len() - 1;
    assert_eq!(
        source_values.len(),
        source_bin_count,
        "source_values length {} does not match source bin count {}",
        source_values.len(),
        source_bin_count
    );
    let target_edges = target_edges_grid.values();
    let mut weighted_sum = Array1::<T>::zeros(target_bin_count);
    for_each(
        &source_edges_grid,
        &target_edges_grid,
        |target_index, source_index, overlap_width| {
            weighted_sum[target_index] =
                weighted_sum[target_index] + overlap_width * source_values[source_index];
        },
    );
    let mut output = Array1::<T>::zeros(target_bin_count);
    for target_index in 0..target_bin_count {
        let target_width = target_edges[target_index + 1] - target_edges[target_index];
        if target_width > T::zero() {
            output[target_index] = weighted_sum[target_index] / target_width;
        }
    }
    output
}

/// Variance propagation for [`rebin`] assuming the source bins have
/// independent (uncorrelated) errors. Each output target bin combines its
/// source contributions with squared weights, so
/// ```text
/// out[i] = Σ_j (overlap[i, j] / target_width[i])^2 * source_variance[j]
/// ```
///
/// As with [`rebin`], partial-coverage target bins are not errors; their
/// variance is computed against the partial sum and should usually be masked
/// by the caller using [`coverage`].
///
/// Panics if `source_variance.len()` does not match the number of source bins.
pub fn rebin_variance<T: Float>(
    source: &Grid<T>,
    source_variance: ArrayView1<T>,
    target: &Grid<T>,
) -> Array1<T> {
    let source_edges_grid = source.to_edges();
    let target_edges_grid = target.to_edges();
    let source_bin_count = source_edges_grid.len() - 1;
    let target_bin_count = target_edges_grid.len() - 1;
    assert_eq!(
        source_variance.len(),
        source_bin_count,
        "source_variance length {} does not match source bin count {}",
        source_variance.len(),
        source_bin_count
    );
    let target_edges = target_edges_grid.values();
    // Accumulate Σ_j overlap[i, j]^2 * var[j] first, divide by target_width[i]^2 at the end.
    let mut squared_weighted_sum = Array1::<T>::zeros(target_bin_count);
    for_each(
        &source_edges_grid,
        &target_edges_grid,
        |target_index, source_index, overlap_width| {
            let contribution = overlap_width * overlap_width * source_variance[source_index];
            squared_weighted_sum[target_index] = squared_weighted_sum[target_index] + contribution;
        },
    );
    let mut output = Array1::<T>::zeros(target_bin_count);
    for target_index in 0..target_bin_count {
        let target_width = target_edges[target_index + 1] - target_edges[target_index];
        if target_width > T::zero() {
            let denom = target_width * target_width;
            output[target_index] = squared_weighted_sum[target_index] / denom;
        }
    }
    output
}

/// Geometric coverage fraction of each target bin by the source range. For
/// each target bin `i`,
/// ```text
/// out[i] = (Σ_j overlap[i, j]) / target_width[i]   ∈ [0, 1]
/// ```
/// A target bin completely inside the source range yields 1.0; a target bin
/// completely outside yields 0.0; a half-covered edge bin yields 0.5. This is
/// the standard mask companion for [`rebin`] and [`rebin_variance`].
pub fn coverage<T: Float>(source: &Grid<T>, target: &Grid<T>) -> Array1<T> {
    let source_edges_grid = source.to_edges();
    let target_edges_grid = target.to_edges();
    let target_bin_count = target_edges_grid.len() - 1;
    let target_edges = target_edges_grid.values();
    let mut overlap_sum = Array1::<T>::zeros(target_bin_count);
    for_each(
        &source_edges_grid,
        &target_edges_grid,
        |target_index, _source_index, overlap_width| {
            overlap_sum[target_index] = overlap_sum[target_index] + overlap_width;
        },
    );
    let mut output = Array1::<T>::zeros(target_bin_count);
    for target_index in 0..target_bin_count {
        let target_width = target_edges[target_index + 1] - target_edges[target_index];
        if target_width > T::zero() {
            output[target_index] = overlap_sum[target_index] / target_width;
        }
    }
    output
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::axis::{GridKind, Spacing};
    use ndarray::array;

    const TOL: f64 = 1e-12;

    fn approx_eq(a: f64, b: f64, tol: f64) -> bool {
        (a - b).abs() <= tol * a.abs().max(b.abs()).max(1.0)
    }

    fn linear_edges(values: &[f64]) -> Grid<f64> {
        Grid::new(
            values.iter().copied().collect(),
            Spacing::Linear,
            GridKind::Edges,
        )
        .unwrap()
    }

    #[test]
    fn for_each_identical_grids_one_to_one() {
        let grid = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let mut calls: Vec<(usize, usize, f64)> = Vec::new();
        for_each(&grid, &grid, |target_index, source_index, overlap_width| {
            calls.push((target_index, source_index, overlap_width));
        });
        assert_eq!(calls.len(), 4);
        for (i, call) in calls.iter().enumerate() {
            assert_eq!(call.0, i);
            assert_eq!(call.1, i);
            assert!(approx_eq(call.2, 1.0, TOL));
        }
    }

    #[test]
    fn for_each_disjoint_below_emits_nothing() {
        let source = linear_edges(&[0.0, 1.0, 2.0]);
        let target = linear_edges(&[10.0, 11.0, 12.0]);
        let mut count = 0usize;
        for_each(&source, &target, |_, _, _| count += 1);
        assert_eq!(count, 0);
    }

    #[test]
    fn for_each_disjoint_above_emits_nothing() {
        let source = linear_edges(&[10.0, 11.0, 12.0]);
        let target = linear_edges(&[0.0, 1.0, 2.0]);
        let mut count = 0usize;
        for_each(&source, &target, |_, _, _| count += 1);
        assert_eq!(count, 0);
    }

    #[test]
    fn for_each_target_spans_two_source_bins() {
        // source bins: [0,1), [1,2), [2,3)
        // target bin:  [0.5, 2.5) -> overlaps source bin 0 by 0.5, bin 1 by 1.0, bin 2 by 0.5
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0]);
        let target = linear_edges(&[0.5, 2.5]);
        let mut calls: Vec<(usize, usize, f64)> = Vec::new();
        for_each(
            &source,
            &target,
            |target_index, source_index, overlap_width| {
                calls.push((target_index, source_index, overlap_width));
            },
        );
        assert_eq!(calls.len(), 3);
        assert_eq!(calls[0].0, 0);
        assert_eq!(calls[0].1, 0);
        assert!(approx_eq(calls[0].2, 0.5, TOL));
        assert_eq!(calls[1].1, 1);
        assert!(approx_eq(calls[1].2, 1.0, TOL));
        assert_eq!(calls[2].1, 2);
        assert!(approx_eq(calls[2].2, 0.5, TOL));
        let total: f64 = calls.iter().map(|c| c.2).sum();
        assert!(approx_eq(total, 2.0, TOL));
    }

    #[test]
    fn for_each_log_source_linear_target_linear_widths() {
        // Log-spaced source edges at 1, 10, 100. Linear target edges at 5, 50.
        // Expected linear-space overlap widths:
        //   target bin [5, 50) vs source bin [1, 10):   overlap = 10 - 5  = 5
        //   target bin [5, 50) vs source bin [10, 100): overlap = 50 - 10 = 40
        let source =
            Grid::new(array![1.0_f64, 10.0, 100.0], Spacing::Log, GridKind::Edges).unwrap();
        let target = linear_edges(&[5.0, 50.0]);
        let mut calls: Vec<(usize, usize, f64)> = Vec::new();
        for_each(
            &source,
            &target,
            |target_index, source_index, overlap_width| {
                calls.push((target_index, source_index, overlap_width));
            },
        );
        assert_eq!(calls.len(), 2);
        assert_eq!(calls[0].0, 0);
        assert_eq!(calls[0].1, 0);
        assert!(approx_eq(calls[0].2, 5.0, TOL));
        assert_eq!(calls[1].1, 1);
        assert!(approx_eq(calls[1].2, 40.0, TOL));
    }

    #[test]
    fn rebin_identity_linear() {
        let grid = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let values = array![1.0_f64, 2.0, 3.0, 4.0];
        let output = rebin(&grid, values.view(), &grid);
        assert_eq!(output.len(), values.len());
        for i in 0..values.len() {
            assert!(approx_eq(output[i], values[i], TOL));
        }
    }

    #[test]
    fn rebin_identity_log() {
        let grid = Grid::<f64>::logspace(1.0, 10000.0, 5, GridKind::Edges);
        let values = array![1.0_f64, 2.5, 7.0, 3.0];
        let output = rebin(&grid, values.view(), &grid);
        for i in 0..values.len() {
            assert!(approx_eq(output[i], values[i], TOL));
        }
    }

    #[test]
    fn rebin_constant_input_preserved_on_fully_covered_bins() {
        // Source bins covering [0, 10) with 10 unit-width bins, all-equal value c.
        // Target bins covering [2, 8) with 3 width-2 bins are all fully covered, so
        // the rebinned density should equal c there.
        // The first/last target bins at the original-grid edges would only partially
        // overlap, but we choose target entirely inside source to keep the property
        // exact for every output entry. Partial-coverage bins at the edges of the
        // source range are NOT required to equal c.
        let constant_value = 4.25_f64;
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0]);
        let source_values = Array1::<f64>::from_elem(10, constant_value);
        let target = linear_edges(&[2.0, 4.0, 6.0, 8.0]);
        let output = rebin(&source, source_values.view(), &target);
        assert_eq!(output.len(), 3);
        for value in output.iter() {
            assert!(approx_eq(*value, constant_value, TOL));
        }
    }

    #[test]
    fn rebin_downsample_two_to_one() {
        // Source: 4 width-1 bins with values [a, b, c, d]
        // Target: 2 width-2 bins -> expected [(a+b)/2, (c+d)/2]
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let target = linear_edges(&[0.0, 2.0, 4.0]);
        let values = array![1.0_f64, 3.0, 5.0, 9.0];
        let output = rebin(&source, values.view(), &target);
        assert_eq!(output.len(), 2);
        assert!(approx_eq(output[0], (1.0 + 3.0) / 2.0, TOL));
        assert!(approx_eq(output[1], (5.0 + 9.0) / 2.0, TOL));
    }

    #[test]
    #[should_panic(expected = "source_values length")]
    fn rebin_panics_on_length_mismatch() {
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0]);
        let target = linear_edges(&[0.0, 1.5, 3.0]);
        let bad_values = array![1.0_f64, 2.0]; // 2 != 3 source bins
        let _ = rebin(&source, bad_values.view(), &target);
    }

    #[test]
    fn rebin_variance_identity_linear() {
        let grid = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let variance = array![0.5_f64, 1.5, 2.5, 3.5];
        let output = rebin_variance(&grid, variance.view(), &grid);
        for i in 0..variance.len() {
            assert!(approx_eq(output[i], variance[i], TOL));
        }
    }

    #[test]
    fn rebin_variance_downsample_two_to_one_constant() {
        // Source: 4 width-1 bins, each with variance v.
        // Target: 2 width-2 bins. For each target bin:
        //   out = (1^2 * v + 1^2 * v) / 2^2 = 2v / 4 = v / 2
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let target = linear_edges(&[0.0, 2.0, 4.0]);
        let v = 0.8_f64;
        let variance = Array1::<f64>::from_elem(4, v);
        let output = rebin_variance(&source, variance.view(), &target);
        assert_eq!(output.len(), 2);
        assert!(approx_eq(output[0], v / 2.0, TOL));
        assert!(approx_eq(output[1], v / 2.0, TOL));
    }

    #[test]
    #[should_panic(expected = "source_variance length")]
    fn rebin_variance_panics_on_length_mismatch() {
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0]);
        let target = linear_edges(&[0.0, 1.5, 3.0]);
        let bad_variance = array![1.0_f64, 2.0]; // 2 != 3 source bins
        let _ = rebin_variance(&source, bad_variance.view(), &target);
    }

    #[test]
    fn coverage_target_fully_inside_source() {
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0, 5.0]);
        let target = linear_edges(&[1.0, 2.5, 4.0]);
        let cov = coverage(&source, &target);
        assert_eq!(cov.len(), 2);
        for value in cov.iter() {
            assert!(approx_eq(*value, 1.0, TOL));
        }
    }

    #[test]
    fn coverage_target_disjoint_from_source() {
        let source = linear_edges(&[0.0, 1.0, 2.0]);
        let target = linear_edges(&[10.0, 11.0, 12.0]);
        let cov = coverage(&source, &target);
        assert_eq!(cov.len(), 2);
        for value in cov.iter() {
            assert!(approx_eq(*value, 0.0, TOL));
        }
    }

    #[test]
    fn coverage_half_covered_edge_bin() {
        // Source spans [0, 4). Target bins: [-1, 1), [1, 3), [3, 5)
        // -> coverage 0.5, 1.0, 0.5
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0]);
        let target = linear_edges(&[-1.0, 1.0, 3.0, 5.0]);
        let cov = coverage(&source, &target);
        assert_eq!(cov.len(), 3);
        assert!(approx_eq(cov[0], 0.5, TOL));
        assert!(approx_eq(cov[1], 1.0, TOL));
        assert!(approx_eq(cov[2], 0.5, TOL));
    }

    #[test]
    fn for_each_one_target_covers_many_source_bins() {
        // Source bins: width-1 from 0 to 5 (i.e. 5 source bins).
        // Target bin: [0, 5) covers all of them with their full widths.
        let source = linear_edges(&[0.0, 1.0, 2.0, 3.0, 4.0, 5.0]);
        let target = linear_edges(&[0.0, 5.0]);
        let mut calls: Vec<(usize, usize, f64)> = Vec::new();
        for_each(
            &source,
            &target,
            |target_index, source_index, overlap_width| {
                calls.push((target_index, source_index, overlap_width));
            },
        );
        assert_eq!(calls.len(), 5);
        for (i, call) in calls.iter().enumerate() {
            assert_eq!(call.0, 0);
            assert_eq!(call.1, i);
            assert!(approx_eq(call.2, 1.0, TOL));
        }
    }
}