IqRecorder

SCPI Commands :

CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SRATe
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:BYPass
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:FORMat
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MUNit
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:USER
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:IQFile
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:INIFile

class IqRecorderCls

IqRecorder commands group definition. 27 total commands, 5 Subgroups, 11 group commands

get_bypass() → IqRecBypass

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:BYPass
value: enums.IqRecBypass = driver.configure.gprf.measurement.iqRecorder.get_bypass()

No command help available

return:

bypass: No help available

get_format_py() → IqFormat

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:FORMat
value: enums.IqFormat = driver.configure.gprf.measurement.iqRecorder.get_format_py()

Selects the coordinate system for the I/Q recorder results.

return:

format_py: IQ: Cartesian coordinates (I- and Q-axis) RPHI: polar coordinates (radius R and angle PHI)

get_ini_file() → str

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:INIFile
value: str = driver.configure.gprf.measurement.iqRecorder.get_ini_file()

No command help available

return:

ini_file: No help available

get_iq_file() → str

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:IQFile
value: str = driver.configure.gprf.measurement.iqRecorder.get_iq_file()

Selects a file for storage of the I/Q recorder results in binary format.

return:

iq_save_file: Name and path of the file. The extension *.iqw is appended automatically.

get_mode() → MeasurementMode

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE
value: enums.MeasurementMode = driver.configure.gprf.measurement.iqRecorder.get_mode()

No command help available

return:

measurement_mode: No help available

get_munit() → MagnitudeUnit

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MUNit
value: enums.MagnitudeUnit = driver.configure.gprf.measurement.iqRecorder.get_munit()

Selects the magnitude unit for the measurement results.

return:

magnitude_unit: Voltage units or raw I/Q data relative to full-scale.

get_ratio() → float

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio
value: float = driver.configure.gprf.measurement.iqRecorder.get_ratio()

Specifies a factor to reduce the sampling rate and to increase the measurement duration. The sampling rate resulting from the filter settings is multiplied with the specified ratio.

return:

ratio: No help available

get_symbol_rate() → float

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SRATe
value: float = driver.configure.gprf.measurement.iqRecorder.get_symbol_rate()

No command help available

return:

sample_rate: No help available

get_timeout() → float

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
value: float = driver.configure.gprf.measurement.iqRecorder.get_timeout()

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

return:

tcd_timeout: No help available

get_user() → UserDebugMode

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:USER
value: enums.UserDebugMode = driver.configure.gprf.measurement.iqRecorder.get_user()

No command help available

return:

user_mode: No help available

get_wt_file() → FileSave

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile
value: enums.FileSave = driver.configure.gprf.measurement.iqRecorder.get_wt_file()

Selects whether the results are written to a file, to the memory or both. For file selection, see method RsCMPX_Gprf. Configure.Gprf.Measurement.IqRecorder.iqFile.

return:

write_to_iq_file: OFF: The results are only stored in the memory. ON: The results are stored in the memory and in a file. ONLY: The results are only stored in a file.

set_bypass(bypass: IqRecBypass) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:BYPass
driver.configure.gprf.measurement.iqRecorder.set_bypass(bypass = enums.IqRecBypass.BIT)

No command help available

param bypass:

No help available

set_format_py(format_py: IqFormat) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:FORMat
driver.configure.gprf.measurement.iqRecorder.set_format_py(format_py = enums.IqFormat.IQ)

Selects the coordinate system for the I/Q recorder results.

param format_py:

IQ: Cartesian coordinates (I- and Q-axis) RPHI: polar coordinates (radius R and angle PHI)

set_ini_file(ini_file: str) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:INIFile
driver.configure.gprf.measurement.iqRecorder.set_ini_file(ini_file = 'abc')

No command help available

param ini_file:

No help available

set_iq_file(iq_save_file: str) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:IQFile
driver.configure.gprf.measurement.iqRecorder.set_iq_file(iq_save_file = 'abc')

Selects a file for storage of the I/Q recorder results in binary format.

param iq_save_file:

Name and path of the file. The extension *.iqw is appended automatically.

set_mode(measurement_mode: MeasurementMode) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE
driver.configure.gprf.measurement.iqRecorder.set_mode(measurement_mode = enums.MeasurementMode.NORMal)

No command help available

param measurement_mode:

No help available

set_munit(magnitude_unit: MagnitudeUnit) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MUNit
driver.configure.gprf.measurement.iqRecorder.set_munit(magnitude_unit = enums.MagnitudeUnit.RAW)

Selects the magnitude unit for the measurement results.

param magnitude_unit:

Voltage units or raw I/Q data relative to full-scale.

set_ratio(ratio: float) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio
driver.configure.gprf.measurement.iqRecorder.set_ratio(ratio = 1.0)

Specifies a factor to reduce the sampling rate and to increase the measurement duration. The sampling rate resulting from the filter settings is multiplied with the specified ratio.

param ratio:

No help available

set_symbol_rate(sample_rate: float) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SRATe
driver.configure.gprf.measurement.iqRecorder.set_symbol_rate(sample_rate = 1.0)

No command help available

param sample_rate:

No help available

set_timeout(tcd_timeout: float) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
driver.configure.gprf.measurement.iqRecorder.set_timeout(tcd_timeout = 1.0)

Defines a timeout for the measurement. The timer is started when the measurement is initiated via a READ or INIT command. It is not started if the measurement is initiated manually. When the measurement has completed the first measurement cycle (first single shot) , the statistical depth is reached and the timer is reset. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped. The measurement state changes to RDY. The reliability indicator is set to 1, indicating that a measurement timeout occurred. Still running READ, FETCh or CALCulate commands are completed, returning the available results. At least for some results, there are no values at all or the statistical depth has not been reached. A timeout of 0 s corresponds to an infinite measurement timeout.

param tcd_timeout:

No help available

set_user(user_mode: UserDebugMode) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:USER
driver.configure.gprf.measurement.iqRecorder.set_user(user_mode = enums.UserDebugMode.DEBug)

No command help available

param user_mode:

No help available

set_wt_file(write_to_iq_file: FileSave) → None

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile
driver.configure.gprf.measurement.iqRecorder.set_wt_file(write_to_iq_file = enums.FileSave.OFF)

Selects whether the results are written to a file, to the memory or both. For file selection, see method RsCMPX_Gprf. Configure.Gprf.Measurement.IqRecorder.iqFile.

param write_to_iq_file:

OFF: The results are only stored in the memory. ON: The results are stored in the memory and in a file. ONLY: The results are only stored in a file.

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.configure.gprf.measurement.iqRecorder.clone()

Subgroups

• Capture
• FilterPy
  • Bandpass
  • Gauss
• IqSettings
• ListPy
  • EnvelopePower
  • Frequency
  • Sstop
• Trigger