hydro.exchange.flags ==================== .. py:module:: hydro.exchange.flags .. autoapi-nested-parse:: A Collection of Flag Schemes. Classes ------- .. autoapisummary:: hydro.exchange.flags.ExchangeFlag hydro.exchange.flags.ExchangeBottleFlag hydro.exchange.flags.ExchangeSampleFlag hydro.exchange.flags.ExchangeCTDFlag Module Contents --------------- .. py:class:: ExchangeFlag(flag) Bases: :py:obj:`enum.IntEnum` Enum where members are also (and must be) ints .. py:attribute:: flag .. py:property:: definition .. py:property:: cf_def .. py:property:: has_value .. py:class:: ExchangeBottleFlag(flag) Bases: :py:obj:`ExchangeFlag` Enum representing a WHP Bottle flag. This flag represents information about the sampling device itself (i.e. the niskin bottle). It should only be used for "BTLNBR_FLAG_W" values and should never be used with CTD files. .. py:attribute:: NOFLAG :value: 0 .. py:attribute:: NO_INFO :value: 1 .. py:attribute:: GOOD :value: 2 .. py:attribute:: LEAKING :value: 3 .. py:attribute:: BAD_TRIP :value: 4 .. py:attribute:: NOT_REPORTED :value: 5 .. py:attribute:: DISCREPANCY :value: 6 .. py:attribute:: UNKNOWN :value: 7 .. py:attribute:: PAIR :value: 8 .. py:attribute:: NOT_SAMPLED :value: 9 .. py:property:: _no_data_flags .. py:property:: _flag_definitions .. py:class:: ExchangeSampleFlag(flag) Bases: :py:obj:`ExchangeFlag` Enum where members are also (and must be) ints .. py:attribute:: NOFLAG :value: 0 .. py:attribute:: MISSING :value: 1 .. py:attribute:: GOOD :value: 2 .. py:attribute:: QUESTIONABLE :value: 3 .. py:attribute:: BAD :value: 4 .. py:attribute:: NOT_REPORTED :value: 5 .. py:attribute:: MEAN :value: 6 .. py:attribute:: CHROMA_MANUAL :value: 7 .. py:attribute:: CHROMA_IRREGULAR :value: 8 .. py:attribute:: NOT_SAMPLED :value: 9 .. py:property:: _no_data_flags .. py:property:: _flag_definitions .. py:class:: ExchangeCTDFlag(flag) Bases: :py:obj:`ExchangeFlag` Enum where members are also (and must be) ints .. py:attribute:: NOFLAG :value: 0 .. py:attribute:: UNCALIBRATED :value: 1 .. py:attribute:: GOOD :value: 2 .. py:attribute:: QUESTIONABLE :value: 3 .. py:attribute:: BAD :value: 4 .. py:attribute:: NOT_REPORTED :value: 5 .. py:attribute:: INTERPOLATED :value: 6 .. py:attribute:: DESPIKED :value: 7 .. py:attribute:: NOT_SAMPLED :value: 9 .. py:property:: _no_data_flags .. py:property:: _flag_definitions