cherab.imas.observer.load_bolometers¶

cherab.imas.observer.load_bolometers(backend_id: int, db_name: str, pulse: int, run: int, user_name: str | None = None, data_version: str | None = None, *, parent: _NodeBase | None = None, shot: int | None = None, dd_version: str | None = None, xml_path: str | None = None) → list[BolometerCamera]Source¶

cherab.imas.observer.load_bolometers(uri: str, mode: str, *, parent: _NodeBase | None = None, dd_version: str | None = None, xml_path: str | None = None) → list[BolometerCamera]

Load bolometer cameras from IMAS bolometer IDS.

Note

This function requires the Data dictionary v4.1.0 or later.

Parameters:

*args

Arguments passed to DBEntry.

parent: _NodeBase | None = None¶

The parent node of BolometerCamera in the Raysect scene-graph, by default None.

**kwargs

Keyword arguments passed to DBEntry constructor.

Returns:

List of BolometerCamera objects.

Return type:

list[BolometerCamera]

Examples

>>> from raysect.optical import World
>>> world = World()

If you have a local IMAS database and store the “bolometer.h5” file there:

>>> bolometers = load_bolometers("imas:hdf5?path=path/to/db/", "r", parent=world)

If you want to load netCDF files directly:

>>> bolometers = load_bolometers("path/to/bolometer_file.nc", "r", parent=world)