cherab.imas.plasma.load_magnetic_field¶

cherab.imas.plasma.load_magnetic_field(*args, time: float = 0, occurrence: int = 0, time_threshold: float = inf, **kwargs) → FloatToVector3DFunction2DSource¶

Load the magnetic field from the equilibrium IDS and returns a VectorFunction2D interpolator.

Parameters:

*args¶

Arguments passed to DBEntry.

time: float = 0¶

Time for the equilibrium, by default 0.

occurrence: int = 0¶

Occurrence index of the equilibrium IDS, by default 0.

time_threshold: float = inf¶

Maximum allowed difference between the requested time and the nearest available time, by default numpy.inf.

**kwargs¶

Keyword arguments passed to DBEntry.

Returns:

The magnetic field interpolator.

Return type:

Function2D

Raises:

RuntimeError – If the equilibrium IDS does not have a time slice.