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

imap_processing/cdf/config/imap_mag_global_cdf_attrs.yaml

@@ -84,6 +84,62 @@ imap_mag_l1c_norm-magi:
     Logical_source: imap_mag_l1c_norm-magi
     Logical_source_description: IMAP Mission MAGi Normal Rate Instrument Level-1C Data.
 
+imap_mag_l1d_norm-rtn:
+    <<: *default
+    Data_type: L1D_norm-rtn>Level 1D normal rate data in RTN
+    Logical_source: imap_mag_l1d_norm-rtn
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-1D Data in
+        Radial-Tangential-Normal Reference Frame.
+
+imap_mag_l1d_burst-rtn:
+    <<: *default
+    Data_type: L1D_burst-rtn>Level 1D burst rate data in RTN
+    Logical_source: imap_mag_l1d_burst-rtn
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-1D Data in
+        Radial-Tangential-Normal Reference Frame.
+
+imap_mag_l1d_norm-gse:
+    <<: *default
+    Data_type: L1D_norm-gse>Level 1D normal rate data in GSE
+    Logical_source: imap_mag_l1d_norm-gse
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-1D Data in
+        Geocentric Solar Ecliptic Reference Frame.
+
+imap_mag_l1d_burst-gse:
+    <<: *default
+    Data_type: L1D_burst-gse>Level 1D burst rate data in GSE
+    Logical_source: imap_mag_l1d_burst-gse
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-1D Data in
+        Geocentric Solar Ecliptic Reference Frame.
+
+imap_mag_l1d_norm-srf:
+    <<: *default
+    Data_type: L1D_norm-srf>Level 1D normal rate data in SRF
+    Logical_source: imap_mag_l1d_norm-srf
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-1D Data in
+        Spacecraft Reference Frame.
+
+imap_mag_l1d_burst-srf:
+    <<: *default
+    Data_type: L1D_burst-srf>Level 1D burst rate data in SRF
+    Logical_source: imap_mag_l1d_burst-srf
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-1D Data in
+        Spacecraft Reference Frame.
+
+imap_mag_l1d_norm-dsrf:
+    <<: *default
+    Data_type: L1D_norm-dsrf>Level 1D normal rate data in DSRF
+    Logical_source: imap_mag_l1d_norm-dsrf
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-1D Data in
+        Despun Spacecraft Reference Frame.
+
+imap_mag_l1d_burst-dsrf:
+    <<: *default
+    Data_type: L1D_burst-dsrf>Level 1D burst rate data in DSRF
+    Logical_source: imap_mag_l1d_burst-dsrf
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-1D Data in
+        Despun Spacecraft Reference Frame.
+
 imap_mag_l2_norm-dsrf:
   <<: *default
   Data_type: L2_norm-dsrf>Level 2 normal rate data in DSRF
@@ -91,10 +147,51 @@ imap_mag_l2_norm-dsrf:
   Logical_source_description: IMAP Mission Normal Rate Instrument Level-2 Data in
     Despun Spacecraft Reference Frame.
 
-
 imap_mag_l2_burst-dsrf:
   <<: *default
   Data_type: L2_burst-dsrf>Level 2 burst rate data in DSRF
   Logical_source: imap_mag_l2_burst-dsrf
   Logical_source_description: IMAP Mission Burst Rate Instrument Level-2 Data in
-    Despun Spacecraft Reference Frame.
+    Despun Spacecraft Reference Frame.
+
+imap_mag_l2_norm-srf:
+    <<: *default
+    Data_type: L2_norm-srf>Level 2 normal rate data in SRF
+    Logical_source: imap_mag_l2_norm-srf
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-2 Data in
+        Spacecraft Reference Frame.
+
+imap_mag_l2_burst-srf:
+    <<: *default
+    Data_type: L2_burst-srf>Level 2 burst rate data in SRF
+    Logical_source: imap_mag_l2_burst-srf
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-2 Data in
+        Spacecraft Reference Frame.
+
+imap_mag_l2_norm-rtn:
+    <<: *default
+    Data_type: L2_norm-rtn>Level 2 normal rate data in RTN
+    Logical_source: imap_mag_l2_norm-rtn
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-2 Data in
+        Radial-Tangential-Normal Reference Frame.
+
+imap_mag_l2_burst-rtn:
+    <<: *default
+    Data_type: L2_burst-rtn>Level 2 burst rate data in RTN
+    Logical_source: imap_mag_l2_burst-rtn
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-2 Data in
+        Radial-Tangential-Normal Reference Frame.
+
+imap_mag_l2_norm-gse:
+    <<: *default
+    Data_type: L2_norm-gse>Level 2 normal rate data in GSE
+    Logical_source: imap_mag_l2_norm-gse
+    Logical_source_description: IMAP Mission Normal Rate Instrument Level-2 Data in
+        Geocentric Solar Ecliptic Reference Frame.
+
+imap_mag_l2_burst-gse:
+    <<: *default
+    Data_type: L2_burst-gse>Level 2 burst rate data in GSE
+    Logical_source: imap_mag_l2_burst-gse
+    Logical_source_description: IMAP Mission Burst Rate Instrument Level-2 Data in
+        Geocentric Solar Ecliptic Reference Frame.

