imap-processing 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

imap_processing/cdf/config/imap_mag_l1b_variable_attrs.yaml

@@ -0,0 +1,160 @@
+# <=== Label Attributes ===>
+# LABL_PTR_i expects VAR_TYPE of metadata with char data type.
+default_attrs: &default
+  # Assumed values for all variable attrs unless overwritten
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  FORMAT: I12
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: data
+  UNITS: ' '
+
+default_coords: &default_coords
+  # Assumed values for all coordinate attrs unless overwritten
+  FORMAT: F2.4  # Float with 4 digits
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  UNITS: counts
+
+mag_support_attrs: &support_default
+    <<: *default
+    VAR_TYPE: support_data
+    DICT_KEY: SPASE>Support>SupportQuantity:Other
+
+mag_metadata_attrs: &metadata_default
+    <<: *default
+    VAR_TYPE: metadata
+
+direction_label:
+  CATDESC: Magnetic field vector data
+  FIELDNAM: Magnetic Field Vector
+  FORMAT: A3
+  VAR_TYPE: metadata
+
+compression_label:
+  CATDESC: Compression and width
+  FIELDNAM: Compression and width
+  FORMAT: A2
+  VAR_TYPE: metadata
+
+raw_vector_attrs: &raw_vectors_default
+  <<: *default
+  CATDESC: Raw unprocessed magnetic field vector data in bytes
+  DEPEND_1: direction
+  LABL_PTR_1: direction_label
+  FIELDNAM: Magnetic Field Vector
+  FORMAT: I3
+
+vector_attrs: &vectors_default
+    <<: *default
+    CATDESC: Magnetic field vectors with x y z and sensor range varying by time
+    DEPEND_1: direction
+    FIELDNAM: Magnetic Field
+    LABL_PTR_1: direction_label
+    FILLVAL: 9223372036854775807
+    FORMAT: F12.5
+
+mag_flag_attrs:
+    <<: *default
+    VALIDMIN: 0
+    VALIDMAX: 1
+    DISPLAY_TYPE: time_series
+    FILLVAL: 255
+    FORMAT: I1
+
+raw_direction_attrs:
+    <<: *default_coords
+    CATDESC: Raw magnetic field vector binary length
+    FIELDNAM: Raw magnetic field vector binary length
+    LABLAXIS: Magnetic field vector directions
+
+direction_attrs:
+    <<: *default_coords
+    CATDESC: Magnetic field vector
+    FIELDNAM: \[xyz\] magnetic field vector
+    FORMAT: I3
+    VAR_TYPE: support_data
+    DISPLAY_TYPE: time_series
+    LABLAXIS: Magnetic field vector
+
+compression_attrs:
+  <<: *default_coords
+  CATDESC: Data compression flag
+  FIELDNAM: Compression
+  LABLAXIS: Compressed
+  FORMAT: I2
+  VAR_TYPE: support_data
+  VALIDMAX: 21
+  VALIDMIN: 0
+  DISPLAY_TYPE: no_plot
+
+compression_flags_attrs:
+  <<: *support_default
+  CATDESC: Compression information per time stamp, includes a flag and the compression width
+  FIELDNAM: Compression information per time stamp
+  DEPEND_0: epoch
+  DEPEND_1: compression
+  FORMAT: I2
+  VALIDMAX: 21
+  VALIDMIN: 0
+  LABL_PTR_1: compression_label
+  DISPLAY_TYPE: no_plot
+
+compression:
+    <<: *support_default
+    CATDESC: Data compression flag
+    FIELDNAM: Data is compressed
+    LABLAXIS: Compressed
+    FILLVAL: 255
+    FORMAT: I1
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:InstrumentMode
+
+compression_width:
+  <<: *support_default
+  CATDESC: Compression bit width
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: Compressed data bit width
+  LABLAXIS: Bit width
+  FILLVAL: 255
+  FORMAT: I2
+  UNITS: 'bits'
+  VALIDMAX: 21
+  VALIDMIN: 0
+
+pri_sens:
+    <<: *support_default
+    CATDESC: Indicates the primary sensor. 0 is MAGo, 1 is MAGi
+    FIELDNAM: Primary Sensor
+    LABLAXIS: Primary Sensor
+    FILLVAL: 255
+    FORMAT: I1
+    UNITS: ' '
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:InstrumentMode
+
+vecsec:
+    <<: *support_default
+    CATDESC: Vectors per second
+    FIELDNAM: Vectors per second
+    LABLAXIS: Vectors/sec
+    FILLVAL: 0
+    FORMAT: I3
+    UNITS: 'Hz'
+    VALIDMAX: 128
+    VALIDMIN: 1
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+vectors:
+    <<: *vectors_default
+    CATDESC: Magnetic field vectors with x y z and sensor range varying by time
+    FIELDNAM: Magnetic field
+    LABLAXIS: Magnetic field

