imap-processing 0.17.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

imap_processing/cdf/config/imap_idex_l2c_variable_attrs.yaml

@@ -2,25 +2,52 @@ int_fillval: &int_fillval -9223372036854775808
 int_maxval: &int_maxval 9223372036854775807
 double_fillval: &double_fillval -1.0E31
 
-epoch_collection_set:
-  CATDESC: Nanoseconds since J2000 with leap seconds. Start (left-edge) of reference time.
-  FIELDNAM: epoch
-  LABLAXIS: epoch
-  FILLVAL: -9223372036854775808
-  FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  UNITS: ns
-  VAR_TYPE: support_data
-  SCALETYP: linear
-  MONOTON: INCREASE
-  TIME_BASE: J2000
-  TIME_SCALE: Terrestrial Time
-  REFERENCE_POSITION: Rotating Earth Geoid
-  RESOLUTION: ' '
-  DISPLAY_TYPE: time_series
-  DICT_KEY: SPASE>Support>SupportQantity:Temporal
+# 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
@@ -35,28 +62,10 @@ rectangular_lat_pixel_label:
   VAR_TYPE: metadata
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
-pixel_label:
-  CATDESC: HEALPix pixel index  label for IDEX SkyMap.
-  FIELDNAM: Pixel label
-  FORMAT: A5
-  VAR_TYPE: metadata
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
-
-pixel_index:
-  CATDESC: HEALPix pixel index for IDEX SkyMap
-  FIELDNAM: HEALPix Index
-  FORMAT: I4
-  LABLAXIS: HEALPix Index
-  VAR_TYPE: support_data
-  UNITS: " "
-  VALIDMIN: 0
-  VALIDMAX: 768
-  FILLVAL: *int_fillval
-  DICT_KEY: SPASE>Support>SupportQuantity:Positional
-
+# Vars
 rectangular_lon_pixel:
-  CATDESC: Longitude pixel index for IDEX SkyMap
-  FIELDNAM: Rectangular Longitude Index
+  CATDESC: Longitude pixel center for IDEX SkyMap
+  FIELDNAM: Rectangular Longitude Center
   FORMAT: F12.6
   LABLAXIS: Longitude Pixel
   VAR_TYPE: support_data
@@ -67,8 +76,8 @@ rectangular_lon_pixel:
   DICT_KEY: SPASE>Support>SupportQuantity:Positional
 
 rectangular_lat_pixel:
-  CATDESC: Latitude pixel index for IDEX SkyMap
-  FIELDNAM: Rectangular Latitude Index
+  CATDESC: Latitude pixel center for IDEX SkyMap
+  FIELDNAM: Rectangular Latitude Center
   FORMAT: F12.6
   LABLAXIS: Latitude Pixel
   VAR_TYPE: support_data
@@ -78,27 +87,34 @@ rectangular_lat_pixel:
   FILLVAL: *double_fillval
   DICT_KEY: SPASE>Support>SupportQuantity:Positional
 
-counts: &counts
-  CATDESC: Number of raw dust events for each pixel
-  FIELDNAM: Dust Counts
-  FORMAT: I20
+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
-  VAR_TYPE: data
-  DISPLAY_TYPE: spectrogram
-  DEPEND_0: epoch
-  VALIDMIN: 0
-  VALIDMAX: *int_maxval
-  FILLVAL: *int_fillval
   DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
 
-healpix_counts:
-  <<: *counts
-  DEPEND_1: pixel_index
-  LABLAXIS: Counts
+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
 
-rectangular_counts:
-  <<: *counts
-  DEPEND_1: rectangular_lon_pixel
-  DEPEND_2: rectangular_lat_pixel
-  LABL_PTR_1: rectangular_lon_pixel_label
-  LABL_PTR_2: rectangular_lat_pixel_label
+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

@@ -29,6 +29,24 @@ imap_lo_l1a_spin:
   Logical_source: imap_lo_l1a_spin
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
 
+imap_lo_l1a_nhk:
+  <<: *instrument_base
+  Data_type: L1A_star>Level-1A Nominal Housekeeping
+  Logical_source: imap_lo_l1a_nhk
+  Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
+
+imap_lo_l1a_shk:
+  <<: *instrument_base
+  Data_type: L1A_star>Level-1A Static Housekeeping
+  Logical_source: imap_lo_l1a_shk
+  Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
+
+imap_lo_l1a_pcc:
+  <<: *instrument_base
+  Data_type: L1A_star>Level-1A Pivot Platform
+  Logical_source: imap_lo_l1a_pcc
+  Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
+
 imap_lo_l1b_badtimes:
   <<: *instrument_base
   Data_type: L1B_badtimes>Level-1B Badtimes