imap_processing/cdf/config/imap_mag_l1c_variable_attrs.yaml

@@ -4,7 +4,7 @@ default_attrs: &default
   # Assumed values for all variable attrs unless overwritten
   DEPEND_0: epoch
   DISPLAY_TYPE: time_series
-  FILLVAL: -9223372036854775808
+  FILLVAL: -1.0e+31
   FORMAT: I12
   VALIDMIN: -9223372036854775808
   VALIDMAX: 9223372036854775807
@@ -105,6 +105,29 @@ compression_flags_attrs:
   LABL_PTR_1: compression_label
   DISPLAY_TYPE: no_plot
 
+generated_flag_attrs:
+  <<: *support_default
+  CATDESC: Flag indicating data has been downsampled and interpolated from higher frequency measurements
+  FIELDNAM: Generated Flag
+  LABLAXIS: Generated Flag
+  FILLVAL: 255
+  FORMAT: I1
+  UNITS: ' '
+  VALIDMAX: 1
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:Other
+
+vector_magnitude_attrs:
+  <<: *support_default
+  CATDESC: Magnitude of the magnetic field vector
+  FIELDNAM: Magnetic Field Magnitude
+  LABLAXIS: "|B|"
+  FORMAT: F12.5
+  UNITS: nT
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854775807
+  DICT_KEY: SPASE>Field>FieldQuantity:Magnetic,Qualifier:Scalar
+
 compression:
     <<: *support_default
     CATDESC: Data compression flag

imap_processing/cdf/config/imap_ultra_global_cdf_attrs.yaml

@@ -32,6 +32,66 @@ imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-ang:
     Logical_source: imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-ang
     Logical_source_description: IMAP-Ultra Instrument Level-1A PHxTOF Hi Angular Data.
 
+imap_ultra_l1a_45sensor-histogram-ena-phxtof-hi-nrg:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-phxtof-hi-nrg
+    Logical_source_description: IMAP-Ultra Instrument Level-1A PHxTOF Hi Energy Data.
+
+imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-nrg:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    Logical_source: imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-nrg
+    Logical_source_description: IMAP-Ultra Instrument Level-1A PHxTOF Hi Energy Data.
+
+imap_ultra_l1a_45sensor-histogram-ena-phxtof-hi-time:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-phxtof-hi-time
+    Logical_source_description: IMAP-Ultra Instrument Level-1A PHxTOF Hi Time Data.
+
+imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-time:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    Logical_source: imap_ultra_l1a_90sensor-histogram-ena-phxtof-hi-time
+    Logical_source_description: IMAP-Ultra Instrument Level-1A PHxTOF Hi Time Data.
+
+imap_ultra_l1a_45sensor-histogram-ena-extof-hi-ang:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-extof-hi-ang
+    Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Angular Data.
+
+imap_ultra_l1a_90sensor-histogram-ena-extof-hi-ang:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A TOF
+    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:
+    <<: *instrument_base
+    Data_type: L1A_Histogram>Level-1A ExTOF
+    Logical_source: imap_ultra_l1a_45sensor-histogram-ena-extof-hi-time
+    Logical_source_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Time Data.
+
+imap_ultra_l1a_90sensor-histogram-ena-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_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Time Data.
+
+imap_ultra_l1a_45sensor-histogram-ena-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_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Energy Data.
+
+imap_ultra_l1a_90sensor-histogram-ena-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_description: IMAP-Ultra Instrument Level-1A ExTOF Hi Energy Data.
+
 imap_ultra_l1a_45sensor-rates:
     <<: *instrument_base
     Data_type: L1A_Rates>Level-1A Rates

imap_processing/cdf/config/imap_ultra_l1b_variable_attrs.yaml

