imap-processing 0.18.0__py3-none-any.whl → 0.19.2__py3-none-any.whl

imap_processing/cdf/config/imap_constant_attrs.yaml

@@ -2,14 +2,15 @@
 # center of accumulation/measurement period. But if, for some good reason,
 # time corresponds to the beginning or end or any other part of
 # accumulation/measurement period, that has to be stated in CATDESC.
+
 epoch:
   CATDESC: Time, number of nanoseconds since J2000 with leap seconds included
   FIELDNAM: epoch
   LABLAXIS: epoch
   FILLVAL: -9223372036854775808
   FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
+  VALIDMIN: 315576066184000000   # 2010-01-01T00:00:00 mission start (APL 0 epoch)
+  VALIDMAX: 3155716869184000000  # 2100-01-01T00:00:00 mission end
   UNITS: ns
   VAR_TYPE: support_data
   SCALETYP: linear
@@ -20,6 +21,7 @@ epoch:
   RESOLUTION: ' '
   DICT_KEY: "SPASE>Support>SupportQantity:Temporal"
 
+
 # <=== Data Variables ===>
 # Default Attrs for all metadata variables unless overridden
 metadata_attrs:

imap_processing/cdf/config/imap_enamaps_l2-common_variable_attrs.yaml

@@ -163,6 +163,17 @@ ena_rate:
   DISPLAY_TYPE: image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
+background_rates:
+  <<: *default_float32
+  CATDESC: Estimated background count rate.
+  FIELDNAM: Background Rate
+  UNITS: counts/s
+  DEPEND_0: epoch
+  VAR_TYPE: data
+  LABLAXIS: Rate
+  DISPLAY_TYPE: image
+  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
+
 ena_count:
   <<: *default_float32
   CATDESC: Mono-energetic ENA Count.

imap_processing/cdf/config/imap_glows_l1b_variable_attrs.yaml

@@ -203,9 +203,11 @@ number_of_spins_per_block:
   VALIDMIN: 1
 
 unique_block_identifier:
-  <<: *support_data_defaults
   CATDESC: YYYY-MM-DDThh:mm:ss based on IMAP UTC time
   FIELDNAM: YYYY-MM-DDThh:mm:ss based on IMAP UTC time
+  FORMAT: A19
+  VAR_TYPE: support_data
+  DEPEND_0: epoch
 
 number_of_bins_per_histogram:
   <<: *support_data_defaults
@@ -229,6 +231,18 @@ ecliptic_attrs:
   VAR_TYPE: support_data
   FORMAT: I1
 
+latitudinal_attrs:
+  <<: *default_attrs
+  VALIDMIN: 0
+  VALIDMAX: 360
+  CATDESC: Component index for cartesian latitudinal coordinates
+  FIELDNAM: Component index
+  LABLAXIS: Index
+  UNITS: ' '
+  FILLVAL: 999
+  VAR_TYPE: support_data
+  FORMAT: I3
+
 number_of_events:
   <<: *support_data_defaults
   CATDESC: Total number of events/counts in histogram

imap_processing/cdf/config/imap_hi_global_cdf_attrs.yaml

@@ -39,6 +39,11 @@ imap_hi_l1a_hk_attrs:
     Logical_source: imap_hi_l1a_{sensor}-hk
     Logical_source_description: IMAP-Hi Instrument Level-1A Housekeeping Data.
 
+imap_hi_l1a_memdmp_attrs:
+    Data_type: L1A_HK>Level-1A Memory Dump
+    Logical_source: imap_hi_l1a_{sensor}-memdmp
+    Logical_source_description: IMAP-Hi Instrument Level-1A Memory Dump Data.
+
 imap_hi_l1b_hk_attrs:
     Data_type: L1B_HK>Level-1B Housekeeping
     Logical_source: imap_hi_l1b_{sensor}-hk

imap_processing/cdf/config/imap_hit_global_cdf_attrs.yaml

@@ -17,11 +17,17 @@ imap_hit_l1a_hk:
     Logical_source: imap_hit_l1a_hk
     Logical_source_description: IMAP Mission HIT Instrument Level-1A Housekeeping Data.
 
-imap_hit_l1a_counts:
+imap_hit_l1a_counts-standard:
     <<: *instrument_base
-    Data_type: L1A_counts>Level-1A Counts
-    Logical_source: imap_hit_l1a_counts
-    Logical_source_description: IMAP Mission HIT Instrument Level-1A Count Rates Data.
+    Data_type: L1A_counts>Level-1A Standard Counts
+    Logical_source: imap_hit_l1a_counts-standard
+    Logical_source_description: IMAP Mission HIT Instrument Level-1A Standard Count Rates Data.
+
+imap_hit_l1a_counts-sectored:
+    <<: *instrument_base
+    Data_type: L1A_counts>Level-1A Sectored Counts
+    Logical_source: imap_hit_l1a_counts-sectored
+    Logical_source_description: IMAP Mission HIT Instrument Level-1A Sectored Count Rates Data.
 
 imap_hit_l1a_direct-events:
     <<: *instrument_base

imap_processing/cdf/config/imap_idex_l2a_variable_attrs.yaml

@@ -28,7 +28,7 @@ impact_charge_base: &impact_charge_base
   DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Current>Qualifier:Derived # TODO quantity should be charge but there is no SPASE charge
 
 mass_estimate_base: &mass_estimate_base
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: *int_maxval
   VAR_TYPE: data
@@ -38,6 +38,17 @@ mass_estimate_base: &mass_estimate_base
   FILLVAL: *double_fillval
   DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Mass>Qualifier:Derived
 
+velocity_estimate_base: &velocity_estimate_base
+  UNITS: km/s
+  VALIDMIN: 0.0
+  VALIDMAX: *int_maxval
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FORMAT: F20.4
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Velocity>Qualifier:Derived
+
 chi_square_base: &chi_square_base
   UNITS: " "
   VALIDMIN: 0.0
@@ -116,7 +127,7 @@ target_fit_parameter_index:
 mass_index:
   CATDESC: Mass index values from 1 to 500
   FIELDNAM: Mass Index
-  UNITS: amu
+  UNITS: Kg
   FORMAT: I4
   VAR_TYPE: support_data
   SCALETYP: linear
@@ -146,7 +157,7 @@ tof_snr:
 tof_peak_kappa:
   CATDESC: TOF High spectrum with x-axis converted from time to mass.
   FIELDNAM: Mass Scale
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: 1.0
   VAR_TYPE: data
@@ -208,7 +219,7 @@ tof_peak_reduced_chi_squared:
 mass_scale:
   CATDESC: TOF High spectrum with x-axis converted from time to mass.
   FIELDNAM: Mass Scale
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: *int_maxval
   FILLVAL: *double_fillval
@@ -239,6 +250,12 @@ target_low_dust_mass_estimate:
   CATDESC: Estimated dust mass from Target Low signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Target Low)
 
+target_low_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Target Low Velocity Estimate
+  CATDESC: Estimated particle velocity from Target Low signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Target Low)
+
 target_low_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Target Low Chi Square
@@ -275,6 +292,12 @@ target_high_dust_mass_estimate:
   CATDESC: Estimated dust mass from Target High signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Target High)
 
+target_high_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Target High Velocity Estimate
+  CATDESC: Estimated particle velocity from Target High signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Target High)
+
 target_high_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Target High Chi Square
@@ -311,6 +334,12 @@ ion_grid_dust_mass_estimate:
   CATDESC: Estimated dust mass from Ion Grid signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Ion Grid)
 
+ion_grid_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Ion Grid Velocity Estimate
+  CATDESC: Estimated particle velocity from Ion Grid signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Ion Grid)
+
 ion_grid_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Ion Grid Chi Square

imap_processing/cdf/config/imap_idex_l2b_variable_attrs.yaml

@@ -27,31 +27,17 @@ spin_phase_labels:
   DEPEND_1: spin_phase
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
-rectangular_lon_pixel_label:
-  CATDESC: Longitude pixel index label for IDEX SkyMap.
-  FIELDNAM: Longitude pixel label
-  FORMAT: A5
-  VAR_TYPE: metadata
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
-
-rectangular_lat_pixel_label:
-  CATDESC: Latitude pixel index label for IDEX SkyMap.
-  FIELDNAM: Latitude pixel label
-  FORMAT: A5
-  VAR_TYPE: metadata
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
-
 # Index attributes
 mass:
   CATDESC: Log-spaced mass
   FIELDNAM: Mass (kg)
   UNITS: kg
