Skip to content

Full LABL_PTR for 3d vectors #140

Description

@jtniehof

Summary

SPDF has requested that any simple 3D vectors or triangular (6 element) tensors have a LABL_PTR_1 that can be interpreted without reference to the LABLAXIS. That means both putting more information into the values of the variable pointed to by LABL_PTR_1 and splitting those variables, so that basically every data variable has its own label variable. Detailed list in "requirements" below

Things that do not have to change:

  • Only applies to data variables, so we'll not bother on support_data
  • Unless noted otherwise, the existing label pointer variable should stay, as it will be used for higher-dimensionality quantities (covariances) and support_data variables (e.g. uncertainties)
  • Similarly, the LABLAXIS should stay, as there are utilities that use it.
  • If there is a DEPEND pointing to a simple 1, 2, 3 or similar numeric, it does not have to change...just the labels

We probably want to merge #128 before starting on this, as otherwise there are likely to be conflicts. I'm going to give SPDF a little bit of time to review those changes and then merge it myself.

Requirements

For each product and variable, this lists what the new labels should be; i.e. copy the metadata for the existing label, update as necessary (inheritance may be good here), and populate the NRV values in the code

  • swapi_l3a_alpha-sw
    • alpha_sw_velocity_rtn ['Va SC R', 'Va SC T', 'Va SC N']
    • alpha_sw_velocity_rtn_sun ['Va Sun R', 'Va Sun T', 'Va Sun N']
  • swapi_l3a_proton-sw
    • proton_sw_velocity_rtn ['Vp SC R', 'Vp SC T', 'Vp SC N']
    • proton_sw_velocity_rtn_sun ['Vp Sun R', 'Vp Sun T', 'Vp Sun N']
  • swe_l3-sci
    • core_velocity_vector_rtn_fit ['Core v fit R', 'Core v fit T', 'Core v fit N']
    • halo_velocity_vector_rtn_fit ['Halo v fit R', 'Halo v fit T', 'Halo v fit N']
    • core_velocity_vector_rtn_integrated ['Core v int. R', 'Core v int. T', 'Core v int. N']
    • halo_velocity_vector_rtn_integrated ['Halo v int. R', 'Halo v int. T', 'Halo v int. N']
    • total_velocity_vector_rtn_integrated ['Total v int. R', 'Total v int. T', 'Total v int. N']
    • Let's leave in rtn_label, even though nothing will refer to it, because we might want it later
    • core_temperature_tensor_integrated ['Core T_XX', 'Core T_XY', 'Core T_YY', 'Core T_XZ', 'Core T_YZ', 'Core T_ZZ']
    • halo_temperature_tensor_integrated ['Halo T_XX', 'Halo T_XY', 'Halo T_YY', 'Halo T_XZ', 'Halo T_YZ', 'Halo T_ZZ']
    • total_temperature_tensor_integrated ['Total T_XX', 'Total T_XY', 'Total T_YY', 'Total T_XZ', 'Total T_YZ', 'Total T_ZZ']
    • For these three temperature tensor variables, change VAR_NOTES: "Calculated by integration over the measured phase space distribution. In despun pointing set (DPS) coordinates."
    • Remove temperature_tensor_label, but okay to use it as the basis for the above (e.g. inherit)
    • tensor_id can remain as-is (also leave references to it as-is)

Related tickets

No response

Metadata

Metadata

Labels

Data Release 1Deadline: June 15, 2026Ins: SWAPIRelated to the SWAPI instrumentIns: SWERelated to the SWE instrumentenhancementNew feature or request

Fields

No fields configured for Feature.

Projects

Status
Blocked

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions