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
//! This crate implements a fits image parser
//!
//! # Examples
//!
//! Basic usage:
//!
//! ```
//! use std::fs::File;
//! use std::io::BufReader;
//!
//! use fitsrs::{fits::Fits, hdu::HDU};
//! use fitsrs::hdu::data::iter;
//!
//! let f = File::open("samples/fits.gsfc.nasa.gov/HST_FOC.fits").unwrap();
//! let mut reader = BufReader::new(f);
//! let Fits { mut hdu } = Fits::from_reader(&mut reader).unwrap();
//! let xtension = hdu.get_header().get_xtension();
//! let naxis1 = *xtension.get_naxisn(1).unwrap() as usize;
//! let naxis2 = *xtension.get_naxisn(2).unwrap() as usize;
//!
//! if let iter::Data::F32(it) = hdu.get_data_mut() {
//!     let data = it.collect::<Vec<_>>();
//!     assert_eq!(data.len(), naxis1 * naxis2);
//! } else {
//!     panic!("expected data block containing f32");
//! }
//! ```

extern crate async_trait;
extern crate byteorder;
extern crate nom;
#[macro_use]
extern crate quick_error;

pub mod card;
pub mod error;
pub mod fits;
pub mod hdu;

#[cfg(test)]
mod tests {
    use crate::fits::{AsyncFits, Fits};
    use crate::hdu::data::iter;
    use crate::hdu::data::stream;
    use crate::hdu::data::InMemData;
    use crate::hdu::extension::AsyncXtensionHDU;
    use crate::hdu::extension::XtensionHDU;
    use crate::hdu::header::extension::Xtension;
    use crate::hdu::header::BitpixValue;

    use std::fs::File;
    use std::io::Cursor;
    use std::io::{BufReader, Read};

    use futures::{StreamExt, TryStreamExt};
    use test_case::test_case;

    #[test]
    fn test_fits_image_mandatory_kw() {
        let f = File::open("samples/hipsgen/Npix208.fits").unwrap();
        let bytes: Result<Vec<_>, _> = f.bytes().collect();
        let buf = bytes.unwrap();

        let mut reader = Cursor::new(&buf[..]);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let header = hdu.get_header();
        assert_eq!(header.get_xtension().get_naxisn(1), Some(&64));
        assert_eq!(header.get_xtension().get_naxisn(2), Some(&64));
        assert_eq!(header.get_xtension().get_naxis(), 2);
        assert_eq!(header.get_xtension().get_bitpix(), BitpixValue::F32);
        if let Ok(None) = hdu.next() {
            assert!(true);
        } else {
            assert!(false);
        }
    }

    #[test_case("samples/fits.gsfc.nasa.gov/Astro_UIT.fits", 1, 0, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/EUVE.fits", 5, 0, 4)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FGS.fits", 1, 1, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FOC.fits", 1, 1, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FOS.fits", 1, 1, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_HRS.fits", 1, 1, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_NICMOS.fits", 6, 0, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_WFPC_II.fits", 1, 1, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_WFPC_II_bis.fits", 1, 0, 0)]
    #[test_case("samples/fits.gsfc.nasa.gov/IUE_LWP.fits", 1, 0, 1)]
    fn test_count_hdu(
        filename: &str,
        num_image_ext: usize,
        num_asciitable_ext: usize,
        num_bintable_ext: usize,
    ) {
        let f = File::open(filename).unwrap();
        let bytes: Result<Vec<_>, _> = f.bytes().collect();
        let buf = bytes.unwrap();

        let mut reader = Cursor::new(&buf[..]);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let mut n_image_ext = 1; // because the primary hdu is an image
        let mut n_bintable_ext = 0;
        let mut n_asciitable_ext = 0;

        let mut hdu_ext = hdu.next();

        while let Ok(Some(hdu)) = hdu_ext {
            match &hdu {
                XtensionHDU::Image(_) => {
                    n_image_ext += 1;
                }
                XtensionHDU::BinTable(_) => {
                    n_bintable_ext += 1;
                }
                XtensionHDU::AsciiTable(_) => {
                    n_asciitable_ext += 1;
                }
            }

            hdu_ext = hdu.next();
        }

        assert_eq!(n_image_ext, num_image_ext);
        assert_eq!(n_bintable_ext, num_bintable_ext);
        assert_eq!(n_asciitable_ext, num_asciitable_ext);
    }