-  FORMAT: I4
+  FORMAT: E10.4
   VAR_TYPE: support_data
   SCALETYP: log
   LABLAXIS: Mass (kg)
-  VALIDMIN: 0
-  VALIDMAX: 10
+  VALIDMIN: 0.0
+  VALIDMAX: 1.00e-14
   FILLVAL: *double_fillval
   LABL_PTR_1: mass_labels
   DICT_KEY: SPASE>Support>SupportQuantity:Other
@@ -65,8 +51,8 @@ spin_phase:
     SCALETYP: linear
     FILLVAL: *int_fillval
     FORMAT: I4
-    VALIDMIN: 0
-    VALIDMAX: 3
+    VALIDMIN: 0.0
+    VALIDMAX: 360
     LABL_PTR_1: spin_phase_labels
     UNITS: deg
     DICT_KEY: SPASE>SupportQuantity:SpinPhase,Qualifier:Array
@@ -78,36 +64,13 @@ impact_charge:
     VAR_TYPE: support_data
     SCALETYP: log
     FILLVAL: *int_fillval
-    FORMAT: I4
-    VALIDMIN: 0
-    VALIDMAX: 10
+    FORMAT: E10.3
+    VALIDMIN: 0.0
+    VALIDMAX: 1.00e04
     LABL_PTR_1: spin_phase_labels
     UNITS: fC
     DICT_KEY: SPASE>Support>SupportQuantity:Other
 
-rectangular_lon_pixel:
-  CATDESC: Longitude pixel center for IDEX SkyMap
-  FIELDNAM: Rectangular Longitude Center
-  FORMAT: F12.6
-  LABLAXIS: Longitude Pixel
-  VAR_TYPE: support_data
-  UNITS: degrees
-  VALIDMIN: 0
-  VALIDMAX: 360
-  FILLVAL: *double_fillval
-  DICT_KEY: SPASE>Support>SupportQuantity:Positional
-
-rectangular_lat_pixel:
-  CATDESC: Latitude pixel center for IDEX SkyMap
-  FIELDNAM: Rectangular Latitude Center
-  FORMAT: F12.6
-  LABLAXIS: Latitude Pixel
-  VAR_TYPE: support_data
-  UNITS: degrees
-  VALIDMIN: -90
-  VALIDMAX: 90
-  FILLVAL: *double_fillval
-  DICT_KEY: SPASE>Support>SupportQuantity:Positional
 
 # Base attributes for charge and mass variables
 base_charge: &base_charge
@@ -140,20 +103,6 @@ base_mass: &base_mass
     VALIDMIN: 0.0
     VALIDMAX: *int_maxval
 
-base_charge_map: &base_charge_map
-  <<: *base_charge
-  DEPEND_2: rectangular_lon_pixel
-  DEPEND_3: rectangular_lat_pixel
-  LABL_PTR_2: rectangular_lon_pixel_label
-  LABL_PTR_3: rectangular_lat_pixel_label
-
-base_mass_map: &base_mass_map
-  <<: *base_mass
-  DEPEND_2: rectangular_lon_pixel
-  DEPEND_3: rectangular_lat_pixel
-  LABL_PTR_2: rectangular_lon_pixel_label
-  LABL_PTR_3: rectangular_lat_pixel_label
-
 rate_by_charge:
     <<: *base_charge
     CATDESC: Count rate per day by impact charge and spin phase.
@@ -162,14 +111,6 @@ rate_by_charge:
     FILLVAL: *double_fillval
     DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
 
-rate_by_charge_map:
-    <<: *base_charge_map
-    CATDESC: Count rate per day by impact charge, longitude, and latitude.
-    FIELDNAM: Rate (day^-1) by Charge Map
-    UNITS: day^-1
-    FILLVAL: *double_fillval
-    DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
-
 rate_by_mass:
     <<: *base_mass
     CATDESC: Count rate per day by mass and spin phase.
@@ -178,14 +119,6 @@ rate_by_mass:
     FILLVAL: *double_fillval
     DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
 
