imas_paraview.ids_util.get_arrays_from_ids

imas_paraview.ids_util.get_arrays_from_ids(ids, ggd_idx=None, get_empty_arrays=False, scalar_array_paths=None, vector_array_paths=None, create_empty_structs=False)

Fetches GGD scalar and vector arrays that reside in the IDS. If lists of IDSPaths of GGD arrays are provided through scalar_array_paths or vector_array_paths, only these will be loaded. If either of them is not provided, instead all GGD arrays in the IDS will be returned.

Parameters:
ids

The IDS from which to fetch GGD arrays

ggd_idx=None

The GGD time step to load. Defaults to None, which corresponds with loading all timesteps.

get_empty_arrays : bool

Whether to return empty GGD arrays

scalar_array_paths=None

A list of IDSPaths of GGD scalar arrays to search through.

vector_array_paths=None

A list of IDSPaths of GGD vector arrays to search through.

create_empty_structs=False

If this flag is enabled and an empty structure is encountered through which has to be traversed to reach a GGD array, said structure is resized to have length 1.

Returns:

A tuple with two elements.

  • scalar_array_list: The GGD scalar arrays (real & complex)

  • vector_array_list: The GGD vector arrays (normal & rphiz)


Last update: 2026-03-11