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

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,14 +508,21 @@ 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
+  CATDESC: Quality flag for direct event for events outliers.
+  FIELDNAM: quality_outliers
+  LABLAXIS: quality_outliers
+  # TODO: come back to format
+  UNITS: " "
 
-quality_fov:
+quality_scattering:
   <<: *default_uint16
-  CATDESC: Quality flag for direct event for events outside of the FOV.
-  FIELDNAM: quality_fov
-  LABLAXIS: quality fov
+  CATDESC: Quality flag for direct event scattering.
+  FIELDNAM: quality_scattering
+  LABLAXIS: quality_scattering
   # TODO: come back to format
   UNITS: " "

imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml

@@ -17,9 +17,23 @@ 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
+  DEPEND_2: pixel_index
+
 latitude:
   <<: *default_float32
   CATDESC: Latitude bin center corresponding to healpix index with range [-90, 90].
+  DEPEND_1: pixel_index
   FIELDNAM: latitude
   LABLAXIS: latitude
   UNITS: degrees
@@ -27,6 +41,7 @@ latitude:
 longitude:
   <<: *default_float32
   CATDESC: Longitude bin center corresponding to healpix index with range [0, 360].
+  DEPEND_1: pixel_index
   FIELDNAM: longitude
   LABLAXIS: longitude
   UNITS: degrees
@@ -39,30 +54,98 @@ species_bin:
   # TODO: come back to format
   UNITS: " "
 
-exposure_factor:
+dead_time_ratio:
   <<: *default_float32
-  CATDESC: Exposure time for a pointing.
-  FIELDNAM: exposure_factor
-  LABLAXIS: exposure factor
-  # TODO: come back to format
-  UNITS: seconds
+  CATDESC: Dead time correction ratios for each spin phase step (1ms resolution).
+  DEPEND_1: spin_phase_step
+  FIELDNAM: dead_time_ratios
+  LABLAXIS: Dead Time Ratio
+  UNITS: " "
+  VALIDMIN: 0.0
 
 sensitivity:
-  <<: *default_float32
+  <<: *energy_dependent
   CATDESC: Calibration/sensitivity factor.
   FIELDNAM: sensitivity
   LABLAXIS: sensitivity
   # TODO: come back to format
   UNITS: counts/second
 
+geometric_function:
+  <<: *energy_dependent
+  CATDESC: The effective sensitive area as a function of theta and phi in instrument frame (energy independent).
+  FIELDNAM: geometric_function
+  LABLAXIS: Geometric Factor
+  UNITS: cm^2
+  VALIDMIN: 0.0
+
+efficiency:
+  <<: *energy_dependent
+  CATDESC: Estimated event efficiency for particles path through the instrument.
+  FIELDNAM: efficiency
+  LABLAXIS: Efficiency
+  UNITS: " "
+  VALIDMIN: 0.0
+  VALIDMAX: 1.0
+
+exposure_factor:
+  <<: *energy_dependent
+  CATDESC: Exposure time with the deadtime correction applied for a pointing.
+  FIELDNAM: exposure_factor
+  LABLAXIS: exposure factor
+  # TODO: come back to format
+  UNITS: seconds
+
+helio_exposure_factor:
+  <<: *energy_dependent
+  CATDESC: Exposure time with the deadtime correction applied for a pointing.
+  FIELDNAM: exposure_factor
+  LABLAXIS: 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.
+  DEPEND_1: energy_bin_geometric_mean
+  DEPEND_2: pixel_index
   FIELDNAM: counts
   LABLAXIS: 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.
@@ -94,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