-rate_by_mass_map:
-    <<: *base_mass_map
-    CATDESC: Count rate per day by mass, longitude, and latitude.
-    FIELDNAM: Rate (day^-1) by Mass Map
-    UNITS: day^-1
-    FILLVAL: *double_fillval
-    DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
-
 counts_by_charge:
     <<: *base_charge
     CATDESC: Count by impact charge and spin phase.
@@ -194,14 +127,6 @@ counts_by_charge:
     UNITS: counts
     DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
 
-counts_by_charge_map:
-    <<: *base_charge_map
-    CATDESC: Count by impact charge, longitude, and latitude.
-    FIELDNAM: Counts by Charge Map
-    FORMAT: I8
-    UNITS: counts
-    DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
-
 counts_by_mass:
     <<: *base_mass
     CATDESC: Count by mass and spin phase.
@@ -210,14 +135,6 @@ counts_by_mass:
     UNITS: counts
     DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
 
-counts_by_mass_map:
-    <<: *base_mass_map
-    CATDESC: Count by mass, longitude, and latitude.
-    FIELDNAM: Counts by Mass Map
-    FORMAT: I8
-    UNITS: counts
-    DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
-
 impact_day_of_year:
     CATDESC: The unique day of the years when dust impacts occurred.
     FIELDNAM: Impact Day of Year

imap_processing/cdf/config/imap_idex_l2c_variable_attrs.yaml

@@ -1,20 +1,53 @@
-# Label attributes
-mass_labels:
-  CATDESC: Labels for mass bins
-  FIELDNAM: Mass Bin Labels
-  VAR_TYPE: metadata
-  FORMAT: A8
-  DEPEND_1: mass_bins
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
+int_fillval: &int_fillval -9223372036854775808
+int_maxval: &int_maxval 9223372036854775807
+double_fillval: &double_fillval -1.0E31
 
-charge_labels:
-  CATDESC: Labels for impact charge bins
-  FIELDNAM: Impact Charge Bin Labels
-  VAR_TYPE: metadata
-  FORMAT: A8
-  DEPEND_1: impact_charge_bins
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
+# Base attributes for charge and mass variables
+base_charge: &base_charge
+  CATDESC: " "
+  FIELDNAM: " "
+  DEPEND_0: epoch
+  DEPEND_1: impact_charge
+  DEPEND_2: spin_phase
+  LABL_PTR_1: charge_labels
+  LABL_PTR_2: spin_phase_labels
+  DISPLAY_TYPE: spectrogram
+  VAR_TYPE: data
+  FILLVAL: *int_fillval
+  FORMAT: E10.3
+  VALIDMIN: -1
+  VALIDMAX: *int_maxval
+
+base_mass: &base_mass
+  CATDESC: " "
+  FIELDNAM: " "
+  DEPEND_0: epoch
+  DEPEND_1: mass
+  DEPEND_2: spin_phase
+  LABL_PTR_1: mass_labels
+  LABL_PTR_2: spin_phase_labels
+  DISPLAY_TYPE: spectrogram
+  VAR_TYPE: data
+  FILLVAL: *int_fillval
+  FORMAT: E10.3
+  VALIDMIN: 0.0
+  VALIDMAX: *int_maxval
+
+base_charge_map: &base_charge_map
+  <<: *base_charge
+  DEPEND_2: rectangular_lon_pixel
+  DEPEND_3: rectangular_lat_pixel
+  LABL_PTR_2: rectangular_lon_pixel_label
+  LABL_PTR_3: rectangular_lat_pixel_label
+
+base_mass_map: &base_mass_map
+  <<: *base_mass
+  DEPEND_2: rectangular_lon_pixel
+  DEPEND_3: rectangular_lat_pixel
+  LABL_PTR_2: rectangular_lon_pixel_label
+  LABL_PTR_3: rectangular_lat_pixel_label
 
+# Label attributes
 rectangular_lon_pixel_label:
   CATDESC: Longitude pixel index label for IDEX SkyMap.
   FIELDNAM: Longitude pixel label
