eradiate.scenes.atmosphere.PlaneParallelGeometry#

class eradiate.scenes.atmosphere.PlaneParallelGeometry(width=AUTO)[source]#

Bases: eradiate.scenes.atmosphere._core.AtmosphereGeometry

Plane parallel geometry.

A plane parallel atmosphere is translation-invariant in the X and Y directions. However, Eradiate represents it with a finite 3D geometry consisting of a cuboid. By default, the cuboid’s size is computed automatically; however, it can also be forced by assigning a value to the width field.

Parameters: width (quantity or float, default: AUTO) – Cuboid shape width.
Fields: width (quantity or AUTO) – Cuboid shape width.

classmethod convert(value)#

Attempt conversion of a value to a AtmosphereGeometry subtype.

Parameters: value – Value to attempt conversion of. If a dictionary is passed, its "type" key is used to route its other entries as keyword arguments to the appropriate subtype’s constructor. If a string is passed, this method calls itself with the parameter {"type": value}.
Returns: result – If value is a dictionary, the constructed AtmosphereGeometry instance is returned. Otherwise, value is returned.
Raises: ValueError – A dictionary was passed but the requested type is unknown.