imap_processing/cdf/config/imap_mag_l1c_variable_attrs.yaml

@@ -0,0 +1,160 @@
+# <=== Label Attributes ===>
+# LABL_PTR_i expects VAR_TYPE of metadata with char data type.
+default_attrs: &default
+  # Assumed values for all variable attrs unless overwritten
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  FORMAT: I12
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  VAR_TYPE: data
+  UNITS: ' '
+
+default_coords: &default_coords
+  # Assumed values for all coordinate attrs unless overwritten
+  FORMAT: F2.4  # Float with 4 digits
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series
+  FILLVAL: -9223372036854775808
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  UNITS: counts
+
+mag_support_attrs: &support_default
+    <<: *default
+    VAR_TYPE: support_data
+    DICT_KEY: SPASE>Support>SupportQuantity:Other
+
+mag_metadata_attrs: &metadata_default
+    <<: *default
+    VAR_TYPE: metadata
+
+direction_label:
+  CATDESC: magnetic field vector data
+  FIELDNAM: Magnetic Field Vector
+  FORMAT: A3
+  VAR_TYPE: metadata
+
+compression_label:
+  CATDESC: Compression and width
+  FIELDNAM: Compression and width
+  FORMAT: A2
+  VAR_TYPE: metadata
+
+raw_vector_attrs: &raw_vectors_default
+  <<: *default
+  CATDESC: Raw unprocessed magnetic field vector data in bytes
+  DEPEND_1: direction
+  LABL_PTR_1: direction_label
+  FIELDNAM: Magnetic Field Vector
+  FORMAT: I3
+
+vector_attrs: &vectors_default
+    <<: *default
+    CATDESC: Magnetic field vectors with x y z and sensor range varying by time
+    DEPEND_1: direction
+    FIELDNAM: Magnetic Field Vector
+    LABL_PTR_1: direction_label
+    FILLVAL: 9223372036854775807
+    FORMAT: F12.5
+
+mag_flag_attrs:
+    <<: *default
+    VALIDMIN: 0
+    VALIDMAX: 1
+    DISPLAY_TYPE: time_series
+    FILLVAL: 255
+    FORMAT: I1
+
+raw_direction_attrs:
+    <<: *default_coords
+    CATDESC: Raw magnetic field vector binary length
+    FIELDNAM: Raw magnetic field vector binary length
+    LABLAXIS: Magnetic field vector directions
+
+direction_attrs:
+    <<: *default_coords
+    CATDESC: Magnetic field vector
+    FIELDNAM: \[xyz\] magnetic field vector
+    FORMAT: I3
+    VAR_TYPE: support_data
+    DISPLAY_TYPE: time_series
+    LABLAXIS: Magnetic field vector
+
+compression_attrs:
+  <<: *default_coords
+  CATDESC: Data compression flag
+  FIELDNAM: Compression
+  LABLAXIS: Compressed
+  FORMAT: I2
+  VAR_TYPE: support_data
+  VALIDMAX: 21
+  VALIDMIN: 0
+  DISPLAY_TYPE: no_plot
+
+compression_flags_attrs:
+  <<: *support_default
+  CATDESC: Compression information per time stamp, includes a flag and the compression width
+  FIELDNAM: Compression information per time stamp
+  DEPEND_0: epoch
+  DEPEND_1: compression
+  FORMAT: I2
+  VALIDMAX: 21
+  VALIDMIN: 0
+  LABL_PTR_1: compression_label
+  DISPLAY_TYPE: no_plot
+
+compression:
+    <<: *support_default
+    CATDESC: Data compression flag
+    FIELDNAM: Data is compressed
+    LABLAXIS: Compressed
+    FILLVAL: 255
+    FORMAT: I1
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:InstrumentMode
+
+compression_width:
+  <<: *support_default
+  CATDESC: Compression bit width
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FIELDNAM: Compressed data bit width
+  LABLAXIS: Bit width
+  FILLVAL: 255
+  FORMAT: I2
+  UNITS: 'bits'
+  VALIDMAX: 21
+  VALIDMIN: 0
+
+pri_sens:
+    <<: *support_default
+    CATDESC: Indicates the primary sensor. 0 is MAGo, 1 is MAGi
+    FIELDNAM: Primary Sensor
+    LABLAXIS: Primary Sensor
+    FILLVAL: 255
+    FORMAT: I1
+    UNITS: ' '
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:InstrumentMode
+
+vecsec:
+    <<: *support_default
+    CATDESC: Vectors per second
+    FIELDNAM: Vectors per second
+    LABLAXIS: Vectors/sec
+    FILLVAL: 0
+    FORMAT: I3
+    UNITS: 'Hz'
+    VALIDMAX: 128
+    VALIDMIN: 1
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+vectors:
+    <<: *vectors_default
+    CATDESC: Magnetic field vectors with x y z and sensor range varying by time
+    FIELDNAM: Magnetic field
+    LABLAXIS: Magnetic field

