IDEX Initial L2c processing (IMAP-Science-Operations-Center#1682)

* initial idex l2c processing

* modify IDEXpointingSet and add tests

* SPASE metadata

* reorg

* refactor remove maps

* remove IDEXPointingSet class

* rename healpix index name

* move import

* l2c add rectangular psets

* fix tests

* recreate 2d counts for rectangular to test 2d histogram works as intended

* fix idex l2b test

* fix spacing

* address PR comments

* pr comments from Nat

* naming updates

* product rename

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add todos

* fix l2c attrs

* update epoch metadata

* address pr comments from Greg.

* fix indexing on spatial coords

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: lacoak21

imap_processing/cdf/config/imap_idex_global_cdf_attrs.yaml

@@ -55,5 +55,21 @@ imap_idex_l2b_sci:
   <<: *instrument_base
   Data_level: 2B
   Data_type: L2B_SCI>Level-2B Science Data
-  Logical_source: imap_idex_l2b_sci # TODO how often?
-  Logical_source_description: IMAP Mission IDEX Instrument Level-2B Data
+  Logical_source: imap_idex_l2b_sci-1week
+  Logical_source_description: IMAP Mission IDEX Instrument Level-2B Data
+
+
+#TODO what should these look like?
+imap_idex_l2c_sci-healpix:
+  <<: *instrument_base
+  Data_level: 2C
+  Data_type: L2C_MAP-HEALPIX>Level-2C Science Data
+  Logical_source: imap_idex_l2c_healpix-map-1week
+  Logical_source_description: IMAP Mission IDEX Instrument Level-2C Data Healpix
+
+imap_idex_l2c_sci-rectangular:
+  <<: *instrument_base
+  Data_level: 2C
+  Data_type: L2C_MAP-RECTANGULAR>Level-2C Science Data
+  Logical_source: imap_idex_l2c_rectangular-map-1week
+  Logical_source_description: IMAP Mission IDEX Instrument Level-2C Data Rectangular

imap_processing/cdf/config/imap_idex_l1b_variable_attrs.yaml

@@ -346,14 +346,14 @@ current_neg2p5v_bus:
 ephemeris_position_x:
   <<: *spice_base
   FIELDNAM: Position X
-  CATDESC: Cartesian coordinate X positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  CATDESC: Cartesian coord X positions for the IMAP spacecraft in the ECLIPJ2000 frame.
   LABLAXIS: Position X
   UNITS: km
 
 ephemeris_position_y:
   <<: *spice_base
   FIELDNAM: Position Y
-  CATDESC: Cartesian coordinate Y positions for the IMAP spacecraft in the ECLIPJ2000 frame.
+  CATDESC: Cartesian coord Y positions for the IMAP spacecraft in the ECLIPJ2000 frame.
   LABLAXIS: Position Y
   UNITS: km
 
@@ -385,18 +385,18 @@ ephemeris_velocity_z:
   LABLAXIS: Velocity Z
   UNITS: km/s
 
-right_ascension:
+longitude:
   <<: *spice_base
   VALIDMIN: 0
-  FIELDNAM: Right Ascension
-  CATDESC: Right ascension of the IMAP spacecraft position as observed from Earth in the ECLIPJ2000 reference frame.
-  LABLAXIS: Right Ascension
+  FIELDNAM: Longitude
+  CATDESC: Longitude of the dust event as observed from Earth in the ECLIPJ2000 frame.
+  LABLAXIS: Longitude
 
-declination:
+latitude:
   <<: *spice_base
-  FIELDNAM: Declination
-  CATDESC: Declination of the IMAP spacecraft position as observed from Earth in the ECLIPJ2000 reference frame.
-  LABLAXIS: Declination
+  FIELDNAM: Latitude
+  CATDESC: Latitude of the dust event as observed from Earth in the ECLIPJ2000 frame.
+  LABLAXIS: Latitude
 
 spin_phase:
   <<: *spice_base

imap_processing/cdf/config/imap_idex_l2c_variable_attrs.yaml

@@ -0,0 +1,100 @@
+int_fillval: &int_fillval -9223372036854775808
+int_maxval: &int_maxval 9223372036854775807
+double_fillval: &double_fillval -1.0E31
+
+epoch_collection_set:
+  CATDESC: Nanoseconds since J2000 with leap seconds. Start (left-edge) of reference time.
+  FIELDNAM: epoch
+  LABLAXIS: epoch
+  FILLVAL: -9223372036854775808
+  FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
+  VALIDMIN: -9223372036854775808
+  VALIDMAX: 9223372036854775807
+  UNITS: ns
+  VAR_TYPE: support_data
+  SCALETYP: linear
+  MONOTON: INCREASE
+  TIME_BASE: J2000
+  TIME_SCALE: Terrestrial Time
+  REFERENCE_POSITION: Rotating Earth Geoid
+  RESOLUTION: ' '
+  DISPLAY_TYPE: time_series
+
+rectangular_lon_pixel_label:
+  CATDESC: Longitude pixel index label for IDEX SkyMap.
+  FIELDNAM: Longitude pixel label
+  FORMAT: A5
+  VAR_TYPE: metadata
+
+rectangular_lat_pixel_label:
+  CATDESC: Latitude pixel index label for IDEX SkyMap.
+  FIELDNAM: Latitude pixel label
+  FORMAT: A5
+  VAR_TYPE: metadata
+
+pixel_label:
+  CATDESC: HEALPix pixel index  label for IDEX SkyMap.
+  FIELDNAM: Pixel label
+  FORMAT: A5
+  VAR_TYPE: metadata
+
+pixel_index:
+  CATDESC: HEALPix pixel index for IDEX SkyMap
+  FIELDNAM: HEALPix Index
+  FORMAT: I4
+  LABLAXIS: HEALPix Index
+  VAR_TYPE: support_data
+  UNITS: " "
+  VALIDMIN: 0
+  VALIDMAX: 768
+  FILLVAL: *int_fillval
+  DICT_KEY: SPASE>Support>SupportQuantity:Positional
+
+rectangular_lon_pixel:
+  CATDESC: Longitude pixel index for IDEX SkyMap
+  FIELDNAM: Rectangular Longitude Index
+  FORMAT: F12.6
+  LABLAXIS: Longitude Pixel
+  VAR_TYPE: support_data
+  UNITS: degrees
+  VALIDMIN: 0
+  VALIDMAX: 360
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Support>SupportQuantity:Positional
+
+rectangular_lat_pixel:
+  CATDESC: Latitude pixel index for IDEX SkyMap
+  FIELDNAM: Rectangular Latitude Index
+  FORMAT: F12.6
+  LABLAXIS: Latitude Pixel
+  VAR_TYPE: support_data
+  UNITS: degrees
+  VALIDMIN: -90
+  VALIDMAX: 90
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Support>SupportQuantity:Positional
+
+counts: &counts
+  CATDESC: Number of raw dust events for each pixel
+  FIELDNAM: Dust Counts
+  FORMAT: I12
+  UNITS: counts
+  VAR_TYPE: data
+  DISPLAY_TYPE: time_series
+  DEPEND_0: epoch
+  VALIDMIN: 0
+  VALIDMAX: *int_maxval
+  FILLVAL: *int_fillval
+  DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Counts,Qualifier:Array
+
+healpix_counts:
+  <<: *counts
+  DEPEND_1: pixel_index
+  LABL_PTR_1: pixel_label
+
+rectangular_counts:
+  <<: *counts
+  DEPEND_1: rectangular_lon_pixel
+  DEPEND_2: rectangular_lat_pixel
+  LABL_PTR_1: rectangular_lon_pixel_label
+  LABL_PTR_2: rectangular_lat_pixel_label

imap_processing/idex/idex_constants.py

@@ -3,6 +3,8 @@
 from dataclasses import dataclass
 from enum import Enum, IntEnum
 
+from imap_processing.spice.geometry import SpiceFrame
+
 
 class IDEXAPID(IntEnum):
     """Create ENUM for apid."""
@@ -67,8 +69,19 @@ class ConversionFactors(float, Enum):
     "ephemeris_velocity_x",
     "ephemeris_velocity_y",
     "ephemeris_velocity_z",
-    "right_ascension",
-    "declination",
+    "longitude",
+    "latitude",
     "solar_longitude",
     "spin_phase",
 ]
