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

imap_processing/cdf/config/imap_idex_l1a_variable_attrs.yaml

@@ -57,7 +57,7 @@ sample_rate_base: &sample_rate_base
   FORMAT: F64.5
   LABLAXIS: Time
   UNITS: microseconds
-  VAR_TYPE: support_data # Not in attrs file
+  VAR_TYPE: support_data
   VAR_NOTES:  The number of microseconds since the event.
               0 is the start of data collection, negative
               numbers represent data collected prior to a dust event

imap_processing/cdf/config/imap_lo_global_cdf_attrs.yaml

@@ -7,84 +7,72 @@ instrument_base: &instrument_base
 
 imap_lo_l1a_de:
   <<: *instrument_base
-  Data_level: 1A
   Data_type: L1A_de>Level-1A Science Direct Events
   Logical_source: imap_lo_l1a_de
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
 
 imap_lo_l1a_histogram:
   <<: *instrument_base
-  Data_level: 1A
   Data_type: L1A_histogram>Level-1A Science Counts
   Logical_source: imap_lo_l1a_histogram
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
 
 imap_lo_l1a_star:
   <<: *instrument_base
-  Data_level: 1A
   Data_type: L1A_star>Level-1A Star Sensor
   Logical_source: imap_lo_l1a_star
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
 
 imap_lo_l1a_spin:
   <<: *instrument_base
-  Data_level: 1A
   Data_type: L1A_star>Level-1A Spin
   Logical_source: imap_lo_l1a_spin
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1A Data
 
 imap_lo_l1b_badtimes:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_badtimes>Level-1B Badtimes
   Logical_source: imap_lo_l1b_badtimes
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1b_de:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_de>Level-1B Annotated Direct Events
   Logical_source: imap_lo_l1b_de
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1b_monitorrates:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_monitorrates>Level-1B Monitor Rates
   Logical_source: imap_lo_l1b_monitorrates
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1b_histogramrates:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_histogramrates>Level-1B Histogram Rates
   Logical_source: imap_lo_l1b_histogramrrates
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1b_derates:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_derates>Level-1B Direct Event Rates
   Logical_source: imap_lo_l1b_derates
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1b_prostar:
   <<: *instrument_base
-  Data_level: 1B
   Data_type: L1B_prostar>Level-1B Processed Star Sensor
   Logical_source: imap_lo_l1b_prostar
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1B Data
 
 imap_lo_l1c_goodtimes:
   <<: *instrument_base
-  Data_level: 1C
   Data_type: L1C_goodtimes>Level-1C Goodtimes List
   Logical_source: imap_lo_l1c_goodtimes
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1C Data
 
 imap_lo_l1c_pset:
   <<: *instrument_base
-  Data_level: 1C
   Data_type: L1C_pset>Level-1C Pointing Set
   Logical_source: imap_lo_l1c_pset
   Logical_source_description: IMAP Mission IMAP-Lo Instrument Level-1C Data

imap_processing/cdf/config/imap_lo_l1a_variable_attrs.yaml

@@ -110,7 +110,7 @@ esa_step_coord:
 shcoarse:
   <<: *default_uint32
   CATDESC: Mission Elapsed Time
-  DEPEND_0: epoch
+  DEPEND_1: shcoarse
   FIELDNAM: Spacecraft Time
   Units: 'ns'
   VAR_TYPE: support_data

imap_processing/cdf/config/imap_mag_global_cdf_attrs.yaml

@@ -2,96 +2,84 @@ default: &default
   Descriptor:
     MAG>Magnetometer
   TEXT: >
