fits-well 0.1.2

A blazing-fast reader and writer for FITS (Flexible Image Transport System) files, targeting the full FITS 4.0 standard.
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
use super::*;

/// Golden values throughout are from `astropy.time` (ERFA).
#[test]
fn iso_to_jd_and_mjd_match_astropy() {
    let cases: &[(&str, f64, f64)] = &[
        ("2000-01-01T12:00:00", 2451545.0, 51544.5),
        ("1858-11-17T00:00:00", 2400000.5, 0.0),
        ("2024-02-29T06:30:15.5", 2460369.771012731, 60369.271012731),
        ("1900-01-01T00:00:00", 2415020.5, 15020.0),
        // A leap-second label rolls over to the next day (matches astropy).
        ("1999-12-31T23:59:60", 2451544.5, 51544.0),
        ("2024-06-01", 2460462.5, 60462.0), // date-only ⇒ midnight
    ];
    for &(s, jd, mjd) in cases {
        let d = Datetime::parse(s).unwrap();
        assert!(
            (d.to_jd() - jd).abs() < 1e-7,
            "{s}: jd {} vs {jd}",
            d.to_jd()
        );
        assert!(
            (d.to_mjd() - mjd).abs() < 1e-7,
            "{s}: mjd {} vs {mjd}",
            d.to_mjd()
        );
    }
}

#[test]
fn datetime_round_trips_through_jd() {
    for s in [
        "2024-02-29T06:30:15.5",
        "1900-01-01T00:00:00",
        "2000-01-01T12:00:00",
    ] {
        let d = Datetime::parse(s).unwrap();
        let back = Datetime::from_jd(d.to_jd());
        assert_eq!(
            (back.year, back.month, back.day),
            (d.year, d.month, d.day),
            "{s}"
        );
        assert_eq!((back.hour, back.minute), (d.hour, d.minute), "{s}");
        // Single-f64 JD at this epoch resolves the second to ~0.1 ms.
        assert!((back.second - d.second).abs() < 1e-3, "{s} second");
    }
}

#[test]
fn rejects_malformed_datetimes() {
    for s in [
        "",
        "2024",
        "2024-13-01",
        "2024-01-32",
        "2024-01-01T25:00:00",
        "x",
    ] {
        assert!(Datetime::parse(s).is_err(), "{s:?} should be rejected");
    }
}

#[test]
fn iso_8601_strictness() {
    // §9.1.1: omitted leading zeros, a `Z` designator, and a <4-digit year are
    // all rejected.
    for bad in [
        "2024-1-01",            // 1-digit month
        "2024-01-1",            // 1-digit day
        "2024-01-01T6:30:00",   // 1-digit hour
        "2024-01-01T06:30:5",   // 1-digit second
        "2024-01-01T06:30:00Z", // forbidden Z designator
        "999-01-01",            // 3-digit year
    ] {
        assert!(Datetime::parse(bad).is_err(), "{bad:?} should be rejected");
    }
    // Signed / extended years (with their leading zeros) are accepted.
    assert_eq!(Datetime::parse("-0044-03-15").unwrap().year, -44);
    assert_eq!(Datetime::parse("+12024-06-01").unwrap().year, 12024);
}

#[test]
fn reads_jepoch_and_bepoch_keywords() {
    use crate::header::Header;
    // JEPOCH=2000.0 ⇒ J2000.0 = MJD 51544.5, implied scale TDB.
    let mut hj = Header::new();
    hj.set("JEPOCH", 2000.0);
    let ej = FitsTime::epoch(&hj).unwrap();
    assert!((ej.mjd - 51544.5).abs() < 1e-6);
    assert_eq!(ej.scale, TimeScale::Tdb);
    // BEPOCH=1950.0 ⇒ B1950.0 = MJD 33281.92345905, implied scale ET ≈ TT.
    let mut hb = Header::new();
    hb.set("BEPOCH", 1950.0);
    let eb = FitsTime::epoch(&hb).unwrap();
    assert!((eb.mjd - 33281.92345905).abs() < 1e-4);
    assert_eq!(eb.scale, TimeScale::Tt);
    // Neither keyword ⇒ None.
    let empty = Header::new();
    assert!(FitsTime::epoch(&empty).is_none());
}

