dev_LagarangianStructuresFTLE2D#
Doc: Time series of Lagrangian Coherent Structures heat maps, calculated as Finite-Time Lyapunov exponents (FTLEs) at given lag times, see Haller, G., 2015. Lagrangian coherent structures. Annual review of fluid mechanics, 47, pp.137-162.’) Currently only 2D implemented
short class_name: dev_LagarangianStructuresFTLE2D
full class_name : oceantracker.integrated_model.lagraingian_structures_FTLE_2D.dev_LagarangianStructuresFTLE2D
Warning
Class is under development may not yet work in all cases, if errors contact developer
Inheritance: > ParameterBaseClass> _BaseIntegratedModel> dev_LagarangianStructuresFTLE2D
Parameters:#
backwards<class 'bool'><optional>Description: Do LCS backwards in time
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
class_name<class 'str'><optional>Description: Class name as string A.B.C, used to import this class from python path
default:
Nonedata_type:
<class 'str'>deprecated:
False
cols<class 'int'><optional>Description: Number of columns in grid (x direction)
default:
98data_type:
<class 'int'>deprecated:
Falsemin:
1max:
100000
end['str', 'float', 'datetime64', 'int', 'float64', 'float32']<optional>Description: end date of LSC releases. Model should run max(lags) beyond this send date to calculate LSC for last pulse of grid release. Must be an ISO date as string eg. “2017-01-01T00:30:00”
default:
Nonepossible_types:
[<class 'str'>, <class 'float'>, <class 'numpy.datetime64'>, <class 'int'>, <class 'numpy.float64'>, <class 'numpy.float32'>]deprecated:
Falseunits:
ISO8601 date as string eg. "2017-01-01T00:30:00",np.datetime64, or float of seconds since 1/1/1970
floating<class 'bool'><optional>Description: Do LCS for floating partyicles, in development currently only option
default:
Truedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
grid_center: still working on display of default params of type <class ‘oceantracker.util.parameter_checking.ParameterCoordsChecker’>
grid_size: <optional>Description: - deprecated: use parameters rows=??,cols=??
a list containing type:
[]default list :
Nonedata_type:
<class 'int'>deprecated:
Truemin:
1max:
100000possible_types:
[]make_list_unique:
Falsefixed_len:
2min_len:
0
grid_span: <optional>Description: - deprecated: use span_x=? and span_y=? params)
a list containing type:
[]default list :
Nonedata_type:
<class 'float'>deprecated:
Trueunits:
meters (dx,dy)possible_types:
[]make_list_unique:
Falsemin_len:
0
lags:<isrequired>Description: - List of one or more times after each pulse is released to calculate LCS.
a list containing type:
[]default list :
Nonedata_type:
<class 'float'>deprecated:
Falseunits:
secmin:
1possible_types:
[]make_list_unique:
Falsemin_len:
1
name<class 'str'><optional>Description: Name used to refer to class in code and output, = None for core claseses
default:
Nonedata_type:
<class 'str'>deprecated:
False
output_file_base<class 'str'><optional>Description: tag on output file
default:
LCSdata_type:
<class 'str'>deprecated:
False
release_interval<class 'float'><optional>Description: Time in seconds between grid releases of pulses of particles. For each pulse an LCS will be calculated at the given lag times. This creates a LCS time series for each lag at this time interval
default:
3600.0data_type:
<class 'float'>deprecated:
Falseunits:
secmin:
0.0
rows<class 'int'><optional>Description: Number of rows in grid (y direction)
default:
100data_type:
<class 'int'>deprecated:
Falsemin:
1max:
100000
span_x<class 'float'><optional>Description: Grid span in x direction
default:
100000.0data_type:
<class 'float'>deprecated:
Falseunits:
Units metres or degrees if hindcast is geographic coords
span_y<class 'float'><optional>Description: Grid span in y direction
default:
100000.0data_type:
<class 'float'>deprecated:
Falseunits:
Metres or degrees if hindcast in geographic coords
start['str', 'float', 'datetime64', 'int', 'float64', 'float32']<optional>Description: start date of LSC releases, Must be an ISO date as string eg. “2017-01-01T00:30:00”
default:
Nonepossible_types:
[<class 'str'>, <class 'float'>, <class 'numpy.datetime64'>, <class 'int'>, <class 'numpy.float64'>, <class 'numpy.float32'>]deprecated:
Falseunits:
ISO8601 date as string eg. "2017-01-01T00:30:00",np.datetime64, or float of seconds since 1/1/1970
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>deprecated:
False
write_intermediate_results<class 'bool'><optional>Description: write intermediate arrays, x_lag, strain_matrix. Useful for checking results
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
write_tracks<class 'bool'><optional>Description: Flag if “True” will write particle tracks to disk. This is off by default for LCS
default:
Falsedata_type:
<class 'bool'>deprecated:
Falsepossible_values:
[True, False]
z_max<class 'float'><optional>Description: Only allow particles to be below this vertical position
default:
Nonedata_type:
<class 'float'>deprecated:
Falseunits:
meters above mean water level, so is < 0 at depth
z_min<class 'float'><optional>Description: Only allow particles to be above this vertical position
default:
Nonedata_type:
<class 'float'>deprecated:
Falseunits:
meters above mean water level, so is < 0 at depth