IMTreatment.vortex_criterions.FTLE.ftle module

class IMTreatment.vortex_criterions.FTLE.ftle.FTLE(vf, interp='linear')

Bases: object

generate_point_field(res)

Generate a point field on the vector field.

Parameters:res (number or 2x1 tuple of numbers) – Resolution. If a single number, resolution is applied on both axis, if a tuple, separated resolutions are applied on x and y axis.

get_FTLE(res, dt, rel_err=1e-05, dampl=0.5)

Parameters:

• res (number or 2x1 tuple of numbers) – Resolution. If a single number, resolution is applied on both axis, if a tuple, separated resolutions are applied on x and y axis.
• dt (number) – displacement time interval (can be negative for backward FTLE)
• rel_err (number) – relative maximum error for rk4 algorithm
• dampl (number) – Between 0 and 1, dampling for rk45 algorithm

get_displaced_point_field(res, dt, rel_err=1e-05, dampl=0.5)

Parameters:

• res (number or 2x1 tuple of numbers) – Resolution. If a single number, resolution is applied on both axis, if a tuple, separated resolutions are applied on x and y axis.
• dt (number) – displacement time interval
• rel_err (number) – relative maximum error for rk4 algorithm
• dampl (number) – Between 0 and 1, dampling for rk45 algorithm

get_pts_displacement(xy, dt, rel_err=1e-05, dampl=0.5)

Return the lagrangien displacement of a particule initialy at the position xy. Use Runge-Kutta algorithm with Fehlberg adaptative time step (RKF45).

Parameters:

• xy (2x1 tuple of number) – Point initial position
• dt (number) – displacement time interval
• rel_err (number) – relative maximum error for rk4 algorithm
• dampl (number) – Between 0 and 1, dampling for rk45 algorithm