DmpScheme

class DmpScheme

Bases: MappingScheme

Implements the translation from and to the flagging scheme implemented in the UFZ - Datamanagementportal

Attributes Summary

ARGUMENTS
DFILTER_DEFAULT

Methods Summary

__call__(flag)	Translate a scalar 'external flag' to an 'internal flag'
toExternal(flags[, attrs])	Translate from 'internal flags' to 'external flags'
toHistory(flags)	Translate a single field of external Flags to a History
toInternal(flags)	Translate from 'external flags' to 'internal flags'
validityCheck(flags)	Check wether the given causes and comments are valid.

Attributes Documentation

ARGUMENTS = {'cause': 'OTHER', 'comment': ''}

DFILTER_DEFAULT = 1

Methods Documentation

__call__(flag)

Translate a scalar ‘external flag’ to an ‘internal flag’

Parameters:

flag (float, int, str) – The external flag to translate

Return type:

float

toExternal(flags, attrs=None, **kwargs)

Translate from ‘internal flags’ to ‘external flags’

Parameters:

• flags (The external flags to translate) –

• attrs (dict or None, default None) – global meta information of saqc-object

Return type:

translated flags

toHistory(flags)

Translate a single field of external Flags to a History

toInternal(flags)

Translate from ‘external flags’ to ‘internal flags’

Parameters:

df (pd.DataFrame) – The external flags to translate

Return type:

Flags object

classmethod validityCheck(flags)

Check wether the given causes and comments are valid.

Parameters:

df (external flags) –

Return type:

None