-    The IMAP magnetometer (MAG consists of a pair of identical magnetometers
-    which each measure the magnetic field in three directions in the vicinity of
-    the spacecraft.
-    MAG will contribute to our understanding of the acceleration and transport
-    of charged particles in the heliosphere.
-    MAG design and assembly is led by Imperial College, London. See
-    https://imap.princeton.edu/instruments/mag for more details.
-  Instrument_type: MAG>Magnetometer
+    The IMAP magnetometer MAG consists of two vector magnetic field sensors
+    which measure the magnetic field in the vicinity of the
+    spacecraft. MAG will contribute to our understanding of the acceleration and transport
+    of charged particles in the heliosphere, the dynamics of interplanetary shocks, and provide
+    real time space weather measurements via the I-AliRT service.
+    MAG design, assembly, operations, and calibration are led by Imperial
+    College London. See
+    https://imap.princeton.edu/spacecraft/instruments/magnetometer-mag for more details.
+  Instrument_type: Magnetic Fields (space)
 
 imap_mag_l1a_norm-raw:
     <<: *default
     Data_type: L1A_norm-raw>Level-1A raw normal rate
     Logical_source: imap_mag_l1a_norm-raw
     Logical_source_description: IMAP Mission MAG Normal Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1a_burst-raw:
     <<: *default
     Data_type: L1A_burst-raw>Level-1A raw burst rate
     Logical_source: imap_mag_l1a_burst-raw
     Logical_source_description: IMAP Mission MAG Burst Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1a_norm-mago:
     <<: *default
     Data_type: L1A_norm-mago>Level 1A MAGo normal rate
     Logical_source: imap_mag_l1a_norm-mago
     Logical_source_description: IMAP Mission MAGo Normal Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1a_norm-magi:
     <<: *default
     Data_type: L1A_norm-magi>Level 1A MAGi normal rate
     Logical_source: imap_mag_l1a_norm-magi
     Logical_source_description: IMAP Mission MAGi Normal Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1a_burst-mago:
     <<: *default
     Data_type: L1A_burst-mago>Level 1A MAGo burst rate
     Logical_source: imap_mag_l1a_burst-mago
     Logical_source_description: IMAP Mission MAGo Burst Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1a_burst-magi:
     <<: *default
     Data_type: L1A_burst-magi>Level 1A MAGi burst rate
     Logical_source: imap_mag_l1a_burst-magi
     Logical_source_description: IMAP Mission MAGi Burst Rate Instrument Level-1A Data.
-    Data_level: L1A
 
 imap_mag_l1b_norm-mago:
     <<: *default
     Data_type: L1B_norm-mago>Level 1B MAGo normal rate
     Logical_source: imap_mag_l1b_norm-mago
     Logical_source_description: IMAP Mission MAGo Normal Rate Instrument Level-1B Data.
-    Data_level: L1B
 
 imap_mag_l1b_norm-magi:
     <<: *default
     Data_type: L1B_norm-magi>Level 1B MAGi normal rate
     Logical_source: imap_mag_l1b_norm-magi
     Logical_source_description: IMAP Mission MAGi Normal Rate Instrument Level-1B Data.
-    Data_level: L1B
 
 imap_mag_l1b_burst-mago:
     <<: *default
     Data_type: L1B_burst-mago>Level 1B MAGo burst rate
     Logical_source: imap_mag_l1b_burst-mago
     Logical_source_description: IMAP Mission MAGo Burst Rate Instrument Level-1B Data.
-    Data_level: L1B
 
 imap_mag_l1b_burst-magi:
     <<: *default
     Data_type: L1B_burst-magi>Level 1B MAGi burst rate
     Logical_source: imap_mag_l1b_burst-magi
     Logical_source_description: IMAP Mission MAGi Burst Rate Instrument Level-1B Data.
-    Data_level: L1B
 
 imap_mag_l1c_norm-mago:
     <<: *default
     Data_type: L1C_norm-mago>Level 1C MAGo normal rate
     Logical_source: imap_mag_l1c_norm-mago
     Logical_source_description: IMAP Mission MAGo Normal Rate Instrument Level-1C Data.
-    Data_level: L1C
 
 imap_mag_l1c_norm-magi:
     <<: *default
     Data_type: L1C_norm-magi>Level 1C MAGi normal rate
     Logical_source: imap_mag_l1c_norm-magi
     Logical_source_description: IMAP Mission MAGi Normal Rate Instrument Level-1C Data.
-    Data_level: L1C
-

imap_processing/cdf/config/imap_mag_l1a_variable_attrs.yaml

@@ -0,0 +1,361 @@
+# <=== 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 vector 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
+
+pus_version:
+    <<: *support_default
+    CATDESC: PUS Version number
+    FIELDNAM: PUS Version number
+    LABLAXIS: PUS Version
+    FILLVAL: 8
+    FORMAT: I1
+    VALIDMAX: 7
+    VALIDMIN: 0
+
+pus_stype:
+    <<: *support_default
+    CATDESC: PUS Service type
+    FIELDNAM: PUS Service type
+    LABLAXIS: PUS type
+    FILLVAL: 255
+    FORMAT: I3
+    VALIDMAX: 255
+    VALIDMIN: 0
+
+pus_ssubtype:
+    <<: *support_default
+    CATDESC: PUS Service subtype. Equal to the number of seconds of data minus 1
+    FIELDNAM: Number of seconds of data minus 1
+    LABLAXIS: PUS Subtype
+    FILLVAL: 255
+    FORMAT: I3
+    UNITS: 's'
+    VALIDMAX: 255
+    VALIDMIN: 0
+
+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
+
+mago_act:
+    <<: *support_default
+    CATDESC: MAGo Active status
+    FIELDNAM: MAGo Sensor Active
+    LABLAXIS: MAGo Active
+    FILLVAL: 255
+    FORMAT: I1
+    UNITS: ' '
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+magi_act:
+    <<: *support_default
+    CATDESC: MAGi Active status
+    FIELDNAM: MAGi Sensor Active
+    LABLAXIS: MAGi Active
+    FILLVAL: 255
+    FORMAT: I1
+    UNITS: ' '
+    VALIDMAX: 1
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+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
+
+pri_vecsec:
+    <<: *support_default
+    CATDESC: Primary vectors per second
+    FIELDNAM: Primary vectors per second
+    LABLAXIS: Primary Vectors
+    FILLVAL: 0
+    FORMAT: I3
+    UNITS: 'Hz'
+    VALIDMAX: 128
+    VALIDMIN: 1
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+sec_vecsec:
+    <<: *support_default
+    CATDESC: Secondary vectors per second
+    FIELDNAM: Secondary vectors per second
+    LABLAXIS: Secondary Vectorss
+    FILLVAL: 0
+    FORMAT: I3
+    UNITS: 'Hz'
+    VALIDMAX: 128
+    VALIDMIN: 1
+    DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+pri_coarsetm:
+    <<: *support_default
+    CATDESC: Primary coarse time, mission SCLK in whole seconds
+    FIELDNAM: Primary coarse time
+    LABLAXIS: Primary coarse time
+    FILLVAL: 4294967295
+    FORMAT: I10
+    UNITS: 's'
+    VALIDMAX: 4294967295
+    VALIDMIN: 0
+    VAR_TYPE: support_data
+    DICT_KEY: SPASE>Support>SupportQuantity:Temporal
+
+pri_fntm:
+    <<: *support_default
+    CATDESC: Primary fine time, mission SCLK in 16bit subseconds
+    FIELDNAM: Primary fine time (16 bit subsecond)
+    LABLAXIS: Primary fine time
+    FILLVAL: 65536
+    FORMAT: I5
+    UNITS: ' '
+    VALIDMAX: 65535
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:Temporal
+
+sec_coarsetm:
+    <<: *support_default
+    CATDESC: Secondary coarse time, mission SCLK in whole seconds
+    FIELDNAM: Secondary coarse time
+    LABLAXIS: Secondary coarse time
+    FILLVAL: 4294967295
+    FORMAT: I10
+    UNITS: 's'
+    VALIDMAX: 4294967295
+    VALIDMIN: 0
+    VAR_TYPE: support_data
+    DICT_KEY: SPASE>Support>SupportQuantity:Temporal
+
+sec_fntm:
+    <<: *support_default
+    CATDESC: Secondary fine time, mission SCLK in 16bit subseconds
+    FIELDNAM: Secondary fine time (16 bit subsecond)
+    LABLAXIS: Secondary fine time
+    FILLVAL: 65536
+    FORMAT: I5
+    UNITS: ' '
+    VALIDMAX: 65535
+    VALIDMIN: 0
+    DICT_KEY: SPASE>Support>SupportQuantity:Temporal
+
+vectors:
+    <<: *raw_vectors_default
+    CATDESC: Raw binary value of vectors
+    FIELDNAM: Raw binary vectors
+    LABLAXIS: Raw vectors
+
+# CCSDS attributes for MAG L1A RAW
+
+version:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet version number
+  FIELDNAM: CCSDS Packet version number
+  LABLAXIS: CCSDS Packet version
+  FILLVAL: 8
+  FORMAT: I1
+  UNITS: ' '
+  VALIDMAX: 7
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:HouseKeeping
+
+type:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet type
+  FIELDNAM: CCSDS Packet type
+  LABLAXIS: Packet Type
+  FILLVAL: 2
+  FORMAT: I1
+  UNITS: ' '
+  VALIDMAX: 1
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+sec_hdr_flg:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet Secondary header flag
+  FIELDNAM: CCSDS Packet Secondary header flag
+  LABLAXIS: Sec header flag
+  FILLVAL: 2
+  FORMAT: I1
+  UNITS: ' '
+  VALIDMAX: 1
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+pkt_apid:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet Application Process ID
+  FIELDNAM: CCSDS Packet Application Process ID
+  LABLAXIS: APID
+  FILLVAL: 2048
+  FORMAT: H3
+  UNITS: ' '
+  VALIDMAX: 2047
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+seq_flgs:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet Grouping flags
+  FIELDNAM: CCSDS Packet Grouping flags
+  LABLAXIS: Packet Grouping
+  FILLVAL: 4
+  FORMAT: I1
+  UNITS: ' '
+  VALIDMAX: 3
+  VALIDMIN: 0
+
+src_seq_ctr:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet Source Sequence Counter
+  FIELDNAM: CCSDS Packet Source Sequence Counter
+  LABLAXIS: Seq Counter
+  FILLVAL: 16384
+  FORMAT: I5
+  UNITS: ' '
+  VALIDMAX: 16383
+  VALIDMIN: 0
+  DICT_KEY: SPASE>Support>SupportQuantity:Housekeeping
+
+pkt_len:
+  <<: *metadata_default
+  CATDESC: CCSDS Packet Length
+  FIELDNAM: CCSDS Packet Length
+  LABLAXIS: Packet Length
+  FILLVAL: 65535
+  FORMAT: I5
+  UNITS: ' '
+  VALIDMAX: 65535
+  VALIDMIN: 0