mod_filter module
- mod_filter.apply_bandpass_filter(ds, lambda_min=65.0, lambda_max=500.0)
Apply a bandpass filter to a dataset.
- Parameters:
ds (xarray.Dataset) – Input dataset containing relevant variables.
lambda_min (float, optional) – Minimum wavelength for the filter in kilometers, by default 65.
lambda_max (float, optional) – Maximum wavelength for the filter in kilometers, by default 500.
- Returns:
The filtered dataset with additional variables ‘msla_filtered’, ‘sla_filtered’, and ‘mapping_err_filtered’.
- Return type:
xarray.Dataset
- mod_filter.compute_median_dx(dataset)
Compute the median spacing between along-track measurements.
- Parameters:
dataset (xarray.Dataset) – Input dataset containing longitude and latitude coordinates.
- Returns:
The median spacing between along-track measurements in kilometers.
- Return type:
float
- mod_filter.distance(lon0, lat0, lon1, lat1)
Compute distance between two geographical locations.
- Parameters:
lon0 (float) – Longitude of first location.
lat0 (float) – Latitude of first location.
lon1 (float) – Longitude of second location.
lat1 (float) – Latitude of second location.
- Returns:
distance (in m)
- Return type:
array
- mod_filter.lanczos_filter(wave_length, x, z, order=1)
Apply a lanczos filter on z field
- Parameters:
wave_length (float) – half window where apply lanczos in x units
x (array) – must be growing for each track but could be irregular
z (array) – field to apply lanczos
- mod_filter.median_filter(half_window, x, z)
Apply a median filter on z field
- Parameters:
half_window (float) – half window where apply median
x (array) – must be growing for each track but could be irregular
z (array) – field to apply median