imap-processing 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. imap_processing/_version.py +2 -2
  2. imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml +13 -1
  3. imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml +97 -254
  4. imap_processing/cdf/config/imap_codice_l2-hi-omni_variable_attrs.yaml +635 -0
  5. imap_processing/cdf/config/imap_codice_l2-hi-sectored_variable_attrs.yaml +422 -0
  6. imap_processing/cdf/config/imap_enamaps_l2-common_variable_attrs.yaml +29 -22
  7. imap_processing/cdf/config/imap_enamaps_l2-healpix_variable_attrs.yaml +2 -0
  8. imap_processing/cdf/config/imap_enamaps_l2-rectangular_variable_attrs.yaml +12 -2
  9. imap_processing/cdf/config/imap_swapi_variable_attrs.yaml +2 -13
  10. imap_processing/cdf/utils.py +2 -2
  11. imap_processing/cli.py +10 -27
  12. imap_processing/codice/codice_l1a_lo_angular.py +362 -0
  13. imap_processing/codice/codice_l1a_lo_species.py +282 -0
  14. imap_processing/codice/codice_l1b.py +62 -97
  15. imap_processing/codice/codice_l2.py +801 -174
  16. imap_processing/codice/codice_new_l1a.py +64 -0
  17. imap_processing/codice/constants.py +96 -0
  18. imap_processing/codice/utils.py +270 -0
  19. imap_processing/ena_maps/ena_maps.py +157 -95
  20. imap_processing/ena_maps/utils/coordinates.py +5 -0
  21. imap_processing/ena_maps/utils/corrections.py +450 -0
  22. imap_processing/ena_maps/utils/map_utils.py +143 -42
  23. imap_processing/ena_maps/utils/naming.py +3 -1
  24. imap_processing/hi/hi_l1c.py +34 -12
  25. imap_processing/hi/hi_l2.py +82 -44
  26. imap_processing/ialirt/constants.py +7 -1
  27. imap_processing/ialirt/generate_coverage.py +3 -1
  28. imap_processing/ialirt/l0/parse_mag.py +1 -0
  29. imap_processing/ialirt/l0/process_codice.py +66 -0
  30. imap_processing/ialirt/l0/process_hit.py +1 -0
  31. imap_processing/ialirt/l0/process_swapi.py +1 -0
  32. imap_processing/ialirt/l0/process_swe.py +2 -0
  33. imap_processing/ialirt/process_ephemeris.py +6 -2
  34. imap_processing/ialirt/utils/create_xarray.py +4 -2
  35. imap_processing/idex/idex_l2a.py +2 -2
  36. imap_processing/idex/idex_l2b.py +1 -1
  37. imap_processing/lo/l1c/lo_l1c.py +62 -4
  38. imap_processing/lo/l2/lo_l2.py +85 -15
  39. imap_processing/mag/l1a/mag_l1a.py +2 -2
  40. imap_processing/mag/l1a/mag_l1a_data.py +71 -13
  41. imap_processing/mag/l1c/interpolation_methods.py +34 -13
  42. imap_processing/mag/l1c/mag_l1c.py +117 -67
  43. imap_processing/mag/l1d/mag_l1d_data.py +3 -1
  44. imap_processing/quality_flags.py +1 -0
  45. imap_processing/spice/geometry.py +11 -9
  46. imap_processing/spice/pointing_frame.py +77 -50
  47. imap_processing/swapi/constants.py +4 -0
  48. imap_processing/swapi/l1/swapi_l1.py +59 -24
  49. imap_processing/swapi/l2/swapi_l2.py +17 -3
  50. imap_processing/swe/utils/swe_constants.py +7 -7
  51. imap_processing/ultra/l1a/ultra_l1a.py +121 -72
  52. imap_processing/ultra/l1b/de.py +57 -1
  53. imap_processing/ultra/l1b/extendedspin.py +1 -1
  54. imap_processing/ultra/l1b/ultra_l1b_annotated.py +0 -1
  55. imap_processing/ultra/l1b/ultra_l1b_culling.py +2 -2
  56. imap_processing/ultra/l1b/ultra_l1b_extended.py +25 -12
  57. imap_processing/ultra/l1c/helio_pset.py +29 -6
  58. imap_processing/ultra/l1c/l1c_lookup_utils.py +4 -2
  59. imap_processing/ultra/l1c/spacecraft_pset.py +10 -6
  60. imap_processing/ultra/l1c/ultra_l1c.py +6 -6
  61. imap_processing/ultra/l1c/ultra_l1c_pset_bins.py +82 -20
  62. imap_processing/ultra/l2/ultra_l2.py +2 -2
  63. imap_processing-1.0.2.dist-info/METADATA +121 -0
  64. {imap_processing-1.0.0.dist-info → imap_processing-1.0.2.dist-info}/RECORD +67 -61
  65. imap_processing-1.0.0.dist-info/METADATA +0 -120
  66. {imap_processing-1.0.0.dist-info → imap_processing-1.0.2.dist-info}/LICENSE +0 -0
  67. {imap_processing-1.0.0.dist-info → imap_processing-1.0.2.dist-info}/WHEEL +0 -0
  68. {imap_processing-1.0.0.dist-info → imap_processing-1.0.2.dist-info}/entry_points.txt +0 -0
@@ -0,0 +1,422 @@
1
+ # ----------------------------- Useful variables -----------------------------
2
+ uint8_fillval: &uint8_fillval 255
3
+ uint32_fillval: &uint32_fillval 4294967295
4
+ real_fillval: &real_fillval -1.0e+31
5
+
6
+ min_int: &min_int -9223372036854775808
7
+ max_int: &max_int 9223372036854775807
8
+
9
+ # --------------------------- Default attributes -----------------------------
10
+ energy_attrs: &energy_default
11
+ VAR_TYPE: support_data
12
+ CATDESC: Geometric mean energy per nucleon
13
+ FIELDNAM: Energy Table
14
+ LABLAXIS: Energy
15
+ SCALETYP: log
16
+ UNITS: MeV/nuc
17
+ FORMAT: '%f'
18
+ FILLVAL: *real_fillval
19
+ VALIDMAX: 200.0
20
+ VALIDMIN: 0.05000000074505806
21
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Characteristic
22
+
23
+ # ------------------------------- Coordinates -------------------------------
24
+ epoch_delta_minus:
25
+ CATDESC: Time from acquisition start to acquisition center
26
+ FIELDNAM: epoch delta minus
27
+ FILLVAL: -9223372036854775808
28
+ FORMAT: I18
29
+ LABLAXIS: Epoch Delta Minus
30
+ SCALETYP: linear
31
+ UNITS: ns
32
+ VALIDMIN: *min_int
33
+ VALIDMAX: *max_int
34
+ VAR_TYPE: support_data
35
+ DICT_KEY: SPASE>Support>SupportQuantity:Temporal,Qualifier:Uncertainty
36
+
37
+ epoch_delta_plus:
38
+ CATDESC: Time from acquisition center to acquisition end
39
+ FIELDNAM: epoch delta plus
40
+ FILLVAL: -9223372036854775808
41
+ FORMAT: I18
42
+ LABLAXIS: Epoch Delta Plus
43
+ SCALETYP: linear
44
+ UNITS: ns
45
+ VALIDMIN: *min_int
46
+ VALIDMAX: *max_int
47
+ VAR_TYPE: support_data
48
+ DICT_KEY: SPASE>Support>SupportQuantity:Temporal,Qualifier:Uncertainty
49
+
50
+ elevation_angle:
51
+ CATDESC: Elevation Angle
52
+ FIELDNAM: Elevation Angle
53
+ FORMAT: '%f'
54
+ LABLAXIS: Elevation Angle
55
+ SCALETYP: linear
56
+ UNITS: degrees
57
+ VALIDMAX: 180.0
58
+ VALIDMIN: 0.0
59
+ VAR_TYPE: support_data
60
+
61
+ spin_sector:
62
+ CATDESC: Spin Sector Index
63
+ FIELDNAM: Spin Sector Index
64
+ FILLVAL: -1
65
+ FORMAT: I2
66
+ LABLAXIS: " "
67
+ SCALETYP: linear
68
+ UNITS: " "
69
+ VALIDMIN: 0
70
+ VALIDMAX: 12
71
+ VAR_TYPE: support_data
72
+
73
+ energy_cno:
74
+ <<: *energy_default
75
+ DELTA_MINUS_VAR: energy_cno_minus
76
+ DELTA_PLUS_VAR: energy_cno_plus
77
+
78
+ energy_fe:
79
+ <<: *energy_default
80
+ DELTA_MINUS_VAR: energy_fe_minus
81
+ DELTA_PLUS_VAR: energy_fe_plus
82
+
83
+ energy_h:
84
+ <<: *energy_default
85
+ DELTA_MINUS_VAR: energy_h_minus
86
+ DELTA_PLUS_VAR: energy_h_plus
87
+
88
+ energy_he3he4:
89
+ <<: *energy_default
90
+ DELTA_MINUS_VAR: energy_he3he4_minus
91
+ DELTA_PLUS_VAR: energy_he3he4_plus
92
+
93
+ # ------------------------------- Label vars --------------------------------
94
+ event_num_label:
95
+ CATDESC: Event Number
96
+ FIELDNAM: Event Number
97
+ FORMAT: A5
98
+ VAR_TYPE: metadata
99
+
100
+ epoch_delta_minus_label:
101
+ CATDESC: Time from acquisition start to acquisition center
102
+ FIELDNAM: Epoch delta minus
103
+ FORMAT: A18
104
+ VAR_TYPE: metadata
105
+
106
+ epoch_delta_plus_label:
107
+ CATDESC: Time from acquisition center to acquisition end
108
+ FIELDNAM: Epoch delta plus
109
+ FORMAT: A18
110
+ VAR_TYPE: metadata
111
+
112
+ elevation_angle_label:
113
+ CATDESC: Elevation Angle
114
+ FIELDNAM: Elevation Angle
115
+ FORMAT: A6
116
+ VAR_TYPE: metadata
117
+
118
+ spin_sector_label:
119
+ CATDESC: Spin Sector
120
+ DEPEND_1: spin_sector
121
+ FIELDNAM: Spin Sector
122
+ FORMAT: A2
123
+ VAR_TYPE: metadata
124
+
125
+ # ------------------------------- Labels ------------------------------------
126
+ energy_cno_label:
127
+ CATDESC: Energy CNO
128
+ FIELDNAM: Energy CNO
129
+ FORMAT: A6
130
+ VAR_TYPE: metadata
131
+
132
+ energy_fe_label:
133
+ CATDESC: Energy Fe
134
+ FIELDNAM: Energy Fe
135
+ FORMAT: A6
136
+ VAR_TYPE: metadata
137
+
138
+ energy_h_label:
139
+ CATDESC: Energy H
140
+ FIELDNAM: Energy H
141
+ FORMAT: A6
142
+ VAR_TYPE: metadata
143
+
144
+ energy_he3he4_label:
145
+ CATDESC: Energy He3He4
146
+ FIELDNAM: Energy He3He4
147
+ FORMAT: A6
148
+ VAR_TYPE: metadata
149
+
150
+ # --------------------------- Dataset variable attrs ------------------------
151
+ data_quality:
152
+ VAR_TYPE: data
153
+ DEPEND_0: epoch
154
+ CATDESC: Indicates whether data quality is suspect (1).
155
+ DISPLAY_TYPE: time_series
156
+ FIELDNAM: Data Quality
157
+ FILLVAL: *uint8_fillval
158
+ FORMAT: '%d'
159
+ LABLAXIS: Data Quality
160
+ SCALETYP: linear
161
+ UNITS: ' '
162
+ VALIDMAX: 1
163
+ VALIDMIN: 0
164
+ VAR_TYPE: support_data
165
+ DICT_KEY: SPASE>Support>SupportQuantity:DataQuality
166
+
167
+ species_dim_attrs: &species_dim_attrs
168
+ DEPEND_0: epoch
169
+ DEPEND_1: energy_cno
170
+ DEPEND_2: spin_sector
171
+ DEPEND_3: elevation_angle
172
+ LABL_PTR_1: energy_cno_label
173
+ LABL_PTR_2: spin_sector_label
174
+ LABL_PTR_3: elevation_angle_label
175
+ # species:
176
+ cno:
177
+ <<: *species_dim_attrs
178
+ VAR_TYPE: data
179
+ DISPLAY_TYPE: spectrogram
180
+ CATDESC: cno (x2 spacing)
181
+ FIELDNAM: cno
182
+ FILLVAL: *uint32_fillval
183
+ FORMAT: '%f'
184
+ SCALETYP: linear
185
+ UNITS: '# / cm2 s sr MeV/nuc'
186
+ VALIDMAX: 16777216
187
+ VALIDMIN: 0
188
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
189
+
190
+ fe:
191
+ <<: *species_dim_attrs
192
+ VAR_TYPE: data
193
+ DISPLAY_TYPE: spectrogram
194
+ CATDESC: fe (x2 spacing)
195
+ FIELDNAM: fe
196
+ FILLVAL: *uint32_fillval
197
+ FORMAT: '%f'
198
+ SCALETYP: linear
199
+ UNITS: '# / cm2 s sr MeV/nuc'
200
+ VALIDMAX: 16777216
201
+ VALIDMIN: 0
202
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
203
+
204
+ h:
205
+ <<: *species_dim_attrs
206
+ VAR_TYPE: data
207
+ DISPLAY_TYPE: spectrogram
208
+ CATDESC: h (x2 spacing)
209
+ FIELDNAM: h
210
+ FILLVAL: *uint32_fillval
211
+ FORMAT: '%f'
212
+ SCALETYP: linear
213
+ UNITS: '# / cm2 s sr MeV/nuc'
214
+ VALIDMAX: 16777216
215
+ VALIDMIN: 0
216
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
217
+
218
+ he3he4:
219
+ <<: *species_dim_attrs
220
+ VAR_TYPE: data
221
+ DISPLAY_TYPE: spectrogram
222
+ CATDESC: he3he4 (x2 spacing)
223
+ FIELDNAM: he3he4
224
+ FILLVAL: *uint32_fillval
225
+ FORMAT: '%f'
226
+ SCALETYP: linear
227
+ UNITS: '# / cm2 s sr MeV/nuc'
228
+ VALIDMAX: 16777216
229
+ VALIDMIN: 0
230
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
231
+
232
+ # uncertainties:
233
+ unc_cno:
234
+ <<: *species_dim_attrs
235
+ FIELDNAM: Uncertainties for cno
236
+ VALIDMIN: 0.0
237
+ VALIDMAX: 4096.0
238
+ UNITS: '# / cm2 s sr MeV/nuc'
239
+ FORMAT: '%f'
240
+ CATDESC: Uncertainties for cno (x2 spacing)
241
+ VAR_TYPE: data
242
+ SI_CONVERSION: ' > '
243
+ SCALETYP: linear
244
+ FILLVAL: 1.0e+31
245
+ DISPLAY_TYPE: time_series
246
+ COORDINATE_SYSTEM: instrument frame
247
+
248
+ unc_fe:
249
+ <<: *species_dim_attrs
250
+ FIELDNAM: Uncertainties for fe
251
+ VALIDMIN: 0.0
252
+ VALIDMAX: 4096.0
253
+ UNITS: '# / cm2 s sr MeV/nuc'
254
+ FORMAT: '%f'
255
+ CATDESC: Uncertainties for fe (x2 spacing)
256
+ VAR_TYPE: data
257
+ SI_CONVERSION: ' > '
258
+ SCALETYP: linear
259
+ FILLVAL: 1.0e+31
260
+ DISPLAY_TYPE: spectrogram
261
+ COORDINATE_SYSTEM: instrument frame
262
+
263
+ unc_h:
264
+ <<: *species_dim_attrs
265
+ FIELDNAM: Uncertainties for h
266
+ VALIDMIN: 0.0
267
+ VALIDMAX: 4096.0
268
+ UNITS: '# / cm2 s sr MeV/nuc'
269
+ FORMAT: '%f'
270
+ CATDESC: Uncertainties for h (x2 spacing)
271
+ VAR_TYPE: data
272
+ SI_CONVERSION: ' > '
273
+ SCALETYP: linear
274
+ FILLVAL: 1.0e+31
275
+ DISPLAY_TYPE: spectrogram
276
+ DEPEND_0: epoch
277
+ COORDINATE_SYSTEM: instrument frame
278
+
279
+ unc_he3he4:
280
+ <<: *species_dim_attrs
281
+ FIELDNAM: Uncertainties for he3he4
282
+ VALIDMIN: 0.0
283
+ VALIDMAX: 4096.0
284
+ UNITS: '# / cm2 s sr MeV/nuc'
285
+ FORMAT: '%f'
286
+ CATDESC: Uncertainties for he3he4 (x2 spacing)
287
+ VAR_TYPE: data
288
+ SI_CONVERSION: ' > '
289
+ SCALETYP: linear
290
+ FILLVAL: 1.0e+31
291
+ DISPLAY_TYPE: spectrogram
292
+ COORDINATE_SYSTEM: instrument frame
293
+
294
+ # energy deltas:
295
+ energy_cno_minus:
296
+ VAR_TYPE: support_data
297
+ CATDESC: Energy Table Minus value
298
+ FIELDNAM: energy delta minus
299
+ LABLAXIS: Energy
300
+ SCALETYP: log
301
+ UNITS: MeV/nuc
302
+ FORMAT: '%f'
303
+ FILLVAL: *real_fillval
304
+ VALIDMAX: 200.0
305
+ VALIDMIN: 0.05000000074505806
306
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
307
+ DEPEND_1: energy_cno
308
+
309
+ energy_cno_plus:
310
+ VAR_TYPE: support_data
311
+ CATDESC: Energy Table Plus value
312
+ FIELDNAM: energy delta plus
313
+ LABLAXIS: Energy
314
+ SCALETYP: log
315
+ UNITS: MeV/nuc
316
+ FORMAT: '%f'
317
+ FILLVAL: *real_fillval
318
+ VALIDMAX: 200.0
319
+ VALIDMIN: 0.05000000074505806
320
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
321
+ DEPEND_1: energy_cno
322
+
323
+ energy_fe_minus:
324
+ VAR_TYPE: support_data
325
+ CATDESC: Energy Table Minus value
326
+ FIELDNAM: energy delta minus
327
+ LABLAXIS: Energy
328
+ SCALETYP: log
329
+ UNITS: MeV/nuc
330
+ FORMAT: '%f'
331
+ FILLVAL: *real_fillval
332
+ VALIDMAX: 200.0
333
+ VALIDMIN: 0.05000000074505806
334
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
335
+ DEPEND_1: energy_fe
336
+
337
+ energy_fe_plus:
338
+ VAR_TYPE: support_data
339
+ CATDESC: Energy Table Plus value
340
+ FIELDNAM: energy delta plus
341
+ LABLAXIS: Energy
342
+ SCALETYP: log
343
+ UNITS: MeV/nuc
344
+ FORMAT: '%f'
345
+ FILLVAL: *real_fillval
346
+ VALIDMAX: 200.0
347
+ VALIDMIN: 0.05000000074505806
348
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
349
+ DEPEND_1: energy_fe
350
+
351
+ energy_h_minus:
352
+ VAR_TYPE: support_data
353
+ CATDESC: Energy Table Minus value
354
+ FIELDNAM: energy delta minus
355
+ LABLAXIS: Energy
356
+ SCALETYP: log
357
+ UNITS: MeV/nuc
358
+ FORMAT: '%f'
359
+ FILLVAL: *real_fillval
360
+ VALIDMAX: 200.0
361
+ VALIDMIN: 0.05000000074505806
362
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
363
+ DEPEND_1: energy_h
364
+
365
+ energy_h_plus:
366
+ VAR_TYPE: support_data
367
+ CATDESC: Energy Table Plus value
368
+ FIELDNAM: energy delta plus
369
+ LABLAXIS: Energy
370
+ SCALETYP: log
371
+ UNITS: MeV/nuc
372
+ FORMAT: '%f'
373
+ FILLVAL: *real_fillval
374
+ VALIDMAX: 200.0
375
+ VALIDMIN: 0.05000000074505806
376
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
377
+ DEPEND_1: energy_h
378
+
379
+ energy_he3he4_minus:
380
+ VAR_TYPE: support_data
381
+ CATDESC: Energy Table Minus value
382
+ FIELDNAM: energy delta minus
383
+ LABLAXIS: Energy
384
+ SCALETYP: log
385
+ UNITS: MeV/nuc
386
+ FORMAT: '%f'
387
+ FILLVAL: *real_fillval
388
+ VALIDMAX: 200.0
389
+ VALIDMIN: 0.05000000074505806
390
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
391
+ DEPEND_1: energy_he3he4
392
+
393
+ energy_he3he4_plus:
394
+ VAR_TYPE: support_data
395
+ CATDESC: Energy Table Plus value
396
+ FIELDNAM: energy delta plus
397
+ LABLAXIS: Energy
398
+ SCALETYP: log
399
+ UNITS: MeV/nuc
400
+ FORMAT: '%f'
401
+ FILLVAL: *real_fillval
402
+ VALIDMAX: 200.0
403
+ VALIDMIN: 0.05000000074505806
404
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Uncertainty
405
+ DEPEND_1: energy_he3he4
406
+
407
+ # spin angles:
408
+ spin_angles:
409
+ VAR_TYPE: support_data
410
+ CATDESC: Spin Angle
411
+ FIELDNAM: Spin Angle
412
+ SCALETYP: linear
413
+ UNITS: degrees
414
+ FILLVAL: *real_fillval
415
+ VALIDMAX: 360.0
416
+ VALIDMIN: 0.0
417
+ FORMAT: '%f'
418
+ DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:ArrivalDirection,Qualifier:DirectionAngle.AzimuthAngle
419
+ DEPEND_1: spin_sector
420
+ DEPEND_2: elevation_angle
421
+ LABL_PTR_1: spin_sector_label
422
+ LABL_PTR_2: elevation_angle_label
@@ -41,7 +41,7 @@ energy:
41
41
  LABLAXIS: Energy bin geometric mean
