moc 0.19.2

Library made to create and manipulate HEALPix Multi-Order Coverages maps (MOCs), see https://ivoa.net/documents/MOC/
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
use std::{error::Error, io::Write};

use byteorder::WriteBytesExt;
use serde_json::{self, value::Value::Array, Value};

use crate::{
  elem::cell::Cell,
  elemset::cell::{Cells, MocCells},
  idx::Idx,
  moc::{cell::CellMOC, CellMOCIterator, HasMaxDepth},
  moc2d::{
    cell::{CellMOC2, CellMOC2Elem},
    CellMOC2ElemIt, CellMOC2Iterator,
  },
  qty::MocQty,
};

/// Write a JSON following the Aladin JSON format.
pub fn to_json_aladin<T, Q, I, W>(
  it: I,
  fold: &Option<usize>,
  line_prefix: &str,
  mut writer: W,
) -> std::io::Result<()>
where
  T: Idx,
  Q: MocQty<T>,
  I: CellMOCIterator<T, Qty = Q>,
  W: Write,
{
  // Create n_depth strings (1 per depth)
  let depth_max = it.depth_max();
  let mut s_by_depth: Vec<String> = (0..=depth_max)
    .map(|i| format!("{}  \"{}\": [", line_prefix, i))
    .collect();
  // Fill them
  for c in it {
    let buff = &mut s_by_depth[c.depth as usize];
    let s = format!("{}, ", c.idx);
    match fold {
      Some(n_chars) => {
        let l = buff.rfind('\n').unwrap_or(0);
        if buff.len() - l + s.len() > *n_chars {
          buff.push_str("\n    ");
          buff.push_str(line_prefix);
        }
        buff.push_str(&s)
      }
      None => buff.push_str(&s),
    }
  }
  // Finally write the result
  writer.write_all(b"{\n")?;
  let mut first = true;
  for (depth, s) in s_by_depth.into_iter().enumerate() {
    if !s.ends_with('[') {
      if first {
        first = false;
        // remove the last ',' and ' ' characters
        write!(writer, "{}]", &s[..s.len() - 2])?;
      } else {
        // remove the last ',' and ' ' characters
        // We could use again rfind to ckeck wether ']'
        // must be on a newline or not.
        // Let's wait for someone to complain...
        write!(writer, ",\n{}]", &s[..s.len() - 2])?;
      }
    } else if depth as u8 == depth_max {
      if first {
        write!(writer, "{}]", &s)?;
      } else {
        write!(writer, ",\n{}]", &s)?;
      }
    }
  }
  writer.write_all(format!("\n{}}}", line_prefix).as_bytes())?;
  Ok(())
}

pub fn cellmoc2d_to_json_aladin<T, Q, I, U, R, J, K, L, W>(
  moc2_it: L,
  fold: &Option<usize>,
  mut writer: W,
) -> std::io::Result<()>
where
  T: Idx,
  Q: MocQty<T>,
  I: CellMOCIterator<T, Qty = Q>,
  U: Idx,
  R: MocQty<U>,
  J: CellMOCIterator<U, Qty = R>,
  K: CellMOC2ElemIt<T, Q, U, R, It1 = I, It2 = J>,
  L: CellMOC2Iterator<T, Q, I, U, R, J, K>,
  W: Write,
{
  let d1 = moc2_it.depth_max_1();
  let d2 = moc2_it.depth_max_2();
  writer.write_all(b"[\n")?;
  let mut is_first = true;
  for e in moc2_it {
    let (moc1_it, moc2_it) = e.cell_mocs_it();
    if is_first {
      is_first = false;
      writer.write_all(b"{\n  \"")?;
    } else {
      writer.write_all(b",\n{\n  \"")?;
    }
    writer.write_u8(Q::PREFIX as u8)?;
    writer.write_all(b"\": ")?;
    to_json_aladin(moc1_it, fold, "  ", &mut writer)?;

    writer.write_all(b",\n  \"")?;
    writer.write_u8(R::PREFIX as u8)?;
    writer.write_all(b"\": ")?;
    to_json_aladin(moc2_it, fold, "  ", &mut writer)?;
    writer.write_all(b"\n}")?;
  }
  if !is_first {
    writer.write_all(b",\n")?;
  }
  write!(
    &mut writer,
    "{{ \"{}\": {{ \"{}\": [] }}, \"{}\": {{ \"{}\": [] }} }}",
    Q::PREFIX,
    d1,
    R::PREFIX,
    d2
  )?;
  writer.write_all(b"\n]\n")
}