imap_processing/cdf/config/imap_spacecraft_global_cdf_attrs.yaml

@@ -0,0 +1,18 @@
+Descriptor:
+  Spacecraft>IMAP Spacecraft Data
+TEXT: >
+  Spacecraft data includes all data collected by the IMAP spacecraft and
+  not specific to any one instrument. This includes quaternions from the
+  attitude control system.
+Instrument_type: Ephemeris
+
+# -------------- Product specific global attributes defined below --------------
+imap_spacecraft_l1a_quaternions:
+    Data_type: L1A_QUAT>Level-1A Quaternions
+    Logical_source: imap_spacecraft_l1a_quaternions
+    Logical_source_description: IMAP Quaternion Level-1A Data From the Spacecraft.
+
+imap_spacecraft_l1b_quaternions:
+    Data_type: L1B_QUAT>Level-1B Quaternions
+    Logical_source: imap_spacecraft_l1b_quaternions
+    Logical_source_description: IMAP Quaternion Level-1B Data From the Spacecraft.

imap_processing/cdf/config/imap_spacecraft_variable_attrs.yaml

@@ -0,0 +1,40 @@
+# ------- Default attributes section -------
+default_attrs: &default
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FORMAT: I12
+  UNITS: " "
+  VAR_TYPE: data
+  SCALE_TYPE: linear
+
+default_float32_attrs: &default_float32_attrs
+  <<: *default
+  FILLVAL: .NAN
+  FORMAT: F7.6
+  VALIDMIN: -1
+  VALIDMAX: 1
+  dtype: float32
+
+quat_x:
+  <<: *default_float32_attrs
+  CATDESC: Quaternion X component
+  FIELDNAM: Quaternion X
+  LABLAXIS: QX
+
+quat_y:
+  <<: *default_float32_attrs
+  CATDESC: Quaternion Y component
+  FIELDNAM: Quaternion Y
+  LABLAXIS: QY
+
+quat_z:
+  <<: *default_float32_attrs
+  CATDESC: Quaternion Z component
+  FIELDNAM: Quaternion Z
+  LABLAXIS: QZ
+
+quat_s:
+  <<: *default_float32_attrs
+  CATDESC: Quaternion S component
+  FIELDNAM: Quaternion S
+  LABLAXIS: QS

