Skip to content
Snippets Groups Projects
Commit 8a0ba2c8 authored by Peter Lünenschloß's avatar Peter Lünenschloß
Browse files

some saqc constants doc

parent 637cabee
No related branches found
No related tags found
7 merge requests!685Release 2.4,!684Release 2.4,!567Release 2.2.1,!566Release 2.2,!501Release 2.1,!372fix doctest snippets,!369Current documentation
Pipeline #27285 passed with stages
in 2 minutes and 46 seconds
#! /usr/bin/env python
# -*- coding: utf-8 -*-
"""The system for automated quality controll package."""
__version__ = "1.4"
......
#!/usr/bin/env python
"""
The module comprises flag value constants in use throughout saqc.
The constants order as follows (from "worse" to "best"):
:py:const:`~saqc.constants.BAD` > :py:const:`~saqc.constants.DOUBTFUL` > :py:const:`~saqc.constants.GOOD` >
:py:const:`~saqc.constants.UNFLAGGED` (> :py:const:`~saqc.constants.UNTOUCHED`)
"""
__all__ = [
"UNTOUCHED",
......@@ -11,11 +18,25 @@ __all__ = [
import numpy as np
#: Internal :py:mod:`flag level constant <saqc.constants>`.
#: When returned by a test, it indicates, that the test did not consider to flag the respective value
UNTOUCHED = np.nan
#: A :py:mod:`flag level constant <saqc.constants>`
#: , evaluating to the level, that indicates, no flag has been assigned to yet.
UNFLAGGED = -np.inf
#: A :py:mod:`flag level constant <saqc.constants>`
#: , evaluating to the lowest level level of flagging, that is
#: not :py:const:`UNFLAGGED <saqc.constants.UNFLAGGED>`.
GOOD = 0
#: A :py:mod:`flag level constant <saqc.constants>`
#: , evaluating to a somewhat modest flag level.
DOUBTFUL = 25.0
#: A :py:mod:`flag level constant <saqc.constants>`
#: , evaluating to the highest (internal) flag level available.
BAD = 255.0
# aliases
DOUBT = DOUBTFUL
DOUBT = DOUBTFUL #: Alias for :py:const:`DOUBTFUL <saqc.constants.DOUBTFUL>`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment