IqRecorder

SCPI Command:

CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOFFset
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SAMPles
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:IQFile
CONFigure:GPRF:MEASurement<Instance>:IQRecorder:WTFile

class IqRecorderCls[source]

IqRecorder commands group definition. 12 total commands, 2 Subgroups, 8 group commands

get_format_py() → IqFormat[source]

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

Selects a coordinate system for representation of the measurement results.

return:

format_py: IQ | RPHI IQ Cartesian coordinates (I- and Q-axis) RPHI Polar coordinates (radius and angle)

get_iq_file() → str[source]

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

Selects the name and path of the result file. The results are stored in the file in binary format. To write the file, start the measurement via INITiate:GPRF:MEAS:IQRecorder ON.

return:

iq_save_file: String parameter to specify the file name and path The supported file name extensions are .iqw and .wv. The extension selects the file type.

get_munit() → MagnitudeUnit[source]

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

Selects a physical unit for representation of the measured I/Q amplitudes.

return:

magnitude_unit: VOLT | RAW Voltage or raw I/Q data relative to full scale

get_ratio() → float[source]

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

Defines the sample ratio and thus the sample rate (<sample rate> = <sample ratio> * <max sample rate>) .

return:

ratio: Range: 0.1 to 1

get_samples() → int[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SAMPles
value: int = driver.configure.gprfMeasurement.iqRecorder.get_samples()

No command help available

return:

samples: No help available

get_timeout() → float[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
value: float = driver.configure.gprfMeasurement.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 via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. 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: Unit: s

get_toffset() → int[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOFFset
value: int = driver.configure.gprfMeasurement.iqRecorder.get_toffset()

No command help available

return:

trigger_offset: No help available

get_wt_file() → FileSave[source]

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

Selects whether the results are written to an I/Q file, to the memory or both. For file selection, see method RsCma. Configure.GprfMeasurement.IqRecorder.iqFile.

return:

save_to_iq_file: OFF | ON | ONLY OFF The results are only stored in the memory. They can be queried via remote control commands. ON The results are stored in the memory and in a file. ONLY The results are only stored in a file. Use this selection if you want to record huge amounts of data that do not fit into the memory.

set_format_py(format_py: IqFormat) → None[source]

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

Selects a coordinate system for representation of the measurement results.

param format_py:

IQ | RPHI IQ Cartesian coordinates (I- and Q-axis) RPHI Polar coordinates (radius and angle)

set_iq_file(iq_save_file: str) → None[source]

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

Selects the name and path of the result file. The results are stored in the file in binary format. To write the file, start the measurement via INITiate:GPRF:MEAS:IQRecorder ON.

param iq_save_file:

String parameter to specify the file name and path The supported file name extensions are .iqw and .wv. The extension selects the file type.

set_munit(magnitude_unit: MagnitudeUnit) → None[source]

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

Selects a physical unit for representation of the measured I/Q amplitudes.

param magnitude_unit:

VOLT | RAW Voltage or raw I/Q data relative to full scale

set_ratio(ratio: float) → None[source]

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

Defines the sample ratio and thus the sample rate (<sample rate> = <sample ratio> * <max sample rate>) .

param ratio:

Range: 0.1 to 1

set_samples(samples: int) → None[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:SAMPles
driver.configure.gprfMeasurement.iqRecorder.set_samples(samples = 1)

No command help available

param samples:

No help available

set_timeout(tcd_timeout: float) → None[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOUT
driver.configure.gprfMeasurement.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 via the graphical user interface. The timer is reset after the first measurement cycle. If the first measurement cycle has not been completed when the timer expires, the measurement is stopped and the reliability indicator is set to 1. 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:

Unit: s

set_toffset(trigger_offset: int) → None[source]

# SCPI: CONFigure:GPRF:MEASurement<Instance>:IQRecorder:TOFFset
driver.configure.gprfMeasurement.iqRecorder.set_toffset(trigger_offset = 1)

No command help available

param trigger_offset:

No help available

set_wt_file(save_to_iq_file: FileSave) → None[source]

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

Selects whether the results are written to an I/Q file, to the memory or both. For file selection, see method RsCma. Configure.GprfMeasurement.IqRecorder.iqFile.

param save_to_iq_file:

OFF | ON | ONLY OFF The results are only stored in the memory. They can be queried via remote control commands. ON The results are stored in the memory and in a file. ONLY The results are only stored in a file. Use this selection if you want to record huge amounts of data that do not fit into the memory.

Cloning the Group

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

Subgroups

Capture
FilterPy
- Bandpass
- Gauss