PositionalScheme

class PositionalScheme

Bases: MappingScheme

Implements the translation from and to the flagging scheme implemented by CHS

Attributes Summary

ARGUMENTS
DFILTER_DEFAULT

Methods Summary

__call__(flag)	Translate a scalar 'external flag' to an 'internal flag'
toExternal(flags, **kwargs)	Translate from 'internal flags' to 'external flags'
toInternal(flags)	Translate from 'external flags' to 'internal flags'

Attributes Documentation

ARGUMENTS = {}

DFILTER_DEFAULT = 26.0

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, **kwargs)

Translate from ‘internal flags’ to ‘external flags’

Parameters:

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

Return type:

DictOfSeries

toInternal(flags)

Translate from ‘external flags’ to ‘internal flags’

Parameters:

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

Return type:

Flags object