APPH module

Created on Tue Feb 15 10:57:49 2022

@author: Martin.Mihaylov

class Instruments_Libraries.APPH.APPH(resource_str)[source]

Bases: object

Close()[source]

abort()[source]

Abort measurement

Return type:: None

an_meas_example(value)[source]: This is a small example how to make a phase noise measurement.

fn_meas_example(value)[source]: This is a small example how to make a frequency noise measurement.

get_an_spot(value)[source]

Returns the phase noise value of the last measurement at the offset frequency defined in <value>. The parameter is given as offset frequency in [Hz] Unit Hz Value - float

Parameters:: value (float) – The parameter is given as offset frequency in [Hz] Unit Hz Value - float
Return type:: str

get_an_trace_freq()[source]

Returns a list of offset frequency values of the current measurement as block data. Hz

Return type:: str

get_an_trace_noise()[source]

Returns a list of amplitude noise spectrum values of the current measurement as block data. Unit dBc/Hz

Return type:: str

get_an_trace_spur_freq()[source]

Returns a list of offset frequencies of the spurs in the active trace as block data. Unit Hz

Return type:: str

get_an_trace_spur_power()[source]

Returns a list of power values of the spurs in the active trace as block data. Unit dBc

Return type:: str

get_calc_freq()[source]

Reads back the detected frequency from a frequency search.

Return type:: float

get_calc_power()[source]

Reads back the detected power level from a frequency search.

Return type:: float

get_dut_port_status()[source]

Query the status of the DUT TUNE port.

Return type:: str

get_dut_port_voltage()[source]

Sets/gets the voltage at the DUT TUNE port. Returns the configured value. If the output is turned off, it doesn’t necessarily return 0, as an internal voltage may be configured.

Return type:: float

get_fn_spot(value)[source]

Returns the spot noise value at the specified offset frequency.

Parameters:: value (float) – The parameters defines the spot noise offset frequency in [Hz]. Units are in Hz. Value - float
Return type:: str

get_fn_trace_freq()[source]

Returns a list of offset frequency values of the current measurement as block data. Unit Hz

Return type:: str

get_fn_trace_noise()[source]

Returns a list of phase noise spectrum values of the current measurement as block data. Units are in Hz.

Return type:: str

get_fn_trace_spur_freq()[source]

Returns a list of offset frequencies of the spurs in the active trace as block data. Units are in Hz.

Return type:: str

get_fn_trace_spur_power()[source]

Returns a list of power values of the spurs in the active trace as block data. Units are in Hz

Return type:: str

get_pm_trace_jitter()[source]

Returns the RMS jitter of the current trace.

Return type:: str

get_pm_trace_noise()[source]

Returns a list of phase noise points of the most recent measurement as block data.

Return type:: str

get_pn_if_gain()[source]

Range: 0-60 Query the IF gain for the measurement.

Return type:: float

get_pn_spot(value)[source]

Returns the phase noise value of the last measurement at the offset frequency defined in <value>. The parameter is given as offset frequency in [Hz] Unit Hz Value - float

Parameters:: value (float) – The parameter is given as offset frequency in [Hz] Unit Hz Value - float
Return type:: str

get_pn_start_freq()[source]

Query the start offset frequency

Return type:: float

get_pn_stop_freq()[source]

Query the stop offset frequency

Return type:: float

get_sys_meas_mode()[source]

Gets the active measurement mode.

Return type:: str

get_system_error()[source]

Return parameters: List of integer error numbers. This query is a request for all entries in the instrument’s error queue. Error messages in the queue contain an integer in the range [-32768,32768] denoting an error code and associated descriptive text. This query clears the instrument’s error queue.

Return type:: str

get_vco_test_i_supply()[source]

Query the supply current parameter for the measurement

Return type:: str

get_vco_test_p_noise()[source]

Query the phase noise parameter for the measurement.

Return type:: str

get_vco_test_pnoise_off_set(state)[source]

Query the 4 offset frequencies at which the phase noise is measured

Parameters:: state (int) – Can be set to [1,2,3,4]
Raises:: ValueError – Error massage
Return type:: str

get_vco_test_point()[source]

Query the number rof voltage points to use in the measurement

Return type:: str

get_vco_test_power()[source]

Query the power parameter for the measurement.

Return type:: str

get_vco_test_start()[source]

Query the start tuning voltage for the measurement. Units are in V.

Return type:: str

get_vco_test_stop()[source]

Query the stop tuning voltage for the measurement. Units are in V

Return type:: str

get_vco_trace_freq()[source]

Returns a list of frequency values measured at each tune voltage point of the current measurement as block data2.

Return type:: str

get_vco_trace_p_noise(chan)[source]

Returns a list of phase noise values measured at each tune voltage point of the current measurement as block data. The parameter 1-4 selects the offset frequency from the set defined by the SENS:VCO:TEST:PN:OFFS <list> command

Parameters:: chan (list) – Can be set to [1,2,3,4]
Raises:: ValueError – Error massage
Return type:: str

get_vco_trace_power()[source]

Returns a list of power values measured at each tune voltage point of the current measurement as block data.

Return type:: str

get_vco_trace_voltage()[source]

Returns a list of tune voltage values measured at each tune voltage point of the current measurement as block data.

Return type:: str

get_vcok_pu_shing()[source]

Query the pushing parameter for the measurement

Return type:: str

get_vcokvco()[source]

Query the tune sensitivity parameter for the measurement.

Return type:: str

get_vcotype()[source]

Query the DUT type for the measurement.

Return type:: str

get_vso_test_freq()[source]

Query the frequency parameter for the measurement.

Return type:: str