/*pub fn rangemoc2d_to_json_aladin<T, Q, I, U, R, J, K, L, W>(
  moc2_it: L,
  fold: &Option<usize>,
  mut writer: W
) -> std::io::Result<()>
  where
    T: Idx,
    Q: MocQty<T>,
    I: RangeMOCIterator<T, Qty=Q>,
    U: Idx,
    R: MocQty<U>,
    J: RangeMOCIterator<U, Qty=R>,
    K: RangeMOC2ElemIt<T, Q, U, R, It1=I, It2=J>,
    L: RangeMOC2Iterator<T, Q, I, U, R, J, K>,
    W: Write
{
  writer.write_all(b"[\n")?;
  let mut is_first = true;
  for e in moc2_it {
    let (moc1_it, moc2_it) = e.range_mocs_it();
    let (moc1_it, moc2_it) = (moc1_it.cells(), moc2_it.cells());
    if is_first {
      is_first = false;
      writer.write_all(b"{\n  \"")?;
    } else {
      writer.write_all(b",\n{\n  \"")?;
    }
    writer.write_u8(Q::PREFIX as u8)?;
    writer.write_all(b"\": ")?;
    to_json_aladin(moc1_it, &fold, "  ", &mut writer)?;

    writer.write_all(b",\n  \"")?;
    writer.write_u8(R::PREFIX as u8)?;
    writer.write_all(b"\": ")?;
    to_json_aladin(moc2_it, &fold, "  ", &mut writer)?;
    writer.write_all(b"\n}")?;
  }
  writer.write_all(b"\n]\n")?;
  Ok(())
}*/

/// Read a JSON following the Aladin JSON format.
pub fn from_json_aladin<T, Q>(input: &str) -> Result<CellMOC<T, Q>, Box<dyn Error>>
where
  T: Idx, // + From<u64>,
  Q: MocQty<T>,
{
  // If streamming is needed, see:
  //   https://docs.serde.rs/serde_json/struct.StreamDeserializer.html
  // See https://docs.serde.rs/serde_json/#operating-on-untyped-json-values
  let root: Value = serde_json::from_str(input)?;
  from_json_aladin_internal::<T, Q>(&root)
}

fn from_json_aladin_internal<T, Q>(value: &Value) -> Result<CellMOC<T, Q>, Box<dyn Error>>
where
  T: Idx,
  Q: MocQty<T>,
{
  match value {
    Value::Object(map) => {
      // First reserve the exact number of cells, summing the len of all arrays
      let mut cells: Vec<Cell<T>> = Vec::with_capacity(
        (0..=Q::MAX_DEPTH)
          .filter_map(|d| match map.get(&d.to_string()) {
            Some(Array(vec)) => Some(vec.len()),
            _ => None,
          })
          .sum(),
      );
      // Convert each array element in a cell and add it to the cell list
      let mut depth_max = 0;
      for depth in 0..=Q::MAX_DEPTH {
        if let Some(Array(vec)) = map.get(&depth.to_string()) {
          for v in vec.iter().filter_map(|v| match v {
            Value::Number(idx) => idx.as_u64().and_then(
              |v| T::from_u64(v).into(), /*v.into()*/ /*T::try_from(v).ok()*/
            ),
            _ => None,
          }) {
            cells.push(Cell::new(depth, v));
          }
          depth_max = depth_max.max(depth);
        }
      }
      // Sort the cell list
      cells.sort_by(|a, b| a.flat_cmp::<Q>(b));
      // Check for non-overlapping cells
      for (e1, e2) in cells.iter().zip(cells.iter().skip(1)) {
        if e1.overlap::<Q>(e2) {
          return Err(
            String::from("The json MOC is not valid (contains overlapping elements").into(),
          );
        }
      }

      Ok(CellMOC::new(depth_max, MocCells::new(Cells::new(cells))))
    }
    _ => Err(
      format!(
        "Wrong JSON root type. Expected: Object. Actual: {:?}",
        &value
      )
      .into(),
    ),
  }
}

