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

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.
@@ -196,6 +207,50 @@ exposure_factor: &exposure_factor
   DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>TemporalDescription:Exposure,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
+geometric_function:
+  <<: *default_float32
+  CATDESC: The geometric function calculated from multiple pointing sets.
+  FIELDNAM: geometric_function
+  UNITS: cm^2 sr
+  DEPEND_0: epoch
+  VAR_TYPE: data
+  LABLAXIS: Geometric Factor
+  DISPLAY_TYPE: no_plot
+  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:GeometricFactor,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
+
+efficiency:
+  <<: *default_float32
+  CATDESC: Event efficiency calculated from multiple pointing sets.
+  FIELDNAM: efficiency
+  UNITS: " "
+  DEPEND_0: epoch
+  VAR_TYPE: data
+  LABLAXIS: Efficiency
+  DISPLAY_TYPE: no_plot
+  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:Other
+
+positional_uncert_theta:
+  <<: *default_float32
+  CATDESC: Positional uncertainty in theta direction calculated from multiple pointing sets.
+  FIELDNAM: positional_uncertainty_theta
+  UNITS: degrees
+  DEPEND_0: epoch
+  VAR_TYPE: data
+  LABLAXIS: Position Uncertainty Theta
+  DISPLAY_TYPE: no_plot
+  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:ArrivalDirection,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
+
+positional_uncert_phi:
+  <<: *default_float32
+  CATDESC: Positional uncertainty in phi direction calculated from multiple pointing sets.
+  FIELDNAM: positional_uncertainty_phi
+  UNITS: degrees
+  DEPEND_0: epoch
+  VAR_TYPE: data
+  LABLAXIS: Position Uncertainty Phi
+  DISPLAY_TYPE: no_plot
+  DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:ArrivalDirection,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
+
 obs_date: &obs_date
   <<: *default_int64
   datatype: int64

imap_processing/cdf/config/imap_enamaps_l2-healpix_variable_attrs.yaml

@@ -72,6 +72,29 @@ sensitivity:
   LABL_PTR_1: energy_label
   LABL_PTR_2: pixel_index_label
 
+efficiency:
+  DEPEND_1: energy
+  DEPEND_2: pixel_index
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: pixel_index_label
+
+geometric_function:
+  DEPEND_1: energy
+  DEPEND_2: pixel_index
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: pixel_index_label
+
+positional_uncert_theta:
+  DEPEND_1: energy
+  DEPEND_2: pixel_index
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: pixel_index_label
+
+positional_uncert_phi:
+  DEPEND_1: energy
+  DEPEND_2: pixel_index
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: pixel_index_label
 # These data variables will have an extra (energy) dimension
 # only if the energy dimension is present in the L1C data.
 # The default is energy-independent.
@@ -99,6 +122,12 @@ obs_date:
   LABL_PTR_1: energy_label
   LABL_PTR_2: pixel_index_label
 
+obs_date_range:
+  DEPEND_1: energy
+  DEPEND_2: pixel_index
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: pixel_index_label
+
 solid_angle:
   DEPEND_1: pixel_index
   LABL_PTR_1: pixel_index_label

imap_processing/cdf/config/imap_enamaps_l2-rectangular_variable_attrs.yaml

@@ -134,6 +134,38 @@ exposure_factor:
   LABL_PTR_2: longitude_label
   LABL_PTR_3: latitude_label
 
+efficiency:
+  DEPEND_1: energy
+  DEPEND_2: longitude
+  DEPEND_3: latitude
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: longitude_label
+  LABL_PTR_3: latitude_label
+
+geometric_function:
+  DEPEND_1: energy
+  DEPEND_2: longitude
+  DEPEND_3: latitude
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: longitude_label
+  LABL_PTR_3: latitude_label
+
+positional_uncert_theta:
+  DEPEND_1: energy
+  DEPEND_2: longitude
+  DEPEND_3: latitude
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: longitude_label
+  LABL_PTR_3: latitude_label
+
+positional_uncert_phi:
+  DEPEND_1: energy
+  DEPEND_2: longitude
+  DEPEND_3: latitude
+  LABL_PTR_1: energy_label
+  LABL_PTR_2: longitude_label
+  LABL_PTR_3: latitude_label
+
 obs_date:
   DEPEND_1: energy
   DEPEND_2: longitude

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

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_ultra_global_cdf_attrs.yaml