#[test]
fn reads_bound_duration_and_error_keywords() {
    use crate::header::Header;
    let mut h = Header::new();
    h.set("MJD-BEG", 58000.0);
    h.set("DATE-END", "2017-09-05T00:00:00");
    h.set("MJD-AVG", 58000.5);
    h.set("XPOSURE", 1200.0);
    h.set("TELAPSE", 1500.0);
    h.set("TIMEDEL", 0.1);
    h.set("TIMSYER", 1e-6);
    let b = FitsTime::bounds(&h);
    assert_eq!(b.beg_mjd, Some(58000.0));
    let end = Datetime::parse("2017-09-05T00:00:00").unwrap().to_mjd();
    assert!((b.end_mjd.unwrap() - end).abs() < 1e-9); // resolved from DATE-END
    assert_eq!(b.avg_mjd, Some(58000.5)); // §9.5 midpoint
    assert_eq!(b.xposure, Some(1200.0));
    assert_eq!(b.telapse, Some(1500.0));
    assert_eq!(b.timedel, Some(0.1));
    assert_eq!(b.timepixr, 0.5); // default when absent
    assert_eq!(b.timsyer, Some(1e-6));
    assert_eq!(b.timrder, None);
}

#[test]
fn gti_intervals_convert_to_absolute_mjd() {
    use crate::header::Header;
    let mut h = Header::new();
    h.set("MJDREF", 58000.0);
    h.set("TIMEUNIT", "d");
    let t = FitsTime::from_header(&h);
    let gtis = t.gti_intervals(&[0.0, 2.0], &[1.0, 3.0]);
    assert_eq!(
        gtis,
        vec![
            GtiInterval {
                start_mjd: 58000.0,
                stop_mjd: 58001.0,
            },
            GtiInterval {
                start_mjd: 58002.0,
                stop_mjd: 58003.0,
            },
        ]
    );
}

#[test]
fn classifies_time_related_axes() {
    use TimeAxisKind::*;
    assert_eq!(TimeAxisKind::from_ctype("TIME"), Some(Time));
    assert_eq!(TimeAxisKind::from_ctype("UTC"), Some(Time)); // a scale name is a time axis
    assert_eq!(TimeAxisKind::from_ctype("PHASE"), Some(Phase));
    assert_eq!(TimeAxisKind::from_ctype("TIMELAG"), Some(Timelag));
    assert_eq!(TimeAxisKind::from_ctype("FREQUENCY"), Some(Frequency));
    assert_eq!(TimeAxisKind::from_ctype("RA---TAN"), None);
    // is_time_ctype is true only for the absolute-time kind.
    assert!(is_time_ctype("TIME"));
    assert!(!is_time_ctype("PHASE"));
}

#[test]
fn reads_phase_axis_and_folds() {
    use crate::header::Header;
    // §9.6: a PHASE axis carries CZPHSia (zero-phase time) and CPERIia (period).
    let mut h = Header::new();
    h.set("CTYPE2", "PHASE");
    h.set("CZPHS2", 5.0);
    h.set("CPERI2", 2.0);
    let pa = FitsTime::phase_axis(&h, 2).unwrap();
    assert_eq!(pa.zero_phase, 5.0);
    assert_eq!(pa.period, 2.0);
    // Fold: ((8 − 5)/2) mod 1 = 1.5 mod 1 = 0.5; the zero-phase time folds to 0.
    assert_eq!(pa.fold(8.0), 0.5);
    assert_eq!(pa.fold(5.0), 0.0);
    // A non-phase axis yields nothing.
    h.set("CTYPE1", "RA---TAN");
    assert_eq!(FitsTime::phase_axis(&h, 1), None);
}

#[test]
fn obs_mjd_falls_back_to_jepoch() {
    use crate::header::Header;
    // §9.5: absent DATE-OBS/MJD-OBS, JEPOCH stands in for the observation time.
    let mut h = Header::new();
    h.set("JEPOCH", 2000.0); // J2000.0 = MJD 51544.5
    assert!((FitsTime::obs_mjd(&h).unwrap() - 51544.5).abs() < 1e-6);
    // An explicit MJD-OBS still wins.
    h.set("MJD-OBS", 58000.0);
    assert_eq!(FitsTime::obs_mjd(&h), Some(58000.0));
}

#[test]
fn epochs_match_astropy() {
    let cases: &[(&str, f64)] = &[
        ("J2000.0", 2451545.0),
        ("B1950.0", 2433282.42345905),
        ("J2015.5", 2457206.375),
        ("B1900.0", 2415020.31352),
    ];
    for &(s, jd) in cases {
        let e = Epoch::parse(s).unwrap();
        assert!((e.to_jd() - jd).abs() < 1e-5, "{s}: {} vs {jd}", e.to_jd());
    }
}

