Source code for rsmxo.Implementations.Calculate.Spectrum.Overlap.Factor.Adjusted

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


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

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

[docs] def get(self, spectrum=repcap.Spectrum.Default) -> float: """ ``CALCulate:SPECtrum<*>:OVERlap:FACTor:ADJusted`` \n Snippet: ``value: float = driver.calculate.spectrum.overlap.factor.adjusted.get(spectrum = repcap.Spectrum.Default)`` \n Returns the adjusted overlap factor that is used for calculation. It is based on the given minimum overlap factor and the current settings. :param spectrum: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Spectrum') :return: adj_overlap_fact: 0 to 100 """ spectrum_cmd_val = self._cmd_group.get_repcap_cmd_value(spectrum, repcap.Spectrum) response = self._core.io.query_str(f'CALCulate:SPECtrum{spectrum_cmd_val}:OVERlap:FACTor:ADJusted?') return Conversions.str_to_float(response)