cherab.imas.observer.bolometer.load_bolometers¶

cherab.imas.observer.bolometer.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.bolometer.load_bolometers(uri: str, mode: 'r' | None = None, *, 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

IMAS URI, netCDF path, or legacy positional arguments for DBEntry. For a URI or path, read mode is selected automatically; do not pass "r".

parent: _NodeBase | None = None¶

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

**kwargs

Additional DBEntry options, such as dd_version or xml_path.

Returns:

list[BolometerCamera] – List of BolometerCamera objects.

Raises:

• ValueError – If slit data is required for a pinhole camera but not provided.

• NotImplementedError – If an unsupported camera type or geometry type is encountered.

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/", parent=world)

If you want to load netCDF files directly:

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