imas_paraview.plugins.vtkggdreader.GGDReader¶

class imas_paraview.plugins.vtkggdreader.GGDReader(*args: Any, **kwargs: Any)¶

Bases: GGDBaseReader

ParaView plugin to view (spatial) GGD structures grids and associated data.

__init__()¶

Methods

GetAttributeArrayName(idx)	Retrieve the name of the attribute array at a specified index.
GetAttributeArrayStatus(*args)
GetNumberOfAttributeArrays()
GetTimestepValues()
P00_URISelectionMode(mode)	Select mode for locating the data entry: manually enter the URI, select a local HDF5/MDSplus file, or enter 'legacy' parameters.
P01_SetURI(uri)	The IMAS URI for the Data Entry to load.
P02_SetURIFromFileName(file)	Select a local file from the HDF5 or MDSplus backend.
P03_SetBackend(backend)	Select the IMAS backend that stores the data.
P04_SetDatabase(database)	Enter the Database name where the data is stored.
P05_SetPulse(pulse)	Pulse number.
P06_SetRun(run)	Run number.
P07_SetUser(user)	User name for the IMAS database.
P08_SetVersion(version)	Major version of the DD used to store the data.
P09_GetURIStatus()	Status information related to the URI.
P10_SetIDSAndOccurrence(value)	Select the IDS/occurrence to load.
P11_GetIDSList()	Return a list of IDSs with data inside the selected Data Entry.
P11_GetParentIndexVisible()
P11_GetParentIndices()	Return a list of parent indices, if applicable for the selected IDS.
P11_SetParentIndex(value)	Select structure index to extract the GGD grid from.
P12_SetAttributeArray(array, status)	Select all or a subset of available GGD arrays to load.
P13_SetShowEmpty(val)	Enable to show all possible attributes, even when they are empty.
P14_SetLazyLoading(val)	Turn on to preload the entire IDS beforehand, if this is left off, the data is loaded on-demand through lazy loading.
P20_SetNPlane(val)
P21_SetPhiRange(val, val2)
PG0_DataEntryGroup()	Dummy function to define a PropertyGroup.
PG1_IDSGroup()	Dummy function to define a PropertyGroup.
PG2_BezierGroup()	Dummy function to define a PropertyGroup.
RequestData(request, inInfo, outInfo)
RequestDataObject(request, inInfo, outInfo)
RequestInformation(request, inInfo, outInfo)
__init__()
get_heterogeneous_time_array()	Return the time array when the IDS uses heterogeneous time.
request_information()	Select which GGD arrays to show in the array domain selector, based on whether the "Show All" checkbox is enabled.
setup_ids()	Initializes plasma state reader and populates scalar and vector paths for the array selection domaindomain selection.

Attributes

is_time_dependent

GetAttributeArrayName(idx) → str¶

Retrieve the name of the attribute array at a specified index.

Parameters:

idx¶

The index of the attribute array.

Returns:

The name of the attribute array corresponding to the given index.

P00_URISelectionMode(mode)¶

Select mode for locating the data entry: manually enter the URI, select a local HDF5/MDSplus file, or enter 'legacy' parameters.

P01_SetURI(uri)¶

The IMAS URI for the Data Entry to load.

P02_SetURIFromFileName(file)¶

Select a local file from the HDF5 or MDSplus backend.

P03_SetBackend(backend)¶

Select the IMAS backend that stores the data.

P04_SetDatabase(database)¶

Enter the Database name where the data is stored.

P05_SetPulse(pulse)¶

Pulse number.

P06_SetRun(run)¶

Run number.

P07_SetUser(user)¶

User name for the IMAS database.

P08_SetVersion(version)¶

Major version of the DD used to store the data.

P09_GetURIStatus()¶

Status information related to the URI.

P10_SetIDSAndOccurrence(value)¶

Select the IDS/occurrence to load.

The dropdown is disabled when no Data Entry has been loaded (press Apply after selecting a URI to load the Data Entry), or when the loaded Data Entry contains no IDSs supported by this plugin.

P11_GetIDSList()¶

Return a list of IDSs with data inside the selected Data Entry.

P11_GetParentIndices()¶

Return a list of parent indices, if applicable for the selected IDS.

P11_SetParentIndex(value)¶

Select structure index to extract the GGD grid from. This is only applicable to some IDSs, such as 'wall'.

P12_SetAttributeArray(array, status)¶

Select all or a subset of available GGD arrays to load.

P13_SetShowEmpty(val)¶

Enable to show all possible attributes, even when they are empty. When disabled, only the the attributes in the selector window which are filled in the first time step are shown.

P14_SetLazyLoading(val)¶

Turn on to preload the entire IDS beforehand, if this is left off, the data is loaded on-demand through lazy loading. It is recommended to leave this off if you are only loading a small subset of the data. If you want to load most of the data, it is recommended to turn this on.

PG0_DataEntryGroup()¶

Dummy function to define a PropertyGroup.

PG1_IDSGroup()¶

Dummy function to define a PropertyGroup.

PG2_BezierGroup()¶

Dummy function to define a PropertyGroup.

get_heterogeneous_time_array()¶

Return the time array when the IDS uses heterogeneous time.

request_information()¶

Select which GGD arrays to show in the array domain selector, based on whether the "Show All" checkbox is enabled.

setup_ids()¶

Initializes plasma state reader and populates scalar and vector paths for the array selection domaindomain selection.