42
42
  UNITS: KeV
43
43
  VAR_TYPE: support_data
44
- SCALE_TYP: linear
44
+ SCALETYP: linear
45
45
  # We might not have these set up yet
46
46
  DELTA_MINUS_VAR: energy_delta_minus
47
47
  DELTA_PLUS_VAR: energy_delta_plus
@@ -49,8 +49,8 @@ energy:
49
49
 
50
50
  energy_label:
51
51
  VAR_TYPE: metadata
52
- CATDESC: Geometric mean of energy bin.
53
- FIELDNAM: energy_bin_geometric_mean
52
+ CATDESC: Label variable for energy coordinate
53
+ FIELDNAM: energy label
54
54
  FORMAT: A16
55
55
  DEPEND_1: energy
56
56
 
@@ -60,7 +60,7 @@ energy_delta_minus:
60
60
  CATDESC: Difference between the energy bin center and lower edge.
61
61
  LABLAXIS: energy
62
62
  UNITS: KeV
63
- FIELDNAM: energy_bin_delta_minus
63
+ FIELDNAM: energy delta minus
64
64
  DISPLAY_TYPE: no_plot
65
65
  DEPEND_1: energy
66
66
  LABL_PTR_1: energy_label
@@ -72,16 +72,22 @@ energy_delta_plus:
72
72
  CATDESC: Difference between the energy bin center and upper edge.
