IqRecorder
SCPI Commands :
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio
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
- class IqRecorderCls[source]
IqRecorder commands group definition. 23 total commands, 4 Subgroups, 8 group commands
- get_format_py() IqFormat [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:FORMat value: enums.IqFormat = driver.configure.iqRecorder.get_format_py()
Selects the coordinate system for the I/Q recorder results.
- return:
format_py: IQ | RPHI IQ: cartesian coordinates (I and Q axis) RPHI: polar coordinates (radius R and angle PHI)
- get_iq_file() str [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:IQFile value: str = driver.configure.iqRecorder.get_iq_file()
Selects a file for storage of the I/Q recorder results in binary format.
- return:
iq_save_file: string Name and path of the file. The extension ‘*.iqw’ is appended automatically.
- get_mode() MeasurementMode [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE value: enums.MeasurementMode = driver.configure.iqRecorder.get_mode()
No command help available
- return:
measurement_mode: No help available
- get_munit() MagnitudeUnit [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MUNit value: enums.MagnitudeUnit = driver.configure.iqRecorder.get_munit()
Selects the magnitude unit for the measurement results.
- return:
magnitude_unit: VOLT | RAW Voltage units or raw I/Q data relative to full-scale.
- get_ratio() float [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio value: float = driver.configure.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: numeric
- get_timeout() float [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT value: float = driver.configure.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: numeric Unit: s
- get_user() UserDebugMode [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:USER value: enums.UserDebugMode = driver.configure.iqRecorder.get_user()
No command help available
- return:
user_mode: No help available
- get_wt_file() FileSave [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile value: enums.FileSave = driver.configure.iqRecorder.get_wt_file()
Selects whether the results are written to a file, to the memory or both. For file selection, see method RsCmwGprfMeas. Configure.IqRecorder.iqFile.
- return:
write_to_iq_file: OFF | ON | ONLY 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_format_py(format_py: IqFormat) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:FORMat driver.configure.iqRecorder.set_format_py(format_py = enums.IqFormat.IQ)
Selects the coordinate system for the I/Q recorder results.
- param format_py:
IQ | RPHI IQ: cartesian coordinates (I and Q axis) RPHI: polar coordinates (radius R and angle PHI)
- set_iq_file(iq_save_file: str) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:IQFile driver.configure.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:
string Name and path of the file. The extension ‘*.iqw’ is appended automatically.
- set_mode(measurement_mode: MeasurementMode) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MODE driver.configure.iqRecorder.set_mode(measurement_mode = enums.MeasurementMode.NORMal)
No command help available
- param measurement_mode:
No help available
- set_munit(magnitude_unit: MagnitudeUnit) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:MUNit driver.configure.iqRecorder.set_munit(magnitude_unit = enums.MagnitudeUnit.RAW)
Selects the magnitude unit for the measurement results.
- param magnitude_unit:
VOLT | RAW Voltage units or raw I/Q data relative to full-scale.
- set_ratio(ratio: float) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:RATio driver.configure.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:
numeric
- set_timeout(tcd_timeout: float) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT driver.configure.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:
numeric Unit: s
- set_user(user_mode: UserDebugMode) None [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:USER driver.configure.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 [source]
# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile driver.configure.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 RsCmwGprfMeas. Configure.IqRecorder.iqFile.
- param write_to_iq_file:
OFF | ON | ONLY 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.iqRecorder.clone()
Subgroups