oceanspy.subsample.mooring_array

oceanspy.subsample.mooring_array(od, Ymoor, Xmoor, xoak_index='scipy_kdtree', **kwargs)

Extract a mooring array section following the grid. Trajectories are great circle paths if coordinates are spherical.

Parameters:

od: OceanDataset

od that will be subsampled.

Ymoor: 1D array_like, scalar

Y coordinates of moorings.

Xmoor: 1D array_like, scalar

X coordinates of moorings.

xoak_index: str

xoak index to be used. scipy_kdtree by default.

**kwargs:

Keyword arguments for oceanspy.subsample.cutout().

Returns:

od: OceanDataset

Subsampled oceandataset.