from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CmodeCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cmode", core, parent)
[docs]
def set(self, clr_tbl_ent_sel_md: enums.MathSpectrogramCmode, math=repcap.Math.Default) -> None:
"""
``CALCulate:MATH<*>:FFT:SPECtrogram:CMODe`` \n
Snippet: ``driver.calculate.math.fft.spectrogram.cmode.set(clr_tbl_ent_sel_md = enums.MathSpectrogramCmode.AMPL, math = repcap.Math.Default)`` \n
Selects the color table mode for the frequency analysis display.
:param clr_tbl_ent_sel_md: INCI | AMPL \n
- INCI: (Incidence) The display color is set depending on the frequency of occurrence of a value.
- AMPL: (Amplitude) In the spectrogram and the frequency analysis display, the color is used to indicate the magnitude of the FFT signal. The higher the amplitude the higher the color in the assigned color table.
:param math: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Math')
"""
param = Conversions.enum_scalar_to_str(clr_tbl_ent_sel_md, enums.MathSpectrogramCmode)
math_cmd_val = self._cmd_group.get_repcap_cmd_value(math, repcap.Math)
self._core.io.write_with_opc(f'CALCulate:MATH{math_cmd_val}:FFT:SPECtrogram:CMODe {param}')
# noinspection PyTypeChecker
[docs]
def get(self, math=repcap.Math.Default) -> enums.MathSpectrogramCmode:
"""
``CALCulate:MATH<*>:FFT:SPECtrogram:CMODe`` \n
Snippet: ``value: enums.MathSpectrogramCmode = driver.calculate.math.fft.spectrogram.cmode.get(math = repcap.Math.Default)`` \n
Selects the color table mode for the frequency analysis display.
:param math: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Math')
"""
math_cmd_val = self._cmd_group.get_repcap_cmd_value(math, repcap.Math)
response = self._core.io.query_str_with_opc(f'CALCulate:MATH{math_cmd_val}:FFT:SPECtrogram:CMODe?')
return Conversions.str_to_scalar_enum(response, enums.MathSpectrogramCmode)