Source code for RsFsw.Implementations.Calculate.Spectrogram.Color

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 ColorCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("color", core, parent)

[docs] def set(self, color_scheme: enums.ColorSchemeA, window=repcap.Window.Default) -> None: """ ``CALCulate<n>:SPECtrogram:COLor`` \n Snippet: ``driver.calculate.spectrogram.color.set(color_scheme = enums.ColorSchemeA.COLD, window = repcap.Window.Default)`` \n Selects the color scheme. For details see 'Color maps'. :param color_scheme: HOT Uses a color range from blue to red. Blue colors indicate low levels, red colors indicate high ones. COLD Uses a color range from red to blue. Red colors indicate low levels, blue colors indicate high ones. RADar Uses a color range from black over green to light turquoise with shades of green in between. GRAYscale Shows the results in shades of gray. :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') """ param = Conversions.enum_scalar_to_str(color_scheme, enums.ColorSchemeA) window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) self._core.io.write(f'CALCulate{window_cmd_val}:SPECtrogram:COLor {param}')
# noinspection PyTypeChecker
[docs] def get(self, window=repcap.Window.Default) -> enums.ColorSchemeA: """ ``CALCulate<n>:SPECtrogram:COLor`` \n Snippet: ``value: enums.ColorSchemeA = driver.calculate.spectrogram.color.get(window = repcap.Window.Default)`` \n Selects the color scheme. For details see 'Color maps'. :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :return: color_scheme: HOT Uses a color range from blue to red. Blue colors indicate low levels, red colors indicate high ones. COLD Uses a color range from red to blue. Red colors indicate low levels, blue colors indicate high ones. RADar Uses a color range from black over green to light turquoise with shades of green in between. GRAYscale Shows the results in shades of gray. """ window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) response = self._core.io.query_str(f'CALCulate{window_cmd_val}:SPECtrogram:COLor?') return Conversions.str_to_scalar_enum(response, enums.ColorSchemeA)