cherab.imas.emitter.load_radiation_emitter¶

cherab.imas.emitter.load_radiation_emitter(*args, time: float = 0, occurrence: int = 0, process_index: int | None = None, ion_index: int = 0, emissivity_index: int = 0, grid_ggd: IDSStructure | None = None, grid_subset_id: int | str = 5, num_toroidal: int | None = None, phis: ndarray | None = None, source: 'auto' | 'values' | 'coefficients' = 'auto', step: float = 0.01, parent: _NodeBase | None = None, time_threshold: float = inf, interpolator_cache: 'none' | 'memory' | 'disk' = 'memory', interpolator_cache_dir: str | Path | None = None, **kwargs) → Subtract | CylinderSource¶

Load radiation emissivity and create a single radiation emitter primitive.

The grid interpolator handles cache lookup and persistence internally.

Parameters:

*args¶

Positional arguments passed to imas.DBEntry.

time: float = 0¶

Time slice to load from the IDS, by default 0.

occurrence: int = 0¶

Occurrence of the radiation IDS to load, by default 0.

process_index: int | None = None¶

Index of the radiation process to load, by default None (loads the first process).

ion_index: int = 0¶

Index of the ion species to load, by default 0.

emissivity_index: int = 0¶

Index of the emissivity data to load, by default 0.

grid_ggd: IDSStructure | None = None¶

Alternative grid GGD structure to use if the radiation IDS grid is empty, by default None.

grid_subset_id: int | str = 5¶

ID or name of the grid subset to use, by default 5 ("Cells").

num_toroidal: int | None = None¶

Number of toroidal subdivisions for 3D grid extension, by default None. This is used only when the grid is loaded by load_unstruct_grid_2d_extended.

phis: ndarray | None = None¶

Array of toroidal angles in degrees for emissivity reconstruction, by default None. This is used only when the grid is loaded by load_unstruct_grid_2d_extended.

source: 'auto' | 'values' | 'coefficients' = 'auto'¶

Source for emissivity data: "auto" (tries values then coefficients), "values" (emissivity values), or "coefficients" (reconstruct from Fourier-Bezier coefficients), by default "auto".

step: float = 0.01¶

Step size for the radiation function interpolator, by default 0.01 m.

parent: _NodeBase | None = None¶

Parent node in the Raysect scenegraph, by default None.

time_threshold: float = inf¶

Maximum allowed time difference when loading from IDS, by default inf.

interpolator_cache: 'none' | 'memory' | 'disk' = 'memory'¶

Interpolator cache strategy, by default "memory". Each strategy is described in the InterpolatorCacheMode type alias.

interpolator_cache_dir: str | Path | None = None¶

Directory used when interpolator_cache="disk", by default None (uses the system cache directory, e.g., ~/.cache/cherab/imas/interpolators).

**kwargs¶

Additional keyword arguments passed to imas.DBEntry.

Returns:

Subtract or Cylinder – Cylindrical emitter primitive with RadiationFunction material.

Raises:

RuntimeError – If the radiation IDS or its emissivity data cannot be loaded.