@@ -65,6 +83,18 @@ imap_lo_l1b_prostar:
   Logical_source: imap_lo_l1b_prostar
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
+imap_lo_l1b_nhk:
+  <<: *instrument_base
+  Data_type: L1B_star>Level-1B Nominal Housekeeping
+  Logical_source: imap_lo_l1b_nhk
+  Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
+
+imap_lo_l1b_shk:
+  <<: *instrument_base
+  Data_type: L1B_star>Level-1B Static Housekeeping
+  Logical_source: imap_lo_l1b_shk
+  Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
+
 imap_lo_l1c_goodtimes:
   <<: *instrument_base
   Data_type: L1C_goodtimes>Level-1C Goodtimes List

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

imap_processing/cdf/config/imap_lo_l1c_variable_attrs.yaml

@@ -7,69 +7,86 @@ default_attrs: &default
   DEPEND_0: epoch
   VALIDMAX: 9223372036854775807
   VAR_TYPE: data
-  UNITS: ' '
+  UNITS: " "
 
 # Non-epoch Coordinates
-esa_step_label:
+esa_energy_step_label:
   CATDESC: ESA Steps
   FIELDNAM: ESA Steps
   FORMAT: A1
   VAR_TYPE: metadata
 
-esa_step:
+esa_energy_step:
   VALIDMIN: 1
   VALIDMAX: 7
-  FILLVAL: -9223372036854775808
   CATDESC: Energy Step
-  DEPEND_1: esa_step
   FIELDNAM: Energy Step
-  UNITS: ' '
+  UNITS: " "
   FORMAT: I1
   VAR_TYPE: support_data
   LABLAXIS: ESA
-  LABL_PTR_1: esa_step_label
 
-pointing_bins_label:
-  CATDESC: Pointing bins
-  FIELDNAM: Pointing bins
+spin_angle_label:
+  CATDESC: Spin angles
+  FIELDNAM: Spin angles
   FORMAT: A4
   VAR_TYPE: metadata
 
-pointing_bins:
+spin_angle:
   VALIDMIN: 0
-  VALIDMAX: 3599
-  FILLVAL: -9223372036854775808
-  CATDESC: Pointing bins
-  DEPEND_1: pointing_bins
-  FIELDNAM: Pointing Bins
-  UNITS: ' '
+  VALIDMAX: 360
+  CATDESC: Spin angle bin center in despun pointing frame
+  FIELDNAM: Spin angle
+  UNITS: "degrees"
+  FORMAT: I4
+  VAR_TYPE: support_data
+  LABLAXIS: spin angle
+
+off_angle_label:
+  CATDESC: Off axis angles
+  FIELDNAM: Off axis angles
+  FORMAT: A4
+  VAR_TYPE: metadata
+
+off_angle:
+  VALIDMIN: -2
+  VALIDMAX: 2
+  CATDESC: Off axis angle bin center in despun pointing frame
+  FIELDNAM: Off axis angle
+  UNITS: "degrees"
   FORMAT: I4
   VAR_TYPE: support_data
-  LABLAXIS: pointing bins
-  LABL_PTR_1: pointing_bins_label
+  LABLAXIS: off angle
 
-pointing_start:
+pointing_start_met:
   <<: *default
   CATDESC: MET of start of pointing
   FIELDNAM: Pointing start time
   FORMAT: I12
   UNITS: s
-  LABLAXIS: pointing start time
+  LABLAXIS: pointing start
 
-pointing_end:
+pointing_end_met:
   <<: *default
   CATDESC: MET of end of pointing
   FIELDNAM: Pointing end time
   FORMAT: I12
   UNITS: s
-  LABLAXIS: pointing end time
+  LABLAXIS: pointing end
 
-mode:
+start_spin_number:
   <<: *default
-  CATDESC: Science Mode for Pointing
-  FIELDNAM: Science Mode
+  CATDESC: The spin number at the start of the pointing
+  FIELDNAM: Spin number at start of pointing
+  FORMAT: I12
+  LABLAXIS: Start spin
+
+end_spin_number:
+  <<: *default
+  CATDESC: The spin number at the start of the pointing
+  FIELDNAM: Spin number at the end of the pointing
   FORMAT: I12
-  LABLAXIS: science mode
+  LABLAXIS: End spin
 
 pivot_angle:
   <<: *default
@@ -80,100 +97,174 @@ pivot_angle:
   UNITS: degrees
   LABLAXIS: pivot angle
 