+
+# Default IDEX Healpix parameters
+# Used in IDEX l2c processing
+IDEX_HEALPIX_NSIDE = 8
+IDEX_HEALPIX_NESTED = False
+# Default IDEX Rectangular parameters
+# Used in IDEX l2c processing
+IDEX_SPACING_DEG = 4  # TODO
+
+# Define the pointing reference frame for IDEX
+IDEX_EVENT_REFERENCE_FRAME = SpiceFrame.ECLIPJ2000

imap_processing/idex/idex_l1b.py

@@ -23,7 +23,10 @@
 
 from imap_processing import imap_module_directory
 from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
-from imap_processing.idex.idex_constants import ConversionFactors
+from imap_processing.idex.idex_constants import (
+    IDEX_EVENT_REFERENCE_FRAME,
+    ConversionFactors,
+)
 from imap_processing.idex.idex_utils import get_idex_attrs, setup_dataset
 from imap_processing.spice.geometry import (
     SpiceBody,
@@ -350,15 +353,15 @@ def get_spice_data(
     # Get spacecraft spin phase in degrees
     spin_phase = get_spacecraft_spin_phase(query_met_times=met)
     imap_spin_phase = get_spin_angle(spin_phase, degrees=True)
-    # Get position and velocity of IMAP in ecliptic frame
+    # Get the position and velocity of IMAP in ecliptic frame
     ephemeris = imap_state(et, observer=SpiceBody.SUN)
-    # Get Idex pointing in the j2000 equatorial frame
+    # Get Idex pointing in the defined frame
     idex_pointing = instrument_pointing(
-        et, SpiceFrame.IMAP_IDEX, SpiceFrame.J2000, cartesian=True
+        et, SpiceFrame.IMAP_IDEX, IDEX_EVENT_REFERENCE_FRAME, cartesian=True
     )
     solar_lon = solar_longitude(et, degrees=True)
-
-    range_ra_and_dec = cartesian_to_spherical(idex_pointing)
+    # longitude and latitude
+    lon_and_lat = cartesian_to_spherical(idex_pointing)[:, 1:]
 
     spice_data = {
         "ephemeris_position_x": ephemeris[:, 0],
@@ -367,8 +370,8 @@ def get_spice_data(
         "ephemeris_velocity_x": ephemeris[:, 3],
         "ephemeris_velocity_y": ephemeris[:, 4],
         "ephemeris_velocity_z": ephemeris[:, 5],
-        "right_ascension": range_ra_and_dec[:, 1],
-        "declination": range_ra_and_dec[:, 2],
+        "longitude": lon_and_lat[:, 0],
+        "latitude": lon_and_lat[:, 1],
         "spin_phase": imap_spin_phase,
         "solar_longitude": solar_lon,
     }