Skip to content

Commit cc5f479

Browse files
authored
codice metadata updates (#3310)
1 parent 4c9c110 commit cc5f479

7 files changed

Lines changed: 48 additions & 32 deletions

imap_processing/cdf/config/imap_codice_l2-hi-direct-events_variable_attrs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ num_events:
7474
DEPEND_0: epoch
7575
DEPEND_1: priority
7676
DICT_KEY: SPASE>Support>SupportQuantity:Other
77-
DISPLAY_TYPE: time_series
77+
DISPLAY_TYPE: spectrogram
7878
FIELDNAM: Number of Events
7979
FILLVAL: *uint16_fillval
8080
FORMAT: I5

imap_processing/cdf/config/imap_codice_l2-hi-omni_variable_attrs.yaml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ unc_c:
365365
COORDINATE_SYSTEM: instrument frame
366366
DEPEND_0: epoch
367367
DEPEND_1: energy_c
368-
DISPLAY_TYPE: time_series
368+
DISPLAY_TYPE: spectrogram
369369
FIELDNAM: Uncertainty - C
370370
FILLVAL: *real_fillval
371371
FORMAT: F32.1
@@ -382,7 +382,7 @@ unc_fe:
382382
COORDINATE_SYSTEM: instrument frame
383383
DEPEND_0: epoch
384384
DEPEND_1: energy_fe
385-
DISPLAY_TYPE: time_series
385+
DISPLAY_TYPE: spectrogram
386386
FIELDNAM: Uncertainty - Fe
387387
FILLVAL: *real_fillval
388388
FORMAT: F32.1
@@ -399,7 +399,7 @@ unc_h:
399399
COORDINATE_SYSTEM: instrument frame
400400
DEPEND_0: epoch
401401
DEPEND_1: energy_h
402-
DISPLAY_TYPE: time_series
402+
DISPLAY_TYPE: spectrogram
403403
FIELDNAM: Uncertainty - H
404404
FILLVAL: *real_fillval
405405
FORMAT: F32.1
@@ -416,7 +416,7 @@ unc_he3:
416416
COORDINATE_SYSTEM: instrument frame
417417
DEPEND_0: epoch
418418
DEPEND_1: energy_he3
419-
DISPLAY_TYPE: time_series
419+
DISPLAY_TYPE: spectrogram
420420
FIELDNAM: Uncertainty - He3
421421
FILLVAL: *real_fillval
422422
FORMAT: F32.1
@@ -433,7 +433,7 @@ unc_he4:
433433
COORDINATE_SYSTEM: instrument frame
434434
DEPEND_0: epoch
435435
DEPEND_1: energy_he4
436-
DISPLAY_TYPE: time_series
436+
DISPLAY_TYPE: spectrogram
437437
FIELDNAM: Uncertainty - He4
438438
FILLVAL: *real_fillval
439439
FORMAT: F32.1
@@ -450,7 +450,7 @@ unc_junk:
450450
COORDINATE_SYSTEM: instrument frame
451451
DEPEND_0: epoch
452452
DEPEND_1: energy_junk
453-
DISPLAY_TYPE: time_series
453+
DISPLAY_TYPE: spectrogram
454454
FIELDNAM: Uncertainty - Junk
455455
FILLVAL: *real_fillval
456456
FORMAT: F32.1
@@ -470,7 +470,7 @@ unc_ne_mg_si:
470470
COORDINATE_SYSTEM: instrument frame
471471
DEPEND_0: epoch
472472
DEPEND_1: energy_ne_mg_si
473-
DISPLAY_TYPE: time_series
473+
DISPLAY_TYPE: spectrogram
474474
FIELDNAM: Uncertainty - Ne+Mg+Si
475475
FILLVAL: *real_fillval
476476
FORMAT: F32.1
@@ -487,7 +487,7 @@ unc_o:
487487
COORDINATE_SYSTEM: instrument frame
488488
DEPEND_0: epoch
489489
DEPEND_1: energy_o
490-
DISPLAY_TYPE: time_series
490+
DISPLAY_TYPE: spectrogram
491491
FIELDNAM: Uncertainty - O
492492
FILLVAL: *real_fillval
493493
FORMAT: F32.1
@@ -504,7 +504,7 @@ unc_uh:
504504
COORDINATE_SYSTEM: instrument frame
505505
DEPEND_0: epoch
506506
DEPEND_1: energy_uh
507-
DISPLAY_TYPE: time_series
507+
DISPLAY_TYPE: spectrogram
508508
FIELDNAM: Uncertainty - Ultra-Heavy
509509
FILLVAL: *real_fillval
510510
FORMAT: F32.1
@@ -522,7 +522,7 @@ c:
522522
DEPEND_0: epoch
523523
DEPEND_1: energy_c
524524
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
525-
DISPLAY_TYPE: time_series
525+
DISPLAY_TYPE: spectrogram
526526
FIELDNAM: Differential Intensity - C
527527
FILLVAL: *real_fillval
528528
FORMAT: F32.1
@@ -540,7 +540,7 @@ fe:
540540
DEPEND_0: epoch
541541
DEPEND_1: energy_fe
542542
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
543-
DISPLAY_TYPE: time_series
543+
DISPLAY_TYPE: spectrogram
544544
FIELDNAM: Differential Intensity - Fe
545545
FILLVAL: *real_fillval
546546
FORMAT: F32.1
@@ -558,7 +558,7 @@ h:
558558
DEPEND_0: epoch
559559
DEPEND_1: energy_h
560560
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
561-
DISPLAY_TYPE: time_series
561+
DISPLAY_TYPE: spectrogram
562562
FIELDNAM: Differential Intensity - H
563563
FILLVAL: *real_fillval
564564
FORMAT: F32.1
@@ -576,7 +576,7 @@ he3:
576576
DEPEND_0: epoch
577577
DEPEND_1: energy_he3
578578
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
579-
DISPLAY_TYPE: time_series
579+
DISPLAY_TYPE: spectrogram
580580
FIELDNAM: Differential Intensity - He3
581581
FILLVAL: *real_fillval
582582
FORMAT: F32.1
@@ -594,7 +594,7 @@ he4:
594594
DEPEND_0: epoch
595595
DEPEND_1: energy_he4
596596
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
597-
DISPLAY_TYPE: time_series
597+
DISPLAY_TYPE: spectrogram
598598
FIELDNAM: Differential Intensity - He4
599599
FILLVAL: *real_fillval
600600
FORMAT: F32.1
@@ -612,7 +612,7 @@ junk:
612612
DEPEND_0: epoch
613613
DEPEND_1: energy_junk
614614
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
615-
DISPLAY_TYPE: time_series
615+
DISPLAY_TYPE: spectrogram
616616
FIELDNAM: Differential Intensity - Junk
617617
FILLVAL: *real_fillval
618618
FORMAT: F32.1
@@ -633,7 +633,7 @@ ne_mg_si:
633633
DEPEND_0: epoch
634634
DEPEND_1: energy_ne_mg_si
635635
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
636-
DISPLAY_TYPE: time_series
636+
DISPLAY_TYPE: spectrogram
637637
FIELDNAM: Differential Intensity - Ne+Mg+Si
638638
FILLVAL: *real_fillval
639639
FORMAT: F32.1
@@ -651,7 +651,7 @@ o:
651651
DEPEND_0: epoch
652652
DEPEND_1: energy_o
653653
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
654-
DISPLAY_TYPE: time_series
654+
DISPLAY_TYPE: spectrogram
655655
FIELDNAM: Differential Intensity - O
656656
FILLVAL: *real_fillval
657657
FORMAT: F32.1
@@ -669,7 +669,7 @@ uh:
669669
DEPEND_0: epoch
670670
DEPEND_1: energy_uh
671671
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
672-
DISPLAY_TYPE: time_series
672+
DISPLAY_TYPE: spectrogram
673673
FIELDNAM: Differential Intensity - Ultra-Heavy
674674
FILLVAL: *real_fillval
675675
FORMAT: F32.1

imap_processing/cdf/config/imap_codice_l2-hi-sectored_variable_attrs.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ species_dim_attrs: &species_dim_attrs
193193
cno:
194194
<<: *species_dim_attrs
195195
CATDESC: Differential intensity for CNO by energy, spin sector, and elevation at x2-spaced energy-per-nucleon channels
196+
DELTA_MINUS_VAR: unc_cno
197+
DELTA_PLUS_VAR: unc_cno
196198
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
197199
DISPLAY_TYPE: spectrogram
198200
FIELDNAM: Differential Intensity - CNO
@@ -207,6 +209,8 @@ cno:
207209
fe:
208210
<<: *species_dim_attrs
209211
CATDESC: Differential intensity for Fe by energy, spin sector, and elevation at x2-spaced energy-per-nucleon channels
212+
DELTA_MINUS_VAR: unc_fe
213+
DELTA_PLUS_VAR: unc_fe
210214
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
211215
DISPLAY_TYPE: spectrogram
212216
FIELDNAM: Differential Intensity - Fe
@@ -221,6 +225,8 @@ fe:
221225
h:
222226
<<: *species_dim_attrs
223227
CATDESC: Differential intensity for H by energy, spin sector, and elevation at x2-spaced energy-per-nucleon channels
228+
DELTA_MINUS_VAR: unc_h
229+
DELTA_PLUS_VAR: unc_h
224230
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
225231
DISPLAY_TYPE: spectrogram
226232
FIELDNAM: Differential Intensity - H
@@ -235,6 +241,8 @@ h:
235241
he3he4:
236242
<<: *species_dim_attrs
237243
CATDESC: Differential intensity for He3+He4 by energy, spin sector, and elevation at x2-spaced energy-per-nucleon channels
244+
DELTA_MINUS_VAR: unc_he3he4
245+
DELTA_PLUS_VAR: unc_he3he4
238246
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
239247
DISPLAY_TYPE: spectrogram
240248
FIELDNAM: Differential Intensity - He3+He4
@@ -260,7 +268,7 @@ unc_cno:
260268
UNITS: '# / cm2 s sr MeV/nuc'
261269
VALIDMAX: 4096.0
262270
VALIDMIN: 0.0
263-
VAR_TYPE: data
271+
VAR_TYPE: support_data
264272

265273
unc_fe:
266274
<<: *species_dim_attrs
@@ -275,7 +283,7 @@ unc_fe:
275283
UNITS: '# / cm2 s sr MeV/nuc'
276284
VALIDMAX: 4096.0
277285
VALIDMIN: 0.0
278-
VAR_TYPE: data
286+
VAR_TYPE: support_data
279287

280288
unc_h:
281289
<<: *species_dim_attrs
@@ -291,7 +299,7 @@ unc_h:
291299
UNITS: '# / cm2 s sr MeV/nuc'
292300
VALIDMAX: 4096.0
293301
VALIDMIN: 0.0
294-
VAR_TYPE: data
302+
VAR_TYPE: support_data
295303

296304
unc_he3he4:
297305
<<: *species_dim_attrs
@@ -306,7 +314,7 @@ unc_he3he4:
306314
UNITS: '# / cm2 s sr MeV/nuc'
307315
VALIDMAX: 4096.0
308316
VALIDMIN: 0.0
309-
VAR_TYPE: data
317+
VAR_TYPE: support_data
310318

311319
# energy deltas:
312320
energy_cno_minus:

imap_processing/cdf/config/imap_codice_l2-lo-angular_variable_attrs.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@ elevation_angle_label:
5252
# lo-angular attribute templates (combined versions of the previous entries)
5353
lo-angular-attrs:
5454
CATDESC: "{species} {direction} species"
55+
DELTA_MINUS_VAR: unc_{species}
56+
DELTA_PLUS_VAR: unc_{species}
5557
DEPEND_0: epoch
5658
DEPEND_1: esa_step
5759
DEPEND_2: spin_sector
5860
DEPEND_3: elevation_angle
5961
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
60-
DISPLAY_TYPE: time_series
62+
DISPLAY_TYPE: spectrogram
6163
FIELDNAM: "{direction} - {species}"
6264
FILLVAL: *real_fillval
6365
FORMAT: F13.4
@@ -76,7 +78,7 @@ lo-angular-unc-attrs:
7678
DEPEND_2: spin_sector
7779
DEPEND_3: elevation_angle
7880
DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Uncertainty
79-
DISPLAY_TYPE: time_series
81+
DISPLAY_TYPE: spectrogram
8082
FIELDNAM: "{direction} - {species}"
8183
FILLVAL: *real_fillval
8284
FORMAT: F13.4
@@ -86,4 +88,4 @@ lo-angular-unc-attrs:
8688
UNITS: "#/(cm^2-s-sr-keV/q)"
8789
VALIDMAX: 16777216.0
8890
VALIDMIN: 0.0
89-
VAR_TYPE: data
91+
VAR_TYPE: support_data

imap_processing/cdf/config/imap_codice_l2-lo-direct-events_variable_attrs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ num_events:
7373
DEPEND_0: epoch
7474
DEPEND_1: priority
7575
DICT_KEY: SPASE>Support>SupportQuantity:Other
76-
DISPLAY_TYPE: time_series
76+
DISPLAY_TYPE: spectrogram
7777
FIELDNAM: Number of Events
7878
FILLVAL: *uint16_fillval
7979
FORMAT: I5

imap_processing/cdf/config/imap_codice_l2-lo-species_variable_attrs.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ data_quality:
6363
# lo species attrs
6464
lo-species-attrs:
6565
CATDESC: "{species} Non-sunward Species"
66+
DELTA_MINUS_VAR: unc_{species}
67+
DELTA_PLUS_VAR: unc_{species}
6668
DEPEND_0: epoch
6769
DEPEND_1: esa_step
6870
DEPEND_2: spin_sector
@@ -81,6 +83,8 @@ lo-species-attrs:
8183

8284
lo-pui-species-attrs:
8385
CATDESC: "{species} Pickup Ion Sunward Species"
86+
DELTA_MINUS_VAR: unc_{species}
87+
DELTA_PLUS_VAR: unc_{species}
8488
DEPEND_0: epoch
8589
DEPEND_1: esa_step
8690
DEPEND_2: spin_sector
@@ -99,6 +103,8 @@ lo-pui-species-attrs:
99103

100104
lo-sw-species-attrs:
101105
CATDESC: "Differential intensity from sunward-looking detectors measuring solar-wind {species_display}"
106+
DELTA_MINUS_VAR: unc_{species}
107+
DELTA_PLUS_VAR: unc_{species}
102108
DEPEND_0: epoch
103109
DEPEND_1: esa_step
104110
DEPEND_2: spin_sector
@@ -131,7 +137,7 @@ lo-species-unc-attrs:
131137
UNITS: "#/(cm^2-s-sr-keV/q)"
132138
VALIDMAX: *species_valid_max
133139
VALIDMIN: 0.0
134-
VAR_TYPE: data
140+
VAR_TYPE: support_data
135141

136142
lo-pui-species-unc-attrs:
137143
CATDESC: "{species} Pickup Ion Sunward Species uncertainty"
@@ -149,7 +155,7 @@ lo-pui-species-unc-attrs:
149155
UNITS: "#/(cm^2-s-sr-keV/q)"
150156
VALIDMAX: *species_valid_max
151157
VALIDMIN: 0.0
152-
VAR_TYPE: data
158+
VAR_TYPE: support_data
153159

154160
lo-sw-species-unc-attrs:
155161
CATDESC: "Uncertainty in differential intensity from sunward-looking detectors measuring solar-wind {species_display}"
@@ -167,4 +173,4 @@ lo-sw-species-unc-attrs:
167173
UNITS: "#/(cm^2-s-sr-keV/q)"
168174
VALIDMAX: *species_valid_max
169175
VALIDMIN: 0.0
170-
VAR_TYPE: data
176+
VAR_TYPE: support_data

imap_processing/tests/codice/test_codice_l2.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def assert_l2_epoch_delta_cdf_metadata(cdf_file):
7979

8080
DIRECT_EVENT_DISPLAY_TYPES = {
8181
"lo-direct-events": {
82-
"num_events": "time_series",
82+
"num_events": "spectrogram",
8383
"data_quality": "no_plot",
8484
"gain": "no_plot",
8585
"multi_flag": "no_plot",
@@ -94,7 +94,7 @@ def assert_l2_epoch_delta_cdf_metadata(cdf_file):
9494
"position": "no_plot",
9595
},
9696
"hi-direct-events": {
97-
"num_events": "time_series",
97+
"num_events": "spectrogram",
9898
"data_quality": "no_plot",
9999
"gain": "no_plot",
100100
"multi_flag": "no_plot",

0 commit comments

Comments
 (0)