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

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

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,7 +147,6 @@ 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
@@ -111,4 +166,32 @@ imap_mag_l2_burst-srf:
     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.
+        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_l1b_variable_attrs.yaml

@@ -509,10 +509,18 @@ quality_hk:
   DEPEND_1: spin_number
   DEPEND_2: energy_bin_geometric_mean
 
-quality_fov:
+quality_outliers:
   <<: *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 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