py_eddy_tracker.featured_tracking.area_tracker.AreaTracker¶
- class py_eddy_tracker.featured_tracking.area_tracker.AreaTracker(*args, cmin=0.2, **kwargs)[source]¶
Bases:
EddiesObservations
Area Tracker will used overlap to track eddy.
This tracking will used
match()
method to get a similarity index, which could be between [0:1]. You could setup this class with cmin option to set a minimal value to valid an association.Methods
add_fields
Add a new field.
add_rotation_type
align_on
Align the variable indices of two datasets.
append
Merge.
basic_formula_ellipse_major_axis
Give major axis in km with a given latitude
bins_stat
- param str,array xname:
variable to compute stats on
box_display
Return values evenly spaced with few numbers
build_var_list
circle_contour
Set contours as circles from radius and center data.
coherence
Check coherence between two datasets.
compare_units
concatenate
contains
Return index of contour containing (x,y)
copy
copy_data_to_zarr
Copy with buffer for zarr.
cost_function
Return the cost function between two obs.
cost_function_common_area
How does it work on x bound ?
create_particles
Create particles inside contour (Default : speed contour).
create_variable
create_variable_zarr
display
Plot the speed and effective (dashed) contour of the eddies
display_color
Plot colored contour of eddies
distance
Use haversine distance for distance matrix between every self and other eddies.
empty_dataset
extract_with_area
Extract geographically with a bounding box.
extract_with_mask
Extract a subset of observations.
field_table
Produce description table of the fields available in this object
filled
- param matplotlib.axes.Axes ax:
matplotlib axe used to draw
first_obs
Get first obs of each trajectory.
fixed_ellipsoid_mask
format_label
from_array
from_netcdf
from_zarr
get_color
Return colors as a cyclic list
get_filters_zarr
Get filters to store in zarr for known variable
get_infos
grid_box_stat
Get percentile of eddies in each bin
grid_count
Count the eddies in each bin (use all pixels in each contour)
grid_stat
Return the mean of the eddies' variable in each bin
hist
Build histograms.
index
Return obs from self at the index.
insert_observations
Insert other obs in self at the given index.
inside
True for each point inside the effective contour of an eddy
intern
interp_grid
Interpolate a grid on a center or contour with mean, min or max method
is_convex
Get flag of the eddy's convexity
iter_on
Yield observation group for each bin.
last_obs
Get Last obs of each trajectory.
load_file
Load the netcdf or the zarr file.
load_from_netcdf
Load data from netcdf.
load_from_zarr
Load data from zarr.
mask_from_polygons
Return mask for all observations in one of polygons list
mask_function
match
Return index and score computed on the effective contour.
Merge two datasets.
merge_filters
Compute an intersection between all filters after to evaluate each of them
netcdf_create_dimensions
new_like
obs_dimension
parse_varname
post_process_link
Fill virtual obs (C).
re_reference_index
Shift index with ref
remove_fields
Copy with fields listed remove
reset
scatter
Scatter data.
set_global_attr_netcdf
set_global_attr_zarr
shifted_ellipsoid_degrees_mask
solve_conflict
solve_first
solve_function
solve_simultaneous
Deduce link from cost matrix.
time_sub_sample
Time sub sampling
to_netcdf
to_zarr
Core method to track
write_file
Write a netcdf or zarr with eddy obs.
zarr_dimension
Attributes
COLORS
ELEMENTS
NB_COLORS
array_variables
dtype
Return dtype to build numpy array.
elements
Return all the names of the variables.
fields
global_attr
nb_days
Return period in days covered by the dataset
obs
Return observations.
observations
only_variables
period
Give the time coverage.
period_
raw_data
shape
sign_legend
sign_type
time_datetime64
track_array_variables
track_extra_variables
tracks
- cmin¶