/// Read a JSON following the Aladin JSON format.
pub fn cellmoc2d_from_json_aladin<T, Q, U, R>(
  input: &str,
) -> Result<CellMOC2<T, Q, U, R>, Box<dyn Error>>
where
  T: Idx, // + From<u64>,
  Q: MocQty<T>,
  U: Idx, // + From<u64>,
  R: MocQty<U>,
{
  // If streamming is needed, see:
  //   https://docs.serde.rs/serde_json/struct.StreamDeserializer.html
  // See https://docs.serde.rs/serde_json/#operating-on-untyped-json-values
  let root: Value = serde_json::from_str(input)?;
  let mut depth_max_l = 0_u8;
  let mut depth_max_r = 0_u8;
  let mut elems: Vec<CellMOC2Elem<T, Q, U, R>> = Vec::with_capacity(100);
  match &root {
    Value::Array(entries) => {
      for entry in entries {
        if let Value::Object(map) = entry {
          let moc1 = map.get(&Q::PREFIX.to_string());
          let moc2 = map.get(&R::PREFIX.to_string());
          match (moc1, moc2) {
            (Some(obj1), Some(obj2)) => {
              let l: CellMOC<T, Q> = from_json_aladin_internal::<T, Q>(obj1)?;
              let r: CellMOC<U, R> = from_json_aladin_internal::<U, R>(obj2)?;
              depth_max_l = depth_max_l.max(l.depth_max());
              depth_max_r = depth_max_r.max(r.depth_max());
              if !l.is_empty() && !r.is_empty() {
                elems.push(CellMOC2Elem::new(l, r));
              }
            }
            _ => {
              return Err(
                format!(
                  "Wrong JSON array object type. Expected: (Object, Object). Actual: ({:?}, {:?})",
                  &moc1, &moc2
                )
                .into(),
              )
            }
          }
        } else {
          return Err(
            format!(
              "Wrong JSON array elem type. Expected: Object. Actual: {:?}",
              &entry
            )
            .into(),
          );
        }
      }
    }
    _ => return Err(format!("Wrong JSON root type. Expected: Array. Actual: {:?}", &root).into()),
  }
  Ok(CellMOC2::new(depth_max_l, depth_max_r, elems))
}

// json_stream :
// {
//   "qty": "",
//   "depth": "",
//   "cells": [uniq, uniq, ...]
// }

#[cfg(test)]
mod tests {
  use std::{fs, path::PathBuf, str::from_utf8};

  use crate::moc2d::{HasTwoMaxDepth, RangeMOC2Iterator};
  use crate::{
    deser::json::{cellmoc2d_from_json_aladin, cellmoc2d_to_json_aladin, from_json_aladin},
    elemset::range::{HpxRanges, MocRanges, TimeRanges},
    moc::{
      range::RangeMOC, CellMOCIntoIterator, CellMOCIterator, RangeMOCIntoIterator, RangeMOCIterator,
    },
    moc2d::{
      range::{RangeMOC2, RangeMOC2Elem},
      CellMOC2IntoIterator, CellMOC2Iterator, RangeMOC2IntoIterator,
    },
    qty::{Hpx, Time},
  };

  #[test]
  fn test_fromto_json() {
    let rm = RangeMOC::new(
      29,
      MocRanges::<u64, Hpx<u64>>::new_unchecked(vec![
        0..5,
        6..59,
        78..6953,
        12458..55587,
        55787..65587,
      ]),
    );
    let mut sink = Vec::new();
    (&rm)
      .into_range_moc_iter()
      .cells()
      .to_json_aladin(Some(40), &mut sink)
      .unwrap();
    let json = String::from_utf8_lossy(&sink);
    println!("{}\n", &json);
    let mut sink2 = Vec::new();
    from_json_aladin::<u64, Hpx<u64>>(&json)
      .unwrap()
      .into_cell_moc_iter()
      .to_json_aladin(Some(40), &mut sink2)
      .unwrap();
    // let json = String::from_utf8_lossy(&sink2);
    // println!("{}\n", &json);
    assert_eq!(sink, sink2);

    let mut sink = Vec::new();
    (&rm)
      .into_range_moc_iter()
      .cells()
      .to_json_aladin(None, &mut sink)
      .unwrap();
    let json = String::from_utf8_lossy(&sink);
    // println!("{}\n", &json);
    let mut sink2 = Vec::new();
    from_json_aladin::<u64, Hpx<u64>>(&json)
      .unwrap()
      .into_cell_moc_iter()
      .to_json_aladin(None, &mut sink2)
      .unwrap();
    // let json = String::from_utf8_lossy(&sink2);
    // println!("{}\n", &json);
    assert_eq!(sink, sink2);
  }