imap_processing/cdf/config/imap_swapi_global_cdf_attrs.yaml

@@ -12,22 +12,18 @@ instrument_base: &instrument_base
 
 imap_swapi_l1_sci:
   <<: *instrument_base
-  # NOTE: Right now, this Data_level is required to produce valid CDF
-  Data_level: "1"
   Data_type: L1_SCI>Level-1 Science data
   Logical_source: imap_swapi_l1_sci
   Logical_source_description: SWAPI Instrument Level-1 Science Data
 
 imap_swapi_l1_hk:
   <<: *instrument_base
-  Data_level: "1"
   Data_type: L1_HK>Level-1B Housekeeping data
   Logical_source: imap_swapi_l1_hk
   Logical_source_description: SWAPI Instrument Level-1 Housekeeping Data
 
 imap_swapi_l2_sci:
   <<: *instrument_base
-  Data_level: "2"
   Data_type: L2_SCI>Level-2 Science data
   Logical_source: imap_swapi_l2_sci
-  Logical_source_description: SWAPI Instrument Level-1 Science Data
+  Logical_source_description: SWAPI Instrument Level-2 Science Data

imap_processing/cdf/config/imap_swe_global_cdf_attrs.yaml

@@ -10,22 +10,30 @@ instrument_base: &instrument_base
 
 imap_swe_l1a_sci:
   <<: *instrument_base
-  # NOTE: Right now, this Data_level is required to produce valid CDF
-  Data_level: 1A
   Data_type: L1A_SCI>Level-1A Science data
   Logical_source: imap_swe_l1a_sci
   Logical_source_description: SWE Instrument Level-1A Science Data
 
+imap_swe_l1a_hk:
+  <<: *instrument_base
+  Data_type: L1A_HK>Level-1A Housekeeping data
+  Logical_source: imap_swe_l1a_hk
+  Logical_source_description: SWE Instrument Level-1A Housekeeping Data
+
+imap_swe_l1a_cem-raw:
+  <<: *instrument_base
+  Data_type: L1A_CEM-RAW>Level-1A CEM Raw data
+  Logical_source: imap_swe_l1a_cem-raw
+  Logical_source_description: SWE Instrument Level-1A CEM Raw Data
+
 imap_swe_l1b_sci:
   <<: *instrument_base
-  Data_level: 1A
   Data_type: L1B_SCI>Level-1B Science data
   Logical_source: imap_swe_l1b_sci
   Logical_source_description: SWE Instrument Level-1B Science Data
 
 imap_swe_l2_sci:
   <<: *instrument_base
-  Data_level: 2
   Data_type: L2_SCI>Level-2 Science data
   Logical_source: imap_swe_l2_sci
   Logical_source_description: SWE Instrument Level-2 Science Data

imap_processing/cdf/config/imap_swe_l1a_variable_attrs.yaml

@@ -21,10 +21,9 @@ cem_id:
   FORMAT: I1
   LABLAXIS: Angle
   SCALE_TYP: linear
-  UNITS: int
+  UNITS: " "
   VALIDMAX: 6
   VALIDMIN: 0
-  VAR_NOTES: " "
   VAR_TYPE: support_data
 
 # <=== Label Attributes ===>
@@ -74,6 +73,7 @@ raw_counts:
   VALIDMIN: 0
   FILLVAL: -9223372036854775808
   VAR_TYPE: data
+  SCALETYP: linear
 
 science_data:
   CATDESC: Decompressed Counts
@@ -234,3 +234,17 @@ cksum:
   FIELDNAM: Checksum
   FORMAT: I5
   VALIDMAX: 65535
+
+# <=== Non Science Data Variables ===>
+non_science_attrs:
+  CATDESC: SWE data
+  DEPEND_0: epoch
+  FIELDNAM: SWE Raw Data
+  FILLVAL: -9223372036854775808
+  FORMAT: I19
+  UNITS: ' '
+  LABLAXIS: Values
+  VALIDMIN: 0
+  VALIDMAX: 9223372036854769664
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: time_series