oceanspy.subsample.particle_properties

oceanspy.subsample.particle_properties(od, times, Ypart, Xpart, Zpart, **kwargs)[source]

Extract Eulerian properties of particles using nearest-neighbor interpolation.

Parameters
od: OceanDataset

od that will be subsampled.

times: 1D array_like or scalar

time of particles.

Ypart: 2D array_like or 1D array_like if times is scalar

Y coordinates of particles. Dimensions order: (time, particle).

Xpart: 2D array_like or 1D array_like if times is scalar

X coordinates of particles. Dimensions order: (time, particle).

Zpart: 2D array_like or 1D array_like if times is scalar

Z of particles. Dimensions order: (time, particle).

**kwargs:

Keyword arguments for oceanspy.subsample.cutout().

Returns
od: OceanDataset

Subsampled oceandataset.