#[test]
fn scale_conversions_match_astropy() {
    // `convert` works in Julian Date; the golden values are astropy MJD in each
    // scale at UTC MJD 60462.0 (2024-06-01), given as the day-fraction beyond
    // 60462 (which `f64` represents without excess precision).
    const MJD0: f64 = 2_400_000.5;
    const BASE: f64 = 60462.0;
    let utc_jd = BASE + MJD0;
    let cases: &[(TimeScale, f64)] = &[
        (TimeScale::Tai, 0.000428240739),
        (TimeScale::Tt, 0.000800740738),
        (TimeScale::Tcg, 0.000812810154),
        (TimeScale::Tdb, 0.000800751230),
        (TimeScale::Tcb, 0.001069271013),
        (TimeScale::Gps, 0.000208333331),
    ];
    for &(scale, want_frac) in cases {
        let got_frac = TimeScale::Utc.convert(utc_jd, scale) - MJD0 - BASE;
        assert!(
            (got_frac - want_frac).abs() < 1e-9,
            "UTC→{scale:?}: {got_frac:.12} vs {want_frac:.12} (Δ={:.2e} s)",
            (got_frac - want_frac) * 86400.0
        );
        // Round-trip back to UTC.
        let back = scale.convert(BASE + want_frac + MJD0, TimeScale::Utc) - MJD0;
        assert!(
            (back - BASE).abs() < 1e-9,
            "{scale:?}→UTC round-trip: {back}"
        );
    }
}

#[test]
fn ut1_uses_explicit_dut1() {
    const MJD0: f64 = 2_400_000.5;
    let utc_jd = 60462.0 + MJD0;
    let dut1 = -0.020434661; // astropy ΔUT1 = UT1 − UTC at 2024-06-01
    let ut1 = TimeScale::Utc.convert_dut1(utc_jd, TimeScale::Ut1, dut1) - MJD0;
    // astropy UT1 MJD, as the day-fraction beyond 60462 (UT1 − 60462).
    let want = -0.000000236512;
    assert!(
        (ut1 - 60462.0 - want).abs() < 1e-9,
        "UT1 {ut1:.12} (Δ={:.4e} s)",
        (ut1 - 60462.0 - want) * 86400.0
    );
    // Round-trip back to UTC.
    let back = TimeScale::Ut1.convert_dut1(ut1 + MJD0, TimeScale::Utc, dut1) - MJD0;
    assert!((back - 60462.0).abs() < 1e-9);
    // With ΔUT1 = 0, UT1 collapses to UTC (the `convert` default).
    assert_eq!(TimeScale::Utc.convert(utc_jd, TimeScale::Ut1), utc_jd);
}

#[test]
fn time_axis_resolves_to_mjd() {
    use crate::header::Header;
    let mut h = Header::new();
    h.set("MJDREF", 58000.0);
    h.set("TIMESYS", "TT");
    h.set("TIMEUNIT", "s");
    h.set("CTYPE3", "TIME");
    h.set("CRPIX3", 1.0).set("CRVAL3", 0.0).set("CDELT3", 10.0); // 10 s / pixel
    let t = FitsTime::from_header(&h);
    // Pixel 1 → 0 s → MJDREF; pixel 11 → 100 s later.
    assert!((t.time_axis_mjd(&h, 3, 1.0).unwrap() - 58000.0).abs() < 1e-12);
    assert!((t.time_axis_mjd(&h, 3, 11.0).unwrap() - (58000.0 + 100.0 / 86400.0)).abs() < 1e-12);
    // A non-time axis returns None.
    h.set("CTYPE1", "RA---TAN");
    assert!(t.time_axis_mjd(&h, 1, 1.0).is_none());
}

#[test]
fn leap_seconds_match_iers_table() {
    let at = |y, m, d| {
        leap_seconds(
            Datetime::parse(&format!("{y}-{m:02}-{d:02}"))
                .unwrap()
                .to_mjd(),
        )
    };
    assert_eq!(at(1972, 1, 1), 10.0);
    assert_eq!(at(1999, 1, 1), 32.0);
    assert_eq!(at(2017, 1, 1), 37.0);
    assert_eq!(at(2024, 6, 1), 37.0);
    assert_eq!(at(1980, 1, 1), 19.0);
    // Just before the 1999 step is still 31 s.
    assert_eq!(at(1998, 12, 31), 31.0);
}

#[test]
fn fits_time_resolves_reference_and_relative_times() {
    use crate::header::Header;
    let mut h = Header::new();
    h.set("TIMESYS", "TT");
    h.set("MJDREF", 58000.0);
    h.set("TIMEUNIT", "s");
    h.set("TREFPOS", "TOPOCENTER");
    h.set("TSTART", 0.0);
    h.set("TSTOP", 86400.0); // one day, in seconds
    h.set("DATE-OBS", "2017-09-04T00:00:00");

    let t = FitsTime::from_header(&h);
    assert_eq!(t.scale, TimeScale::Tt);
    assert_eq!(t.mjdref, 58000.0);
    assert_eq!(t.trefpos.as_deref(), Some("TOPOCENTER"));
    assert_eq!(t.unit_seconds(), 1.0);
    // TSTART=0 → MJDREF; TSTOP=86400 s → one day later.
    assert!((t.relative_to_mjd(0.0) - 58000.0).abs() < 1e-12);
    assert!((t.relative_to_mjd(86400.0) - 58001.0).abs() < 1e-12);
    // DATE-OBS 2017-09-04 = MJD 58000.0.
    assert!((FitsTime::obs_mjd(&h).unwrap() - 58000.0).abs() < 1e-9);
}