+esa_mode:
+  <<: *default
+  DEPEND_1: esa_energy_step
+  CATDESC: Science Mode for Pointing
+  FIELDNAM: Science Mode
+  FORMAT: I12
+  LABLAXIS: esa mode
+
+hae_longitude:
+  <<: *default
+  VALIDMAX: 360
+  CATDESC: Bin longitudes in HAE coordinates
+  FIELDNAM: Bin longitudes
+  FORMAT: I12
+  UNITS: degrees
+  LABLAXIS: longitude
+  DEPEND_1: spin_angle
+  DEPEND_2: off_angle
+  LABL_PTR_1: spin_angle_label
+  LABL_PTR_2: off_angle_label
+
+hae_latitude:
+  <<: *default
+  VALIDMIN: -90
+  VALIDMAX: 90
+  CATDESC: Bin latitudes in HAE coordinates
+  FIELDNAM: Bin latitudes
+  FORMAT: I12
+  UNITS: degrees
+  LABLAXIS: latitude
+  DEPEND_1: spin_angle
+  DEPEND_2: off_angle
+  LABL_PTR_1: spin_angle_label
+  LABL_PTR_2: off_angle_label
+
+exposure_time:
+  <<: *default
+  CATDESC: Exposure times by ESA step
+  FIELDNAM: Exposure Times
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  UNITS: "s"
+
 triples_counts:
   <<: *default
   CATDESC: Counts for triple coincidence events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
   FIELDNAM: triples coincidence counts
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
   FORMAT: I12
-  LABLAXIS: triples coincidence counts
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
-
-triples_rates:
-  <<: *default
-  CATDESC: Count rates for triple coincidence events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
-  FILLVAL: -1.0000000E+31
-  FIELDNAM: triple coincidence count rates
-  LABLAXIS: triple coincidence count rates
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
 
 doubles_counts:
   <<: *default
-  CATDESC: "Counts for double coincidence events"
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
+  CATDESC: Counts for double coincidence events
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
   FIELDNAM: Double coincidence counts
   FORMAT: I12
-  LABLAXIS: double coincidence counts
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
-
-doubles_rates:
-  <<: *default
-  CATDESC: Count rates for double coincidence events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
-  FILLVAL: -1.0000000E+31
-  FIELDNAM: double coincidence count rates
-  LABLAXIS: double coincidence count rates
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
+  LABLAXIS: doubles
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
 
-hydrogen_counts:
+h_counts:
   <<: *default
   CATDESC: Counts for Hydrogen events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
   FIELDNAM: Hydrogen counts
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12
+
+h_background_rates:
+  <<: *default
+  CATDESC: Background Hydrogen rates
+  FIELDNAM: Background Hydrogen rates
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
   FORMAT: I12
-  LABLAXIS: H counts
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
+  DELTA_PLUS_VAR: h_background_rates_stat_uncert
+  DELTA_MINUS_VAR: h_background_rates_stat_uncert
 
-hydrogen_rates:
+h_background_rates_stat_uncert:
   <<: *default
-  CATDESC: Count rates for Hydrogen events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
-  FILLVAL: -1.0000000E+31
-  FIELDNAM: Hydrogen count rates
-  LABLAXIS: H coincidence count rates
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
+  CATDESC: Background Hydrogen rates statistical uncertainty
+  FIELDNAM: Background Hydrogen rates stat uncertainty
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12
 
-oxygen_counts:
+h_background_rates_sys_err:
+  <<: *default
+  CATDESC: Background Hydrogen rates systematic error
+  FIELDNAM: Background Hydrogen rates systematic error
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12
+
+o_counts:
   <<: *default
   CATDESC: Count rates for Oxygen events
-  DEPEND_1: pointing_bins
-  DEPEND_2: esa_step
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
   FORMAT: I12
   FIELDNAM: Oxygen count rates
-  LABLAXIS: O count rates
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
 
-oxygen_rates:
+o_background_rates:
   <<: *default
-  CATDESC : Count rates for Oxygen events
-  DEPEND_1 : pointing_bins
-  DEPEND_2 : esa_step
-  FILLVAL: -1.0000000E+31
-  FIELDNAM : Oxygen count rates
-  LABLAXIS : O count rates
-  LABL_PTR_1: pointing_bins_label
-  LABL_PTR_2: esa_step_label
+  CATDESC: Background Oxygen rates
+  FIELDNAM: Background Oxygen rates
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12
+  DELTA_PLUS_VAR: o_background_rates_stat_uncert
+  DELTA_MINUS_VAR: o_background_rates_stat_uncert
 
-exposure_time:
+o_background_rates_stat_uncert:
   <<: *default
-  CATDESC: Exposure times by ESA step
-  DEPEND_1: esa_step
-  FILLVAL: -1.0000000E+31
-  FIELDNAM: Exposure Times
-  UNITS: "s"
-  LABLAXIS: exposure times
-  LABL_PTR_1: esa_step_label
+  CATDESC: Background Oxygen rates statistical uncertainty
+  FIELDNAM: Background Oxygen rates stat uncertainty
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12
+
+o_background_rates_sys_err:
+  <<: *default
+  CATDESC: Background Oxygen rates systematic error
+  FIELDNAM: Background Oxygen rates systematic error
+  DEPEND_1: esa_energy_step
+  DEPEND_2: spin_angle
+  DEPEND_3: off_angle
+  LABL_PTR_1: esa_energy_step_label
+  LABL_PTR_2: spin_angle_label
+  LABL_PTR_3: off_angle_label
+  FORMAT: I12