@@ -68,28 +68,28 @@ imap_ultra_l1a_90sensor-histogram-ena-extof-hi-ang:
     Logical_source: imap_ultra_l1a_90sensor-histogram-ena-extof-hi-ang
     Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Angular Data.
 
-imap_ultra_l1a_45sensor-histogram-ena-extof-hi-time:
+imap_ultra_l1a_45sensor-histogram-ion-extof-hi-time:
     <<: *instrument_base
     Data_type: L1A_Histogram>Level-1A ExTOF
-    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-extof-hi-time
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ion-extof-hi-time
     Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Time Data.
 
-imap_ultra_l1a_90sensor-histogram-ena-extof-hi-time:
+imap_ultra_l1a_90sensor-histogram-ion-extof-hi-time:
     <<: *instrument_base
     Data_type: L1A_Histogram>Level-1A ExTOF
-    Logical_source: imap_ultra_l1a_90sensor-histogram-ena-extof-hi-time
+    Logical_source: imap_ultra_l1a_90sensor-histogram-ion-extof-hi-time
     Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Time Data.
 
-imap_ultra_l1a_45sensor-histogram-ena-extof-hi-nrg:
+imap_ultra_l1a_45sensor-histogram-ion-extof-hi-nrg:
     <<: *instrument_base
     Data_type: L1A_Histogram>Level-1A ExTOF
-    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-extof-hi-nrg
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ion-extof-hi-nrg
     Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Energy Data.
 
-imap_ultra_l1a_90sensor-histogram-ena-extof-hi-nrg:
+imap_ultra_l1a_90sensor-histogram-ion-extof-hi-nrg:
     <<: *instrument_base
     Data_type: L1A_Histogram>Level-1A ExTOF
-    Logical_source: imap_ultra_l1a_90sensor-histogram-ena-extof-hi-nrg
+    Logical_source: imap_ultra_l1a_90sensor-histogram-ion-extof-hi-nrg
     Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Energy Data.
 
 imap_ultra_l1a_45sensor-rates:
@@ -224,17 +224,17 @@ imap_ultra_l1b_90sensor-extendedspin:
     Logical_source: imap_ultra_l1b_90sensor-extendedspin
     Logical_source_description: IMAP-Ultra Instrument Level-1B Extended Spin Data.
 
-imap_ultra_l1b_45sensor-cullingmask:
+imap_ultra_l1b_45sensor-goodtimes:
     <<: *instrument_base
-    Data_type: L1B_45Sensor-CullingMask>Level-1B Culling Mask for Ultra45
-    Logical_source: imap_ultra_l1b_45sensor-cullingmask
-    Logical_source_description: IMAP-Ultra Instrument Level-1B Culling Mask Data.
+    Data_type: L1B_45Sensor-Goodtimes>Level-1B Goodtimes for Ultra45
+    Logical_source: imap_ultra_l1b_45sensor-goodtimes
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Goodtimes Data.
 
-imap_ultra_l1b_90sensor-cullingmask:
+imap_ultra_l1b_90sensor-goodtimes:
     <<: *instrument_base
-    Data_type: L1B_90Sensor-CullingMask>Level-1B Culling Mask for Ultra90
-    Logical_source: imap_ultra_l1b_90sensor-cullingmask
-    Logical_source_description: IMAP-Ultra Instrument Level-1B Culling Mask Data.
+    Data_type: L1B_90Sensor-Goodtimes>Level-1B Goodtimes for Ultra90
+    Logical_source: imap_ultra_l1b_90sensor-goodtimes
+    Logical_source_description: IMAP-Ultra Instrument Level-1B Goodtimes Data.
 
 imap_ultra_l1b_45sensor-badtimes:
     <<: *instrument_base
@@ -260,6 +260,18 @@ imap_ultra_l1c_90sensor-spacecraftpset:
     Logical_source: imap_ultra_l1c_90sensor-spacecraftpset
     Logical_source_description: IMAP-Ultra Instrument Level-1C Spacecraft Pointing Set Grid.
 