#[test]
fn fits_time_reads_split_and_day_unit_references() {
    use crate::header::Header;
    let mut h = Header::new();
    h.set("MJDREFI", 58000.0);
    h.set("MJDREFF", 0.25);
    h.set("TIMEUNIT", "d");
    let t = FitsTime::from_header(&h);
    assert_eq!(t.scale, TimeScale::Utc); // default
    assert!((t.mjdref - 58000.25).abs() < 1e-12);
    assert_eq!(t.unit_seconds(), 86400.0);
    // 2 days past the reference.
    assert!((t.relative_to_mjd(2.0) - 58002.25).abs() < 1e-12);
}

#[test]
fn time_scale_parse_strips_realization_and_aliases() {
    // §9.2.1: a parenthesised realization suffix is stripped before matching.
    assert_eq!(TimeScale::parse("TT(TAI)"), TimeScale::Tt);
    assert_eq!(TimeScale::parse("UTC(NIST)"), TimeScale::Utc);
    assert_eq!(TimeScale::parse("tt"), TimeScale::Tt);
    assert_eq!(TimeScale::parse("TDT"), TimeScale::Tt); // alias
    assert_eq!(TimeScale::parse("IAT"), TimeScale::Tai); // alias
    assert_eq!(TimeScale::parse("GMT"), TimeScale::Utc); // §9.2.1: GMT ≡ UTC
    assert_eq!(TimeScale::parse("BOGUS"), TimeScale::Local);
}

#[test]
fn timeoffs_shifts_relative_times() {
    use crate::header::Header;
    // MJDREF=58000, TIMEUNIT=s, TIMEOFFS=10 s: the offset is added before scaling,
    // so a relative value of 0 lands 10 s past the reference (§9.4.1).
    let mut h = Header::new();
    h.set("MJDREF", 58000.0);
    h.set("TIMEUNIT", "s");
    h.set("TIMEOFFS", 10.0);
    let t = FitsTime::from_header(&h);
    assert_eq!(t.timeoffs, 10.0);
    assert!((t.relative_to_mjd(0.0) - (58000.0 + 10.0 / 86400.0)).abs() < 1e-12);
    assert!((t.relative_to_mjd(5.0) - (58000.0 + 15.0 / 86400.0)).abs() < 1e-12);
}

#[test]
fn timeunit_minute_hour_century_scale_correctly() {
    use crate::header::Header;
    let unit = |u: &str| {
        let mut h = Header::new();
        h.set("TIMEUNIT", u);
        FitsTime::from_header(&h).unit_seconds()
    };
    // Previously min/h/cy silently fell through to 1 s; Table 34 fixes that.
    assert_eq!(unit("min"), 60.0);
    assert_eq!(unit("h"), 3600.0);
    assert_eq!(unit("d"), 86400.0);
    assert_eq!(unit("a"), 365.25 * 86400.0); // Julian year
    assert_eq!(unit("cy"), 36525.0 * 86400.0); // Julian century
    assert_eq!(unit("s"), 1.0);
    assert_eq!(unit("bogus"), 1.0); // unknown ⇒ seconds (lenient default)
    // Deprecated tropical/Besselian years are ~a year, not seconds.
    assert!((unit("ta") / 86400.0 - 365.24219).abs() < 1e-6);
    assert!((unit("Ba") / 86400.0 - 365.2421988).abs() < 1e-6);
}

#[test]
fn split_reference_takes_precedence_over_single_mjdref() {
    use crate::header::Header;
    let mjdref = |pairs: &[(&str, f64)]| {
        let mut h = Header::new();
        for &(k, v) in pairs {
            h.set(k, v);
        }
        FitsTime::from_header(&h).mjdref
    };
    // §9.2.2: a full integer+fractional split wins over the single value.
    assert!(
        (mjdref(&[("MJDREF", 58000.0), ("MJDREFI", 59000.0), ("MJDREFF", 0.5)]) - 59000.5).abs()
            < 1e-9
    );
    // Single value alone is used as-is.
    assert!((mjdref(&[("MJDREF", 58000.0)]) - 58000.0).abs() < 1e-9);
    // An incomplete split (integer part only) defers to the single value.
    assert!((mjdref(&[("MJDREF", 58000.0), ("MJDREFI", 59000.0)]) - 58000.0).abs() < 1e-9);
}