add_swirl#

radiosim.mojave.add_swirl(jet: ndarray, rng: Generator, first_jet_params: tuple | None = None) tuple[ndarray, tuple][source]#

Add swirl distortion to the jet.

Parameters:
jetarray_like

generated jet

rngGenerator

numpy random generator

first_jet_paramstuple | None, default: None

Use when generate two jet sources. Tuple of parameters to generate similar swirl for second jet. Contains the returned parameters from the first jet.

Returns:
swirled_jetarray_like

swirl distorted input jet

parameterstuple

parameters of the aplied swirl distortion