jaxrts.models.PeakCollection.__init__

PeakCollection.__init__(k_pos: Quantity, intensity: Array, peak_function: Callable[[Quantity], Array])

Parameters:

• k_pos (Quantity) – The position of the peaks in \(k\) space.

• intensity (jnp.ndarray) – The intensity of the peaks. Should have the same length as k_pos.

• peak_function (Callable[[Quantity], jnp.ndarray]) –

  A function defining the shape of a peak. The function must:

  • Be normalized such that its integral over all \(k\) equals 1.

  • Be centered at zero in \(k\)-space.

  • Accept exactly one argument: a position in \(k\)-space.

  • Return an array with shape (n, n), where n is the number of ion species (jaxrts.PlasmaState.nions).