isce-framework / isce-framework/isce3

(CF Compliance) (RUNW/GUNW) `ionosphereOutliers` datasets have `dtype=object`

Open
#312 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
239
Forks
90
Avg merge
13d 1h
Merged PRs (30d)
5

Description

Description: ionosphereOutliers datasets have dtype=object, which is not a valid NetCDF/HDF5 data type for CF.

Affected Products: RUNW, GUNW

CF Requirement:

Variables must use standard data types.

CF Conventions 1.7, Section 2.2: Data Types

Link: http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#_data_types

  Quote:                                                                                                                                
  "The netCDF data types char, byte, short, int, float or real, and double are all acceptable.
   The char type is not intended for numeric data. One byte numeric data should be stored
   using the byte data type. It is possible to treat the byte type as unsigned by using the
   NUG convention of indicating the unsigned range using the valid_min, valid_max, 
   or valid_range attributes."

Impact:

  • Cannot be read by standard NetCDF tools
  • May cause crashes in CF-compliant software

Test Datasets Checked:
Datasets checked were produced by mission operations with CRID 05016.

NISAR_L1_PR_RUNW_007_106_A_140_008_7700_SH_20251211T140849_20251211T140926_20251223T140850_20251223T140926_X05016_N_P_J_001.h5
NISAR_L2_PR_GUNW_001_062_A_019_006_2000_SH_20250927T114508_20250927T114542_20251126T114516_20251126T114545_X05016_P_F_J_001.h5

HDF5 Path:

Dataset: /science/LSAR/{PRODUCT}/metadata/processingInformation/algorithms/ionosphereEstimation/ionosphereOutliers
  dtype (actual): object
  dtype (should be): Fixed-length string (e.g., 'S100')

Description of ionosphereOutliers:

Algorithm identifying outliers in unfiltered ionosphere phase screen

cc: @hfattahi @oberonia78 @xhuang-jpl

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the writer for /science/LSAR/{PRODUCT}/metadata/processingInformation/algorithms/ionosphereEstimation/ionosphereOutliers in the Python code; no source file or test is named. Check how its dtype is constructed for RUNW and GUNW, then validate the produced datasets against the stated fixed-length string requirement and standard NetCDF/HDF5 tooling.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.