cherab.nagdis.inversion.raytransfer.create_raytransfer_cylinder¶

cherab.nagdis.inversion.raytransfer.create_raytransfer_cylinder(parent: _NodeBase, radius: float = 0.04, z_max: float = 0.66, z_min: float = -0.5, dr: float = 0.0015, dp: float = 2.0, dz: float = 0.02, step: float | None = None) → RayTransferCylinderSource¶

Create a RayTransferCylinder object with the given parameters.

The z axis is aligned with the linear device magnetic axis.

Parameters:

parent: _NodeBase¶

Parent node of the RayTransferCylinder object.

radius: float = 0.04¶

Radius of the cylinder, by default 40.0 mm.

z_max: float = 0.66¶

Maximum z-coordinate of the cylinder, by default 0.66 m.

z_min: float = -0.5¶

Minimum z-coordinate of the cylinder, by default -0.5 m.

dr: float = 0.0015¶

Radial step size, by default 1.5 mm.

dp: float = 2.0¶

Polar step size, by default 2.0 degree.

dz: float = 0.02¶

Axial step size, by default 20 mm.

step: float | None = None¶

Step size for the ray-transfer calculation, by default None. If None, the step size is set to 10% of the minimum of dr, dz, and dr * dp.

Returns:

RayTransferCylinder – RayTransferCylinder object.

Raises:

• TypeError – If parent is not a scene-graph object.

• ValueError – If radius, z_max, z_min, dr, dp, dz, or step are invalid.

Examples

>>> from raysect.optical import World
>>> from cherab.nagdis.inversion.raytransfer import create_raytransfer_cylinder
>>> world = World()
>>> cylinder = create_raytransfer_cylinder(world)