73
73
  LABLAXIS: energy
74
74
  UNITS: KeV
75
- FIELDNAM: energy_bin_delta_plus
75
+ FIELDNAM: energy delta plus
76
76
  DISPLAY_TYPE: no_plot
77
77
  DEPEND_1: energy
78
78
  LABL_PTR_1: energy_label
79
79
  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:Energy,Qualifier:Uncertainty
80
80
 
81
+ epoch:
82
+ CATDESC: Map time range start, number of nanoseconds since J2000 with leap seconds included
83
+ FIELDNAM: J2000 Nanoseconds
84
+ DELTA_PLUS_VAR: epoch_delta
85
+ BIN_LOCATION: 0
86
+
81
87
  epoch_delta:
82
88
  <<: *default_int64
83
89
  CATDESC: Number of nanoseconds covered by data included in this map product.
84
- FIELDNAM: epoch_delta
90
+ FIELDNAM: epoch delta
85
91
  UNITS: ns
86
92
  VAR_TYPE: support_data
87
93
  DISPLAY_TYPE: no_plot
@@ -93,10 +99,9 @@ epoch_delta:
93
99
  # in the tiling-specific YAML files.
94
100
  longitude:
95
101
  <<: *default_float32
96
- CATDESC: "Pixel center longitude in {frame} reference frame in the range [0, 360]."
97
102
  FIELDNAM: "{frame} Longitude"