    #[test]
    fn test_fits_image_f32() {
        let f = File::open("samples/hipsgen/Npix208.fits").unwrap();
        let bytes: Result<Vec<_>, _> = f.bytes().collect();
        let buf = bytes.unwrap();

        let mut reader = Cursor::new(&buf[..]);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let header = hdu.get_header();
        let num_pixels = header.get_xtension().get_naxisn(1).unwrap()
            * header.get_xtension().get_naxisn(2).unwrap();
        let data = hdu.get_data();
        match data {
            InMemData::F32(slice) => {
                assert!(slice.len() as u64 == num_pixels);
            }
            _ => unreachable!(),
        }
    }

    #[test]
    fn test_fits_i16() {
        let mut f = File::open("samples/hipsgen/Npix4906.fits").unwrap();
        let mut raw_bytes = Vec::<u8>::new();
        f.read_to_end(&mut raw_bytes).unwrap();

        let mut reader = Cursor::new(&raw_bytes[..]);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();
        let xtension = hdu.get_header().get_xtension();
        match hdu.get_data() {
            &InMemData::I16(data) => {
                assert!(
                    data.len() as u64 == xtension.get_naxisn(1).unwrap() * xtension.get_naxisn(2).unwrap()
                )
            }
            _ => unreachable!(),
        }
    }

    #[test_case("samples/hipsgen/Npix8.fits")]
    #[test_case("samples/hipsgen/Npix9.fits")]
    #[test_case("samples/hipsgen/Npix132.fits")]
    #[test_case("samples/hipsgen/Npix133.fits")]
    #[test_case("samples/hipsgen/Npix134.fits")]
    #[test_case("samples/hipsgen/Npix140.fits")]
    #[test_case("samples/hipsgen/Npix208.fits")]
    #[test_case("samples/hipsgen/Npix282.fits")]
    #[test_case("samples/hipsgen/Npix4906.fits")]
    #[test_case("samples/hipsgen/Npix691539.fits")]
    #[test_case("samples/hips2fits/allsky_panstarrs.fits")]
    #[test_case("samples/hips2fits/cutout-CDS_P_HST_PHAT_F475W.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/Astro_UIT.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/EUVE.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FGS.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FOC.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FOS.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_HRS.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_NICMOS.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_WFPC_II.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_WFPC_II_bis.fits")]
    #[test_case("samples/vizier/NVSSJ235137-362632r.fits")]
    #[test_case("samples/vizier/VAR.358.R.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/IUE_LWP.fits")]
    #[test_case("samples/misc/bonn.fits")]
    #[test_case("samples/misc/EUC_MER_MOSAIC-VIS-FLAG_TILE100158585-1EC1C5_20221211T132329.822037Z_00.00.fits")]
    #[test_case("samples/misc/P122_49.fits")]
    #[test_case("samples/misc/skv1678175163788.fits")]
    #[test_case("samples/misc/SN2923fxjA.fits")]
    //#[test_case("samples/misc/ji0590044.fits")] gzip compressed data
    //#[test_case("samples/misc/AKAI013000932.fits")] gzip compressed data
    fn test_fits_opening(filename: &str) {
        use std::fs::File;

        let mut f = File::open(filename).unwrap();
        let mut buf = Vec::new();
        f.read_to_end(&mut buf).unwrap();

        let mut reader = Cursor::new(&buf[..]);
        let fits = Fits::from_reader(&mut reader);
        assert!(fits.is_ok());
    }

    #[test]
    fn test_fits_image_owned() {
        use std::fs::File;
        use std::io::BufReader;

        let f = File::open("samples/fits.gsfc.nasa.gov/EUVE.fits").unwrap();
        let mut reader = BufReader::new(f);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        if let Ok(Some(XtensionHDU::Image(mut image))) = hdu.next() {
            let xtension = image.get_header().get_xtension();
            let naxis1 = *xtension.get_naxisn(1).unwrap();
            let naxis2 = *xtension.get_naxisn(2).unwrap();

            let data = image.get_data_mut();
            match data {
                iter::Data::I16(it) => {
                    let data = it.collect::<Vec<_>>();
                    assert_eq!(data.len(), (naxis1 * naxis2) as usize);
                }
                _ => unreachable!(),
            }
        }
    }

    #[test]
    fn test_fits_image_borrowed() {
        use std::fs::File;

        let mut f = File::open("samples/fits.gsfc.nasa.gov/HST_FOC.fits").unwrap();
        let mut buf = Vec::new();
        f.read_to_end(&mut buf).unwrap();

        let mut reader = Cursor::new(&buf[..]);
        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let naxis1 = *hdu.get_header().get_xtension().get_naxisn(1).unwrap();
        let naxis2 = *hdu.get_header().get_xtension().get_naxisn(2).unwrap();
        let data = hdu.get_data();
        match data {
            &InMemData::F32(data) => {
                assert_eq!(data.len(), (naxis1 * naxis2) as usize);
            }
            _ => unreachable!(),
        }
    }

