get_velocity_field#

sunkit_image.asda.get_velocity_field( gamma, rcore, ratio_vradial, x_range, y_range, x=None, y=None, )[source]#

Calculates the velocity field in a meshgrid generated with x_range and y_range.

Parameters:

gamma (float, optional) – A replacement for vmax and only used if both gamma and rcore are not None. Defaults to None.
rcore (float, optional) – A replacement for rmax and only used if both gamma and rcore are not None. Defaults to None.
ratio_vradial (float, optional) – Ratio between expanding/shrinking speed and rotating speed. Defaults to 0.
x_range (list) – Range of the x coordinates of the meshgrid.
y_range (list) – range of the y coordinates of the meshgrid.
x (numpy.meshgrid, optional) – If both are given, x_range and y_range will be ignored. Defaults to None``.
y (numpy.meshgrid, optional) – If both are given, x_range and y_range will be ignored. Defaults to None``.

Returns:

tuple – The generated velocity field (vx, vy).