98
103
  LABLAXIS: "{frame} Longitude"
99
- UNITS: degrees
104
+ UNITS: deg
100
105
  VAR_TYPE: support_data
101
106
  VALIDMIN: 0
102
107
  VALIDMAX: 360
@@ -104,10 +109,9 @@ longitude:
104
109
 
105
110
  latitude:
106
111
  <<: *default_float32
107
- CATDESC: "Pixel center latitude in {frame} reference frame in the range [-90, 90]."
108
112
  FIELDNAM: "{frame} Latitude"
109
113
  LABLAXIS: "{frame} Latitude"
110
- UNITS: degrees
114
+ UNITS: deg
111
115
  VAR_TYPE: support_data
112
116
  VALIDMIN: -90
113
117
  VALIDMAX: 90
@@ -120,7 +124,7 @@ ena_intensity:
120
124
  <<: *default_float32
121
125
  CATDESC: Mono-energetic ENA intensity.
122
126
  FIELDNAM: Intensity
123
- UNITS: counts/(s * cm^2 * Sr * KeV)
127
+ UNITS: cm -2 s -1 sr -1 keV -1
124
128
  DELTA_MINUS_VAR: ena_intensity_stat_uncert
125
129
  DELTA_PLUS_VAR: ena_intensity_stat_uncert