+imap_ultra_l1c_45sensor-spacecraftpset-nonproton:
+    <<: *instrument_base
+    Data_type: L1C_45Sensor-PSET>Level-1C Pointing Set Grid for Ultra45
+    Logical_source: imap_ultra_l1c_45sensor-spacecraftpset-nonproton
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Spacecraft Pointing Set Grid for Non-Proton Species.
+
+imap_ultra_l1c_90sensor-spacecraftpset-nonproton:
+    <<: *instrument_base
+    Data_type: L1C_90Sensor-PSET>Level-1C Pointing Set Grid for Ultra90
+    Logical_source: imap_ultra_l1c_90sensor-spacecraftpset-nonproton
+    Logical_source_description: IMAP-Ultra Instrument Level-1C Spacecraft Pointing Set Grid for Non-Proton Species.
+
 imap_ultra_l1c_45sensor-heliopset:
     <<: *instrument_base
     Data_type: L1C_45Sensor-PSET>Level-1C Pointing Set Grid for Ultra45

imap_processing/cdf/config/imap_ultra_l1b_variable_attrs.yaml

@@ -72,6 +72,22 @@ default_float64_attrs: &default_float64
   VALIDMAX: 1.7976931348623157e+308
   dtype: float64
 
+computed_ebin:
+  <<: *default_uint8
+  CATDESC: Computed event bin index
+  FIELDNAM: Computed ebin
+  LABLAXIS: computed_ebin
+  UNITS: " "
+  DEPEND_0: epoch
+
+ebin:
+  <<: *default_uint8
+  CATDESC: Event bin index
+  FIELDNAM: Ebin
+  LABLAXIS: ebin
+  UNITS: " "
+  DEPEND_0: epoch
+
 x_front:
   <<: *default_float32
   CATDESC: x front position
@@ -223,7 +239,7 @@ energy_heliosphere:
 species:
   <<: *default_uint8
   DISPLAY_TYPE: no_plot
-  CATDESC: Label species type.
+  CATDESC: Label species type. Non-proton (heavy ion) = 0, proton = 1, misc = 3
   FIELDNAM: Label species type.
   LABLAXIS: species
   UNITS: " "
@@ -348,8 +364,7 @@ spin_start_time:
   LABLAXIS: spin start time
   # TODO: come back to format
   UNITS: s
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
 
 spin_period:
   <<: *default
@@ -357,8 +372,7 @@ spin_period:
   FIELDNAM: spin_period
   LABLAXIS: spin_period
   UNITS: s
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
 
 spin_rate:
   <<: *default
@@ -366,8 +380,7 @@ spin_rate:
   FIELDNAM: spin_rate
   LABLAXIS: spin_rate
   UNITS: rpm
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
 
 rate_start_pulses:
   <<: *default
@@ -415,9 +428,8 @@ ena_rates:
   CATDESC: Rates calculated from de packet.
   FIELDNAM: ena_rates
   LABLAXIS: ena rates
-  DEPEND_0: epoch
+  DEPEND_0: energy_bin_geometric_mean
   DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
   UNITS: " "
 
 start_pulses_per_spin:
@@ -425,8 +437,7 @@ start_pulses_per_spin:
   CATDESC: Total start pulses per spin.
   FIELDNAM: start_pulses_per_spin
   LABLAXIS: start pulses per spin
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
   UNITS: " "
 
 stop_pulses_per_spin:
@@ -434,8 +445,7 @@ stop_pulses_per_spin:
   CATDESC: Total start pulses per spin.
   FIELDNAM: stop_pulses_per_spin
   LABLAXIS: stop pulses per spin
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
   UNITS: " "
 
 coin_pulses_per_spin:
@@ -443,8 +453,7 @@ coin_pulses_per_spin:
   CATDESC: Total coincidence pulses per spin.
   FIELDNAM: coin_pulses_per_spin
   LABLAXIS: coin_pulses_per_spin
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
   UNITS: " "
 
 rejected_events_per_spin:
@@ -452,8 +461,7 @@ rejected_events_per_spin:
   CATDESC: Rejected events per spin.
   FIELDNAM: rejected_events_per_spin
   LABLAXIS: rejected events per spin
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
+  DEPEND_0: spin_number
   UNITS: " "
 
 ena_rates_threshold:
@@ -461,9 +469,8 @@ ena_rates_threshold:
   CATDESC: Rates threshold used for flagging data.
   FIELDNAM: ena_rates_threshold
   LABLAXIS: ena_rates_threshold
-  DEPEND_0: epoch
+  DEPEND_0: energy_bin_geometric_mean
   DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
   UNITS: " "
 
 quality_ena_rates:
@@ -471,9 +478,7 @@ quality_ena_rates:
   CATDESC: Spin filter derived from Ultra ena rates. Bitwise flagging used to filter the spin.
   FIELDNAM: quality_ena_rates
   LABLAXIS: quality_ena_rates
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
+  DEPEND_0: spin_number
   UNITS: " "
 
 quality_attitude:
@@ -483,9 +488,8 @@ quality_attitude:
   LABLAXIS: quality attitude
   # TODO: come back to format
   UNITS: " "
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
+  DEPEND_0: spin_number
+  DEPEND_1: energy_bin_geometric_mean
 
 quality_instruments:
   <<: *default_uint16
@@ -494,9 +498,8 @@ quality_instruments:
   LABLAXIS: quality instruments
   # TODO: come back to format
   UNITS: " "
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
+  DEPEND_0: spin_number
+  DEPEND_1: energy_bin_geometric_mean
 
 quality_hk:
   <<: *default_uint16
@@ -505,9 +508,8 @@ quality_hk:
   LABLAXIS: quality hk
   # TODO: come back to format
   UNITS: " "
-  DEPEND_0: epoch
-  DEPEND_1: spin_number
-  DEPEND_2: energy_bin_geometric_mean
+  DEPEND_0: spin_number
+  DEPEND_1: energy_bin_geometric_mean
 
 quality_outliers:
   <<: *default_uint16

imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml

@@ -17,6 +17,14 @@ default_float32_attrs: &default_float32
   VALIDMAX: 3.4028235e+38
   dtype: float32
 
+default_uint16_attrs: &default_uint16
+  <<: *default
+  FILLVAL: 65535
+  FORMAT: I5
+  VALIDMIN: 0
+  VALIDMAX: 65535
+  dtype: uint16
+
 energy_dependent_attrs: &energy_dependent
   <<: *default_float32
   DEPEND_1: energy_bin_geometric_mean
@@ -68,7 +76,7 @@ geometric_function:
   CATDESC: The effective sensitive area as a function of theta and phi in instrument frame (energy independent).
   FIELDNAM: geometric_function
   LABLAXIS: Geometric Factor
-  UNITS: " "
+  UNITS: cm^2
   VALIDMIN: 0.0
 
 efficiency:
@@ -96,6 +104,27 @@ helio_exposure_factor:
   # TODO: come back to format
   UNITS: seconds
 
+scatter_theta:
+  <<: *energy_dependent
+  CATDESC: Scattering theta values for a pointing.
+  FIELDNAM: scatter_theta
+  LABLAXIS: scatter theta
+  UNITS: degrees
+
+scatter_phi:
+  <<: *energy_dependent
+  CATDESC: Scattering phi values for a pointing.
+  FIELDNAM: scatter_phi
+  LABLAXIS: scatter phi
+  UNITS: degrees
+
+scatter_threshold:
+  <<: *energy_dependent
+  CATDESC: Scattering threshold values for each energy bin for a pointing.
+  FIELDNAM: scatter_threshold
+  LABLAXIS: scatter threshold
+  UNITS: degrees
+
 counts:
   <<: *default
   CATDESC: Counts for a spin.
@@ -106,6 +135,17 @@ counts:
   # TODO: come back to format
   UNITS: counts
 
+
+quality_flags:
+  <<: *default_uint16
+  CATDESC: Spin filter derived from Ultra ena rates. Bitwise flagging used to filter the spin.
+  FIELDNAM: quality_ena_rates
+  LABLAXIS: quality_ena_rates
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
+  UNITS: " "
+
 background_rates:
   <<: *default_float32
   CATDESC: Background rates. Background dominated by accidentals caused by a combination of UV light and misregistered low energy ENA events.
@@ -137,3 +177,23 @@ energy_bin_delta:
   FIELDNAM: energy_bin_delta
   LABLAXIS: energy bin delta
   UNITS: keV
+
+energy_delta_minus:
+  <<: *default_float32
+  VAR_TYPE: support_data
+  CATDESC: Difference between the energy bin center and lower edge.
+  LABLAXIS: energy
+  UNITS: KeV
+  FIELDNAM: energy_bin_delta_minus
+  DISPLAY_TYPE: no_plot
+  DEPEND_1: energy_bin_geometric_mean
+
+energy_delta_plus:
+  <<: *default_float32
+  VAR_TYPE: support_data
+  CATDESC: Difference between the energy bin center and upper edge.
+  LABLAXIS: energy
+  UNITS: KeV
+  FIELDNAM: energy_bin_delta_plus
+  DISPLAY_TYPE: no_plot
+  DEPEND_1: energy_bin_geometric_mean