py_eddy_tracker.dataset.grid.UnRegularGridDataset¶

class py_eddy_tracker.dataset.grid.UnRegularGridDataset(filename, x_name, y_name, centered=None, indexs=None, unset=False, nan_masking=False)[source]¶

Bases: GridDataset

Class managing unregular grid

Parameters:

filename (str) – Filename to load
x_name (str) – Name of longitude coordinates
y_name (str) – Name of latitude coordinates
centered (bool,None) – Allow to know how coordinates could be used with pixel
indexs (dict) – A dictionary that sets indexes to use for non-coordinate dimensions
unset (bool) – Set to True to create an empty grid object without file
nan_masking (bool) – Set to True to replace data.mask with isnan method result

Methods

`add_grid`	Add a grid in handler
`bbox_indice`
`c_to_bounds`	Centered coordinates to bounds coordinates
`clean`
`compute_pixel_path`
`copy`	Duplicate the variable from grid_in in grid_out
`eddy_identification`	Compute eddy identification on the specified grid
`get_amplitude`
`get_mask`
`get_pixels_in`
`get_uavg`	Compute geostrophic speed around successive contours Returns the average
`grid`	Give the grid required
`grid_tiles`	Give the grid tiles required, without buffer system
`high_filter`	Return the high-pass filtered grid, by substracting to the initial grid the low-pass filtered grid (default: order=1)
`init_pos_interpolator`
`init_speed_coef`
`is_circular`	Check grid circularity
`load`	Load variable (data)
`load_general_features`	Load attrs to be stored in object
`low_filter`	Return the low-pass filtered grid (default: order=1)
`nearest_grd_indice`
`normalize_x_indice`	Not do
`populate`
`setup_coordinates`
`speed_coef_mean`
`units`	Get unit from variable
`write`	Write dataset output with same format as input

Attributes

`index_interp`
`EARTH_RADIUS`
`GRAVITY`
`N`
`bounds`	Give bounds
`centered`
`contours`
`coordinates`
`dimensions`
`filename`
`global_attrs`
`indexs`
`is_centered`	Give True if pixel is described with its center's position or a corner
`nan_mask`
`variables`
`variables_description`
`vars`
`x_bounds`
`x_c`
`x_dim`
`y_bounds`
`y_c`
`y_dim`

bbox_indice(vertices)[source]¶

property bounds¶: Give bounds

compute_pixel_path(x0, y0, x1, y1)[source]¶

get_pixels_in(contour)[source]¶

index_interp¶

init_pos_interpolator()[source]¶

init_speed_coef(uname='u', vname='v')[source]¶

load()[source]¶: Load variable (data)

nearest_grd_indice(x, y)[source]¶

normalize_x_indice(indices)[source]¶: Not do

speed_coef_mean(contour)[source]¶