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
andy_range
.- Parameters:
gamma (
float
, optional) – A replacement forvmax
and only used if bothgamma
andrcore
are notNone
. Defaults toNone
.rcore (
float
, optional) – A replacement forrmax
and only used if bothgamma
andrcore
are notNone
. Defaults toNone
.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
andy_range
will be ignored. Defaults to None``.y (
numpy.meshgrid
, optional) – If both are given,x_range
andy_range
will be ignored. Defaults to None``.
- Returns:
tuple
– The generated velocity field(vx, vy)
.