Source code for rsrtx.Implementations.Calculate.Math.Fft.Frame.Coverage

from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CoverageCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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

[docs] def get(self, math=repcap.Math.Default) -> float: """ ``CALCulate:MATH<*>:FFT:FRAMe:COVerage`` \n Snippet: ``value: float = driver.calculate.math.fft.frame.coverage.get(math = repcap.Math.Default)`` \n Due to the restriction of the number of frames (see method ``RsRtx.calculate.math.fft.frame.maxCount.set()`` ) , the waveform may only be analyzed partially. This command queries the percentage of the trace that was analyzed, i.e. which part of the trace was included in the frame calculation. :param math: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Math') :return: frame_coverage: 0 to 100 """ 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:FRAMe:COVerage?') return Conversions.str_to_float(response)