    #[test]
    fn test_fits_images_data_block() {
        use std::fs::File;

        let mut f = File::open("samples/fits.gsfc.nasa.gov/EUVE.fits").unwrap();
        let mut buf = Vec::new();
        f.read_to_end(&mut buf).unwrap();
        let mut reader = Cursor::new(&buf[..]);

        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let mut hdu_ext = hdu.next();

        while let Ok(Some(xhdu)) = hdu_ext {
            match &xhdu {
                XtensionHDU::Image(xhdu) => {
                    let xtension = xhdu.get_header().get_xtension();

                    let naxis1 = *xtension.get_naxisn(1).unwrap();
                    let naxis2 = *xtension.get_naxisn(2).unwrap();

                    let num_pixels = (naxis2 * naxis1) as usize;

                    match xhdu.get_data() {
                        InMemData::U8(mem) => assert_eq!(num_pixels, mem.len()),
                        InMemData::I16(mem) => assert_eq!(num_pixels, mem.len()),
                        InMemData::I32(mem) => assert_eq!(num_pixels, mem.len()),
                        InMemData::I64(mem) => assert_eq!(num_pixels, mem.len()),
                        InMemData::F32(mem) => assert_eq!(num_pixels, mem.len()),
                        InMemData::F64(mem) => assert_eq!(num_pixels, mem.len()),
                    }
                }
                XtensionHDU::BinTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    match xhdu.get_data() {
                        InMemData::U8(mem) => assert_eq!(num_bytes as usize, mem.len()),
                        _ => unreachable!(),
                    }
                }
                XtensionHDU::AsciiTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    match xhdu.get_data() {
                        InMemData::U8(mem) => assert_eq!(num_bytes as usize, mem.len()),
                        _ => unreachable!(),
                    }
                }
            }