  #[test]
  fn test_to_json_empty() {
    let moc = RangeMOC::<u64, Hpx<u64>>::new_empty(8);
    let mut sink = Vec::new();
    (&moc)
      .into_range_moc_iter()
      .cells()
      .to_json_aladin(Some(40), &mut sink)
      .unwrap();
    // let json = String::from_utf8_lossy(&sink);
    // println!("{}\n", &json);
    assert_eq!(
      sink,
      String::from(
        r#"{
  "8": []
}"#
      )
      .into_bytes()
    )
  }

  #[test]
  fn test_stmoc_tofrom_json() {
    // Build moc
    let mut elems: Vec<RangeMOC2Elem<u64, Time<u64>, u64, Hpx<u64>>> = Default::default();
    elems.push(RangeMOC2Elem::new(
      RangeMOC::new(61, TimeRanges::new_unchecked(vec![1..2, 3..4, 5..6])),
      RangeMOC::new(
        4,
        HpxRanges::new_unchecked(vec![4503599627370496..18014398509481984]),
      ),
    ));
    elems.push(RangeMOC2Elem::new(
      RangeMOC::new(61, TimeRanges::new_unchecked(vec![50..51, 52..53])),
      RangeMOC::new(
        4,
        HpxRanges::new_unchecked(vec![28147497671065600..29273397577908224]),
      ),
    ));
    let moc2 = RangeMOC2::new(61, 4, elems);
    //
    let mut sink = Vec::new();
    // rangemoc2d_to_json_aladin(moc2.into_cell_moc2_iter(), &None, &mut sink);
    cellmoc2d_to_json_aladin(moc2.into_cell_moc2_iter(), &None, &mut sink).unwrap();
    let json = String::from_utf8_lossy(&sink);
    let _cellmoc2 = cellmoc2d_from_json_aladin::<u64, Time<u64>, u64, Hpx<u64>>(&json);
    // cellmoc2.into_cell_moc2_iter().
    println!("{}\n", &json);
  }

  #[test]
  fn test_stmoc_from_json_large() {
    let path_buf1 = PathBuf::from("resources/MOC2.0/STMOC-test4FX.json");
    let path_buf2 = PathBuf::from("../resources/MOC2.0/STMOC-test4FX.json");
    let json = fs::read_to_string(&path_buf1)
      .or_else(|_| fs::read_to_string(&path_buf2))
      .unwrap();
    let cellmoc2 = cellmoc2d_from_json_aladin::<u64, Time<u64>, u64, Hpx<u64>>(&json).unwrap();
    // cellmoc2.into_cell_moc2_iter().
    // println!("{}", cellmoc2.n_entries());
    assert_eq!(cellmoc2.n_entries(), 3532);
    /*let mut sink = Vec::new();
    cellmoc2d_to_json_aladin(cellmoc2.into_cell_moc2_iter(), &None, &mut sink);
    let json = String::from_utf8_lossy(&sink);
    let mut file = File::create("STMOC_P_FX.json").unwrap();
    file.write_all(json.as_ref().as_bytes()).unwrap();
    // println!("{}\n", &json);
    */
  }

  #[test]
  fn test_stmoc_empty_to_json() {
    let stmoc = RangeMOC2::<u64, Time<u64>, u64, Hpx<u64>>::new_empty(12, 8);
    let mut res_json = Vec::new();
    stmoc
      .into_range_moc2_iter()
      .into_cell_moc2_iter()
      .to_json_aladin(&None, &mut res_json)
      .unwrap();
    let json = from_utf8(res_json.as_ref()).unwrap();
    // println!("moc: {}", json);
    let expected = r#"[
{ "t": { "12": [] }, "s": { "8": [] } }
]
"#;
    assert_eq!(json, expected);

    let cellmoc2 = cellmoc2d_from_json_aladin::<u64, Time<u64>, u64, Hpx<u64>>(&expected).unwrap();
    assert_eq!(cellmoc2.depth_max_1(), 12);
    assert_eq!(cellmoc2.depth_max_2(), 8);
    assert_eq!(cellmoc2.n_entries(), 0);

    let stmoc2 = cellmoc2
      .into_cell_moc2_iter()
      .into_range_moc2_iter()
      .into_range_moc2();
    assert!(stmoc2.is_empty());
    assert_eq!(stmoc2.depth_max_1(), 12);
    assert_eq!(stmoc2.depth_max_2(), 8);
  }

  #[test]
  fn test_stmoc_from_json() {
    let json = r#"[
{
  "t": {
    "7": [0],
    "9": [4],
    "10": [10]
  },
  "s": {
    "9": [0, 1],
    "10": [8, 9, 10]
  }
},
{ "t": { "10": [] }, "s": { "10": [] } }
]"#;
    cellmoc2d_from_json_aladin::<u64, Time<u64>, u64, Hpx<u64>>(&json).unwrap();
  }
}