126
130
  DEPEND_0: epoch
@@ -133,7 +137,7 @@ ena_intensity_stat_uncert:
133
137
  <<: *default_float32
134
138
  CATDESC: ENA intensity statistical uncertainty.
135
139
  FIELDNAM: Intensity stat unc
136
- UNITS: counts/(s * cm^2 * Sr * KeV)
140
+ UNITS: cm -2 s -1 sr -1 keV -1
137
141
  DEPEND_0: epoch
138
142
  VAR_TYPE: support_data
139
143
  LABLAXIS: Statistical Unc
@@ -144,10 +148,10 @@ ena_intensity_sys_err:
144
148
  <<: *default_float32
145
149
  CATDESC: ENA intensity non-statistical error.
146
150
  FIELDNAM: Intensity non-stat error
147
- UNITS: counts/(s * cm^2 * Sr * KeV)
151
+ UNITS: cm -2 s -1 sr -1 keV -1
148
152
  DEPEND_0: epoch
149
153
  VAR_TYPE: support_data
150
- LABLAXIS: Non-Statistical Err
154
+ LABLAXIS: Non-statistical Error
151
155
  DISPLAY_TYPE: map_image
152
156
  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
153
157
 
@@ -164,13 +168,14 @@ ena_rate:
164
168
 
