get_vortex_edges#
- sunkit_image.asda.get_vortex_edges(gamma, rmin=4, gamma_min=0.89, factor=1)[source]#
Find all swirls from
gamma1
, andgamma2
.- Parameters:
gamma (
tuple
) – A tuple in form of(gamma1, gamma2)
, wheregamma1
is useful in finding vortex centers andgamma2
is useful in finding vortex edges.rmin (
int
, optional) – Minimum radius of swirls, all swirls with radius less thanrmin
will be rejected. Defaults to 4.gamma_min (
float
, optional) – Minimum value ofgamma1
, all potential swirls with peakgamma1
values less thangamma_min
will be rejected.factor (
int
, optional) – Magnify the original data to find sub-grid vortex center and boundary. Default value is 1.
- Returns:
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.