get_vso_test_noise()[source]

Query the phase noise parameter for the measurement.

Return type:: str

init()[source]

Initialize the measurement

Return type:: None

pn_meas_example(value)[source]: This is a small example how to make a phase noise measurement.

query(message)[source]

set_calc_average(event)[source]

Parameters:: event (str) – Waits for the defined event NEXT: next iteration complete ALL: measurement complete <value>: specified iteration complete Optionally, a timeout in milliseconds can be specified as a second parameter. This command will block further SCPI requests until the specified event or the specified timeout has occurred. If no timeout is specified, the timeout will be initiated.
Return type:: None

set_dut_port_status(state)[source]

Parameters:: state (str | int | float | bool) – Enables/disables the DUT TUNE port. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_dut_port_voltage(value)[source]

Sets the voltage at the DUT TUNE port. Returns the configured value. If the output is turned off, it doesn’t necessarily return 0, as an internal voltage may be configured

Parameters:: value (float) – Sets the voltage at the DUT TUNE port. Returns the configured value. If the output is turned off, it doesn’t necessarily return 0, as an internal voltage may be configured
Return type:: None

set_freq_execute()[source]

Starts the frequency search. See function calculate subsystem on how to read out the result.

Return type:: None

set_output(status)[source]

Parameters:: status (str) – Set Output ON and OFF. CAn be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None

set_pn_start_freq(value)[source]

Parameters:: value (float) – Unit HZ Sets the start offset frequency.
Return type:: None

set_pn_stop_freq(value)[source]

Parameters:: value (float) – Unit HZ Sets the stop offset frequency.
Return type:: None

set_pnif_gain(value)[source]

Parameters:: value (float) – Range: 0-60 Sets the IF gain for the measurement.
Raises:: ValueError – Error massage
Return type:: None

set_power_execute()[source]

Starts the power measurement. When performing SENS:FREQ:EXEC, this measurement will be automatically run at the end (if a signal is detected

Return type:: None

set_sys_meas_mode(state)[source]

Parameters:

state (str) –

Sets/gets the active measurement mode. Can be [‘PN’,’AN’,’FN’,’BB’,’TRAN’,’VCO’]

PN: phase noise measurement
AN: amplitude noise measurement
FN: frequency noise measurement (results are converted to phase noise)
BB: base band measurement (not yet available)
TRAN: transient analysis (not yet available)
VCO: voltage controlled oscillator characterization

Raises:

ValueError – Error massage

Return type:

None

set_vco_test_freq(state)[source]

Parameters:: state (str | int | float | bool) – Enables/Disables the frequency parameter for the measurement. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vco_test_i_supply(state)[source]

Parameters:: state (str | int | float | bool) – Enables/disables the supply current parameter for the measurement. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vco_test_noise(state)[source]

Parameters:: state (str | int | float | bool) – Enables/Disables the phase noise parameter for the measurement. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vco_test_p_noise(state)[source]

Parameters:: state (str | int | float | bool) – Enables/Disables the phase noise parameter for the measurement. Can be set to [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vco_test_pnoise_off_set(value1=0, value2=0, value3=0, value4=0)[source]

Sets up to 4 offset frequencies at which the phase noise is measured. At least 1 parameter is required. Blank parameters are set to 0 (disabled). The query returns the set frequency for the specified offset. The offset can be specified with the <sel> parameter and can be chosen from 1|2|3|4

Unit HZ

Parameters:

value1 (float) – freq val 1
value2 (float) – freq val 2
value3 (float) – freq val 3
value4 (float) – freq val 4

Return type:

None

set_vco_test_point(value)[source]

Parameters:: value (float) – Sets the number rof voltage points to use in the measurement
Return type:: None

set_vco_test_power(state)[source]

Parameters:: state (str | int | float | bool) – Enables/Disables the power parameter for the measurement. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vco_test_start(value)[source]

Parameters:: value (float) – Sets the start tuning voltage for the measurement. Unit V
Return type:: None

set_vco_test_stop(value)[source]

Parameters:: value (float) – Sets the stop tuning voltage for the measurement. Units are in V.
Return type:: None

set_vco_wait(state, value)[source]

Parameters:

state (str) – Can be [‘ALL’,’NEXT’]
value (float) – This command requests a preliminary result during the measurement and blocks until the result is ready. The first parameter (required) specifies the target iteration to be saved. NEXT specifies the next possible iteration, ALL specifies the last iteration of the measurement (i.e. waits for the measurement to finish) and an integer specifies the specific iteration requested.The second parameter (optional) defines a timeout in milliseconds. If the command terminates without generating a preliminary result. It will produce an error. This error can be queried with SYST:ERR? or SYST:ERR:ALL?.

Return type:

str | None

set_vcok_pu_shing(state)[source]

Parameters:: state (str | int | float | bool) – Enables/disables the pushing parameter for the measurement. Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vcokvco(state)[source]

Parameters:: state (str | int | float | bool) – Enables/disables the tune sensitivity parameter for the measurement Can be [‘ON’,’OFF’] or [1,0] or [True,False].
Raises:: ValueError – Error massage
Return type:: None

set_vcotype(typ)[source]

Parameters:: typ (str) – Select the DUT type for the measurement. Distinguish between slow (VCXO) and fast (VCO) tuning sensitivities. Can be [‘VCO’,’VCXO’]
Raises:: ValueError – Error massage
Return type:: None

vco_meas_example(noise_offset_1, noise_offset_2, meas_points, tun_range_min, tun_range_max, supply_voltage, delay)[source]: This is a small example how to make a Voltage controlled oscillator noise measurement.

write(message)[source]