Types

dexter.types

Type Aliases used thoughout the package.

Type Aliases:

• Interp1DType –

  Availiable 1D Interpolation types (case-insensitive).

• Interp2DType –

  Availiable 2D Interpolation types (case-insensitive).

• NDArrayShape –

  Shape of a numpy array.

• NDArray1D –

  1D numpy array.

• NDArray2D –

  2D numpy array.

• PoincareSection –

  The \(\theta=const\) or \(\zeta=const\) section on which to calculate orbit intersections.

• CalculatedFrequency –

  Possibly missing value for a particle's calculated \(\omega_\theta\), \(\omega_\zeta\) or \(q_{kinetic}\).

dexter.types.Interp1DType: TypeAlias = Literal['linear', 'cubic', 'cubic periodic', 'akima', 'akima periodic', 'steffen'] module-attribute

dexter.types.Interp2DType: TypeAlias = Literal['bilinear', 'bicubic'] module-attribute

dexter.types.NDArrayShape: TypeAlias = tuple[int, ...] module-attribute

dexter.types.NDArray1D: TypeAlias = np.ndarray[tuple[int], np.dtype[np.float64]] module-attribute

dexter.types.NDArray2D: TypeAlias = np.ndarray[tuple[int, int], np.dtype[np.float64]] module-attribute

dexter.types.PoincareSection: TypeAlias = Literal['ConstTheta', 'ConstZeta'] module-attribute

dexter.types.CalculatedFrequency: TypeAlias = float | None module-attribute