            hdu_ext = xhdu.next();
        }
    }

    #[test]
    fn test_fits_images_data_block_bufreader() {
        use std::fs::File;

        let f = File::open("samples/fits.gsfc.nasa.gov/EUVE.fits").unwrap();
        let mut reader = BufReader::new(f);

        let Fits { hdu } = Fits::from_reader(&mut reader).unwrap();

        let mut hdu_ext = hdu.next();

        while let Ok(Some(mut xhdu)) = hdu_ext {
            match &mut xhdu {
                XtensionHDU::Image(xhdu) => {
                    let xtension = xhdu.get_header().get_xtension();

                    let naxis1 = *xtension.get_naxisn(1).unwrap();
                    let naxis2 = *xtension.get_naxisn(2).unwrap();

                    let num_pixels = naxis2 * naxis1;

                    match xhdu.get_data_mut() {
                        iter::Data::U8(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                        iter::Data::I16(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                        iter::Data::I32(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                        iter::Data::I64(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                        iter::Data::F32(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                        iter::Data::F64(it) => {
                            let data = it.collect::<Vec<_>>();
                            assert_eq!(num_pixels as usize, data.len())
                        }
                    }
                }
                XtensionHDU::BinTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    let it_bytes = xhdu.get_data_mut();
                    let data = it_bytes.collect::<Vec<_>>();
                    assert_eq!(num_bytes as usize, data.len());
                }
                XtensionHDU::AsciiTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    let it_bytes = xhdu.get_data_mut();
                    let data = it_bytes.collect::<Vec<_>>();
                    assert_eq!(num_bytes as usize, data.len());
                }
            }

            hdu_ext = xhdu.next();
        }
    }

    #[test]
    fn test_bad_bytes() {
        let bytes: &[u8] = &[
            60, 33, 68, 79, 67, 84, 89, 80, 69, 32, 72, 84, 77, 76, 32, 80, 85, 66, 76, 73, 67, 32,
            34, 45, 47, 47, 73, 69, 84, 70, 47, 47, 68, 84, 68, 32, 72, 84, 77, 76, 32, 50, 46, 48,
            47, 47, 69, 78, 34, 62, 10, 60, 104, 116, 109, 108, 62, 60, 104, 101, 97, 100, 62, 10,
            60, 116, 105, 116, 108, 101, 62, 52, 48, 52, 32, 78, 111, 116, 32, 70, 111, 117, 110,
            100, 60, 47, 116, 105, 116, 108, 101, 62, 10, 60, 47, 104, 101, 97, 100, 62, 60, 98,
            111, 100, 121, 62, 10, 60, 104, 49, 62, 78, 111, 116, 32, 70, 111, 117, 110, 100, 60,
            47, 104, 49, 62, 10, 60, 112, 62, 84, 104, 101, 32, 114, 101, 113, 117, 101, 115, 116,
            101, 100, 32, 85, 82, 76, 32, 47, 97, 108, 108, 115, 107, 121, 47, 80, 78, 82, 101,
            100, 47, 78, 111, 114, 100, 101, 114, 55, 47, 68, 105, 114, 52, 48, 48, 48, 48, 47, 78,
            112, 105, 120, 52, 52, 49, 49, 49, 46, 102, 105, 116, 115, 32, 119, 97, 115, 32, 110,
            111, 116, 32, 102, 111, 117, 110, 100, 32, 111, 110, 32, 116, 104, 105, 115, 32, 115,
            101, 114, 118, 101, 114, 46, 60, 47, 112, 62, 10, 60, 47, 98, 111, 100, 121, 62, 60,
            47, 104, 116, 109, 108, 62, 10,
        ];
        let mut reader = Cursor::new(bytes);
        assert!(Fits::from_reader(&mut reader).is_err());
    }

    #[test_case("samples/misc/EUC_MER_MOSAIC-VIS-FLAG_TILE100158585-1EC1C5_20221211T132329.822037Z_00.00.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/EUVE.fits")]
    #[test_case("samples/fits.gsfc.nasa.gov/HST_FOC.fits")]
    #[test_case("samples/vizier/new_url.fits")]
    #[tokio::test]
    async fn test_fits_images_data_block_bufreader_async(filename: &str) {
        use std::fs::File;

        // Put it all in memory first (this is for the exemple)
        // It is not good to do so for performance reasons
        // Better prefer to pipe to a ReadableStream instead
        let mut f = File::open(filename).unwrap();
        let mut buf = Vec::new();
        f.read_to_end(&mut buf).unwrap();

        let mut reader = futures::io::BufReader::new(&buf[..]);

        let AsyncFits { mut hdu } = AsyncFits::from_reader(&mut reader).await.unwrap();
        let xtension = hdu.get_header().get_xtension();

        if xtension.get_naxis() == 2 {
            let naxis1 = *xtension.get_naxisn(1).unwrap();
            let naxis2 = *xtension.get_naxisn(2).unwrap();
    
            let num_pixels = (naxis2 * naxis1) as usize;
    
            match hdu.get_data_mut() {
                stream::Data::U8(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len())
                }
                stream::Data::I16(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len())
                }
                stream::Data::I32(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len());
                }
                stream::Data::I64(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len())
                }
                stream::Data::F32(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len())
                }
                stream::Data::F64(stream) => {
                    let data = stream.try_collect::<Vec<_>>().await.unwrap();
                    assert_eq!(num_pixels, data.len())
                }
            }
        }

        let mut hdu_ext = hdu.next().await;

        while let Ok(Some(mut xhdu)) = hdu_ext {
            match &mut xhdu {
                AsyncXtensionHDU::Image(xhdu) => {
                    let xtension = xhdu.get_header().get_xtension();

                    let naxis1 = *xtension.get_naxisn(1).unwrap();
                    let naxis2 = *xtension.get_naxisn(2).unwrap();

                    let num_pixels = (naxis2 * naxis1) as usize;

                    match xhdu.get_data_mut() {
                        stream::Data::U8(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len())
                        }
                        stream::Data::I16(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len())
                        }
                        stream::Data::I32(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len());
                        }
                        stream::Data::I64(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len())
                        }
                        stream::Data::F32(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len())
                        }
                        stream::Data::F64(stream) => {
                            let data = stream.collect::<Vec<_>>().await;
                            assert_eq!(num_pixels, data.len())
                        }
                    }
                }
                AsyncXtensionHDU::BinTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    let it_bytes = xhdu.get_data_mut();
                    let data = it_bytes.collect::<Vec<_>>().await;
                    assert_eq!(num_bytes as usize, data.len());
                }
                AsyncXtensionHDU::AsciiTable(xhdu) => {
                    let num_bytes = xhdu.get_header().get_xtension().get_num_bytes_data_block();

                    let it_bytes = xhdu.get_data_mut();
                    let data = it_bytes.collect::<Vec<_>>().await;
                    assert_eq!(num_bytes as usize , data.len());
                }
            }

            hdu_ext = xhdu.next().await;
        }
    }
}