165
169
  bg_rate:
166
170
  <<: *default_float32
167
- CATDESC: Estimated background count rate.
171
+ CATDESC: Total background count rate from non-ENA (non-heliospheric) sources, as calculated by ground processing; makes sense only for "uncombined" calibration products.
168
172
  FIELDNAM: Background Rate
169
- UNITS: counts/s
173
+ UNITS: count s-1
170
174
  DEPEND_0: epoch
171
175
  VAR_TYPE: data
172
176
  LABLAXIS: Rate
173
177
  DISPLAY_TYPE: map_image
178
+ FORMAT: F6.3
174
179
  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
175
180
 
176
181
  ena_count:
@@ -186,7 +191,7 @@ ena_count:
186
191
 
187
192
  sensitivity:
188
193
  <<: *default_float32
189
- CATDESC: Averaged instrument sensitive area.
194
+ CATDESC: Averaged instrument sensitive area
190
195
  FIELDNAM: Sensitivity
191
196
  UNITS: cm^2
192
197
  VAR_TYPE: support_data
@@ -203,13 +208,15 @@ exposure_factor: &exposure_factor
203
208
  VAR_TYPE: data
204
209
  LABLAXIS: Exposure
205
210
  DISPLAY_TYPE: no_plot
211
+ FORMAT: F5.2
212
+ VAR_NOTES: Exact or approximate exposure time over which counts in a pixel are accumulated. Used as a weighting factor for combining data quantities sensibly.
206
213
  DICT_KEY: SPASE>Support>SupportQuantity:Temporal
207
214
 
208
215
  geometric_function:
209
216
  <<: *default_float32
210
217
  CATDESC: Averaged aperture area as seen by the backstop.
211
218
  FIELDNAM: Geometric Function
212
- UNITS: cm^2 sr
219
+ UNITS: cm^2
213
220
  VAR_TYPE: support_data
214
221
  LABLAXIS: Geometric Function
215
222
  DISPLAY_TYPE: no_plot
@@ -217,7 +224,7 @@ geometric_function:
217
224
 
218
225
  efficiency:
219
226
  <<: *default_float32
220
- CATDESC: Efficiency of the instrument in converting ENAs to valid events.
227
+ CATDESC: Efficiency of the instrument in converting ENAs to valid events
221
228
  FIELDNAM: Efficiency
222
229
  UNITS: " "
223
230
  VAR_TYPE: support_data
@@ -227,7 +234,7 @@ efficiency:
227
234
 
228
235
  positional_uncert_theta:
229
236
  <<: *default_float32
230
- CATDESC: Averaged position uncertainty along the theta dimension of the instrument.
237
+ CATDESC: Averaged position uncertainty along the theta dimension of the instrument
231
238
  FIELDNAM: Positional Uncertainty Theta
232
239
  UNITS: degrees
233
240
  VAR_TYPE: support_data
@@ -237,7 +244,7 @@ positional_uncert_theta:
237
244
 
238
245
  positional_uncert_phi:
239
246
  <<: *default_float32