@@ -256,6 +256,20 @@ theta:
   LABLAXIS: theta
   UNITS: degrees
 
+geometric_factor_blades:
+  <<: *default_float32
+  CATDESC: Ultra sensitive area within the field of view.
+  FIELDNAM: geometric_function_blades
+  LABLAXIS: geometric function blades
+  UNITS: " "
+
+geometric_factor_noblades:
+  <<: *default_float32
+  CATDESC: Ultra sensitive area within the field of regard.
+  FIELDNAM: geometric_function_noblades
+  LABLAXIS: geometric function noblades
+  UNITS: " "
+
 phi_fwhm:
   <<: *default_float32
   CATDESC: FWHM of the phi distribution.
@@ -334,7 +348,8 @@ spin_start_time:
   LABLAXIS: spin start time
   # TODO: come back to format
   UNITS: s
-  DEPEND_0: spin_number
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
 
 spin_period:
   <<: *default
@@ -342,7 +357,8 @@ spin_period:
   FIELDNAM: spin_period
   LABLAXIS: spin_period
   UNITS: s
-  DEPEND_0: spin_number
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
 
 spin_rate:
   <<: *default
@@ -350,7 +366,8 @@ spin_rate:
   FIELDNAM: spin_rate
   LABLAXIS: spin_rate
   UNITS: rpm
-  DEPEND_0: spin_number
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
 
 rate_start_pulses:
   <<: *default
@@ -397,9 +414,46 @@ ena_rates:
   <<: *default_float32
   CATDESC: Rates calculated from de packet.
   FIELDNAM: ena_rates
-  LABLAXIS: ena_rates
-  DEPEND_0: spin_number
-  DEPEND_1: energy_bin_geometric_mean
+  LABLAXIS: ena rates
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
+  UNITS: " "
+
+start_pulses_per_spin:
+  <<: *default_float32
+  CATDESC: Total start pulses per spin.
+  FIELDNAM: start_pulses_per_spin
+  LABLAXIS: start pulses per spin
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  UNITS: " "
+
+stop_pulses_per_spin:
+  <<: *default_float32
+  CATDESC: Total start pulses per spin.
+  FIELDNAM: stop_pulses_per_spin
+  LABLAXIS: stop pulses per spin
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  UNITS: " "
+
+coin_pulses_per_spin:
+  <<: *default_float32
+  CATDESC: Total coincidence pulses per spin.
+  FIELDNAM: coin_pulses_per_spin
+  LABLAXIS: coin_pulses_per_spin
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  UNITS: " "
+
+rejected_events_per_spin:
+  <<: *default_uint16
+  CATDESC: Rejected events per spin.
+  FIELDNAM: rejected_events_per_spin
+  LABLAXIS: rejected events per spin
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
   UNITS: " "
 
 ena_rates_threshold:
@@ -407,8 +461,9 @@ ena_rates_threshold:
   CATDESC: Rates threshold used for flagging data.
   FIELDNAM: ena_rates_threshold
   LABLAXIS: ena_rates_threshold
-  DEPEND_0: spin_number
-  DEPEND_1: energy_bin_geometric_mean
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
   UNITS: " "
 
 quality_ena_rates:
@@ -416,8 +471,9 @@ 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: spin_number
-  DEPEND_1: energy_bin_geometric_mean
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
   UNITS: " "
 
 quality_attitude:
@@ -427,7 +483,9 @@ quality_attitude:
   LABLAXIS: quality attitude
   # TODO: come back to format
   UNITS: " "
-  DEPEND_0: spin_number
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
 
 quality_instruments:
   <<: *default_uint16
@@ -436,3 +494,33 @@ quality_instruments:
   LABLAXIS: quality instruments
   # TODO: come back to format
   UNITS: " "
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: energy_bin_geometric_mean
+
+quality_hk:
+  <<: *default_uint16
+  CATDESC: Spin filter derived from housekeeping data. Bitwise flagging used to filter the spin.
+  FIELDNAM: quality_hk
+  LABLAXIS: quality hk
+  # TODO: come back to format
+  UNITS: " "
+  DEPEND_0: epoch
+  DEPEND_1: spin_number
+  DEPEND_2: 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_scattering:
+  <<: *default_uint16
+  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,15 @@ default_float32_attrs: &default_float32
   VALIDMAX: 3.4028235e+38
   dtype: float32
 
+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 +33,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,25 +46,61 @@ 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: " "
+  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
+
 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