@@ -27,4 +60,61 @@ rectangular_lat_pixel_label:
   FIELDNAM: Latitude pixel label
   FORMAT: A5
   VAR_TYPE: metadata
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DICT_KEY: SPASE>Support>SupportQuantity:Other
+
+# Vars
+rectangular_lon_pixel:
+  CATDESC: Longitude pixel center for IDEX SkyMap
+  FIELDNAM: Rectangular Longitude Center
+  FORMAT: F12.6
+  LABLAXIS: Longitude Pixel
+  VAR_TYPE: support_data
+  UNITS: degrees
+  VALIDMIN: 0
+  VALIDMAX: 360
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Support>SupportQuantity:Positional
+
+rectangular_lat_pixel:
+  CATDESC: Latitude pixel center for IDEX SkyMap
+  FIELDNAM: Rectangular Latitude Center
+  FORMAT: F12.6
+  LABLAXIS: Latitude Pixel
+  VAR_TYPE: support_data
+  UNITS: degrees
+  VALIDMIN: -90
+  VALIDMAX: 90
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Support>SupportQuantity:Positional
+
+rate_by_charge_map:
+  <<: *base_charge_map
+  CATDESC: Count rate per day by impact charge, longitude, and latitude.
+  FIELDNAM: Rate (day^-1) by Charge Map
+  UNITS: day^-1
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
+
+counts_by_charge_map:
+  <<: *base_charge_map
+  CATDESC: Count by impact charge, longitude, and latitude.
+  FIELDNAM: Counts by Charge Map
+  FORMAT: I8
+  UNITS: counts
+  DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
+
+counts_by_mass_map:
+  <<: *base_mass_map
+  CATDESC: Count by mass, longitude, and latitude.
+  FIELDNAM: Counts by Mass Map
+  FORMAT: I8
+  UNITS: counts
+  DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
+
+rate_by_mass_map:
+  <<: *base_mass_map
+  CATDESC: Count rate per day by mass, longitude, and latitude.
+  FIELDNAM: Rate (day^-1) by Mass Map
+  UNITS: day^-1
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array

imap_processing/cdf/config/imap_lo_global_cdf_attrs.yaml

@@ -107,8 +107,9 @@ imap_lo_l1c_pset:
   Logical_source: imap_lo_l1c_pset
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1C Data
 
-imap_lo_l2_l090-ena-h-sf-nsp-ram-hae-6deg-3mo:
+# Global attributes for different sensors and sky tiling types and durations
+imap_lo_l2_enamap:
     <<: *instrument_base
-    Data_type: L2_l090-ena-h-sf-nsp-ram-hae-6deg-3mo>Level-2 Low-Energy ENA Maps
-    Logical_source: imap_lo_l2_l090-ena-h-sf-nsp-ram-hae-6deg-3mo
-    Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-2 Low-Energy ENA Maps
+    Data_type: L2_{descriptor}>Level-2 Intensity Map for Lo
+    Logical_source: imap_lo_l2_{descriptor}
+    Logical_source_description: IMAP-Lo Instrument Level-2 Intensity Map Data for Lo

imap_processing/cdf/config/imap_lo_l1a_variable_attrs.yaml

@@ -57,8 +57,8 @@ hist_az_60_default: &hist_az_60_default
   <<: *default_uint32
   VAR_TYPE: data
   DEPEND_0: epoch
-  DEPEND_1: azimuth_60
-  DEPEND_2: esa_step
+  DEPEND_1: esa_step
+  DEPEND_2: azimuth_60
   LABL_PTR_1: azimuth_60_label
   LABL_PTR_2: esa_step_label
 
@@ -66,8 +66,8 @@ hist_az_6_default: &hist_az_6_default
   <<: *default_uint32
   VAR_TYPE: data
   DEPEND_0: epoch
-  DEPEND_1: azimuth_6
-  DEPEND_2: esa_step
+  DEPEND_1: esa_step
+  DEPEND_2: azimuth_6
   LABL_PTR_1: azimuth_6_label
   LABL_PTR_2: esa_step_label
 
@@ -78,17 +78,6 @@ spin_default_attrs: &spin_default
   DEPEND_1: spin
   LABL_PTR_1: spin_label
 
-
-# Re-used Coordinate
-epoch:
-  <<: *default_int64
-  CATDESC: Epoch Time
-  DEPEND_0: epoch
-  FIELDNAM: Epoch time
-  Units: 'ns'
-  VAR_TYPE: support_data
-  LABLAXIS: Epoch
-
 esa_step_label:
    CATDESC: ESA Steps
    FIELDNAM: ESA Steps