240
- CATDESC: Averaged position uncertainty along the phi dimension of the instrument.
247
+ CATDESC: Averaged position uncertainty along the phi dimension of the instrument
241
248
  FIELDNAM: Positional Uncertainty Phi
242
249
  UNITS: degrees
243
250
  VAR_TYPE: support_data
@@ -248,7 +255,7 @@ positional_uncert_phi:
248
255
  obs_date: &obs_date
249
256
  <<: *default_int64
250
257
  datatype: int64
251
- CATDESC: Exposure time weighted mean collection date of data in a pixel.
258
+ CATDESC: Mean collection date of data in a pixel
252
259
  FIELDNAM: J2000 Nanoseconds
253
260
  UNITS: ns
254
261
  DEPEND_0: epoch
@@ -39,10 +39,12 @@ pixel_index_label:
39
39
  # (longitude, latitude are not dimension coordinates for healpix tiling, but rather
40
40
  # describe the lon/lat coordinate of the Healpix pixel center)
41
41
  longitude:
42
+ CATDESC: "HEALPix Pixel center longitude in {frame} reference frame in the range [0, 360]"
42
43
  DEPEND_1: pixel_index
43
44
  LABL_PTR_1: pixel_index_label
44
45
 
45
46
  latitude:
47
+ CATDESC: "HEALPix Pixel center latitude in {frame} reference frame in the range [-90, 90]"
46
48
  DEPEND_1: pixel_index
47
49
  LABL_PTR_1: pixel_index_label
48
50
 
@@ -49,14 +49,24 @@ latitude_delta:
49
49
  # attributes file, imap_enamaps_l2-common_variable_attrs.yaml
50
50
 
51
51
  longitude:
52
+ CATDESC: "Pixel center longitude in {frame} reference frame in the range [0, 360]"
52
53
  DELTA_MINUS_VAR: longitude_delta
53
54
  DELTA_PLUS_VAR: longitude_delta
54
- SCALE_TYP: linear
55
+ SCALETYP: linear
56
+ LABL_PTR_1: longitude_label
57
+ MONOTON: INCREASE
58
+ FORMAT: I3
59
+
55
60
 
56
61
  latitude:
62
+ CATDESC: "Pixel center latitude in {frame} reference frame in the range [-90, 90]"
57
63
  DELTA_MINUS_VAR: latitude_delta
58
64
  DELTA_PLUS_VAR: latitude_delta
59
- SCALE_TYP: linear
65
+ SCALETYP: linear
66
+ LABL_PTR_1: latitude_label
67
+ MONOTON: INCREASE
68
+ BIN_LOCATION: 0.5
69
+ FORMAT: I2
60
70
 
61
71
  # Define Data variables
62
72
  ena_intensity:
@@ -129,22 +129,11 @@ metadata_default: &metadata_default
129
129
  DICT_KEY: SPASE>Support>SupportQuantity:Other
130
130
 
131
131
  sci_start_time:
132
- CATDESC: Start time of sweep
132
+ CATDESC: Start time of sweep in UTC
133
133
  DEPEND_0: epoch
134
134
  FIELDNAM: Science Start time
135
- LABLAXIS: sci_start_time
136
- FILLVAL: -9223372036854775808
137
- FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
138
- VALIDMIN: -9223372036854775808
139
- VALIDMAX: 9223372036854775807
140
- UNITS: ns
135
+ FORMAT: " "
141
136
  VAR_TYPE: support_data
142
- SCALETYP: linear
143
- MONOTON: INCREASE
144
- TIME_BASE: J2000
145
- TIME_SCALE: Terrestrial Time
146
- REFERENCE_POSITION: Rotating Earth Geoid
147
- RESOLUTION: ' '
148
137
  DICT_KEY: "SPASE>Support>SupportQantity:Temporal"
149
138
 
150
139
  # Minimum attrs setting for HK data
@@ -29,7 +29,7 @@ def load_cdf(
29
29
 
30
30
  Parameters
31
31
  ----------
32
- file_path : Path or ImapFilePath or str
32
+ file_path : pathlib.Path or ImapFilePath or str
33
33
  The path to the CDF file or ImapFilePath object.
34
34
  remove_xarray_attrs : bool
35
35
  Whether to remove the xarray attributes that get injected by the
@@ -98,7 +98,7 @@ def write_cdf(
98
98
 
99
99
  Returns
100
100
  -------
101
- file_path : Path
101
+ file_path : pathlib.Path
102
102
  Path to the file created.
103
103
  """
104
104
  # Create the filename from the global attributes