get_vortex_properties#

sunkit_image.asda.get_vortex_properties(vx, vy, edge_prop, image=None)[source]#

Calculate expanding, rotational speed, equivalent radius and average intensity of given swirls.

Parameters:

vx (numpy.ndarray) – Velocity field in the x direction.
vy (numpy.ndarray) – Velocity field in the y direction.
edge_prop (dict) – The keys and their meanings of the dictionary are: center : Center locations of vortices, in the form of [x, y]. edge : Edge locations of vortices, in the form of [x, y]. points : All points within vortices, in the form of [x, y]. peak : Maximum/minimum gamma1 values in vortices. radius : Equivalent radius of vortices. All results are in pixel coordinates.
image (numpy.ndarray) – Has to have the same shape as vx observational image, which will be used to calculate the average observational values of all swirls.

Returns:

tuple – The returned tuple has four components, which are:

ve : expanding speed, in the same unit as vx or vy. vr : rotational speed, in the same unit as vx or vy. vc : velocity of the center, in the form of [vx, vy]. ia : average of the observational values within the vortices if the parameter image is given.