ZOC class¶
Class performing zero-offset correction of depth
Class and Methods Summary¶
|
Perform ZOC with “offset” method |
|
Perform ZOC with “filter” method |
|
Apply zero offset correction to depth measurements |
-
class
zoc.
ZOC
(method=None, params=None, depth_zoc=None, filters=None)[source]¶ Perform zero offset correction
-
method
¶ Name of the ZOC method used.
- Type
str
-
params
¶ Dictionary with parameters used in the method.
- Type
dict
-
depth_zoc
¶ DataArray with corrected depth.
- Type
xarray.DataArray
-
filters
¶ DataFrame with output filters for method=”filter”
- Type
pandas.DataFrame
-
__call__
(depth, method='filter', **kwargs)[source]¶ Apply zero offset correction to depth measurements
- Parameters
method ({"filter", "offset"}) – Name of method to use for zero offset correction.
**kwargs (optional keyword arguments) – Passed to the chosen method (
offset_depth()
,filter_depth()
)
Notes
More details in diveMove’s
calibrateDepth
function.
-
__weakref__
¶ list of weak references to the object (if defined)
-
filter_depth
(depth, k, probs, depth_bounds=None, na_rm=True)[source]¶ Perform ZOC with “filter” method
- Parameters
depth (xarray.DataArray) – DataArray with observed depth measurements.
**kwargs (optional keyword arguments) – ‘filter’: (‘k’, ‘probs’, ‘depth_bounds’ (defaults to range), ‘na_rm’ (defaults to True)).
Notes
More details in diveMove’s
calibrateDepth
function.
-