Skip to content

check_goring_nikora_2002

Classes:

Name Description
CheckGoringNikora2002

The Goring & Nikora 2002 'despiking' method, with Wahl2003 correction.

Classes#

CheckGoringNikora2002 #

Bases: QualityChecker

The Goring & Nikora 2002 'despiking' method, with Wahl2003 correction. Returns a logical vector that is true where spikes are identified.

Classes:

Name Description
Parameters

Methods:

Name Description
run

Attributes:

Name Type Description
parameters Parameters

Attributes#

parameters class-attribute instance-attribute #
parameters: Parameters = Parameters()

Classes#

Parameters #

Bases: BaseModel

Attributes:

Name Type Description
n_points int

The number of points over which to perform the method.
Attributes#
n_points class-attribute instance-attribute # 
n_points: int = 5000

The number of points over which to perform the method.

Functions#

run #
run(
    dataset: Dataset, variable_name: str
) -> NDArray[np.bool_]
Source code in tsdat/qc/checkers/oceanography/check_goring_nikora_2002.py 
19
20
21
22
def run(self, dataset: xr.Dataset, variable_name: str) -> NDArray[np.bool_]:
    from mhkit.dolfyn.adv.clean import GN2002

    return GN2002(dataset[variable_name], npt=self.parameters.n_points)