Kt34400Frequency

Access interface members using: driver.frequency

Where driver is a reference to the driver’s root interface returned by the constructor.

class Kt34400Frequency

Kt34400Frequency interface.

property ac_filter

Specifies the AC bandwidth used to detect the signal during frequency measurements.

Access:

ReadWrite

Type:

float

Remarks:

The instrument uses three different AC filters which enable you either to optimize low frequency accuracy or to achieve faster AC settling times following a change in the input signal amplitude. The instrument selects the slow (3 Hz), medium (20 Hz) or fast (200 Hz) filter based on the cutoff frequency that you specify with this property.

If you enter the lowest expected frequency that you intend to encounter, this property will automatically enter the appropriate value. For example, if you enter 15 Hz, the slow filter (3 Hz) is selected. If you enter 190 Hz, the medium filter (20 Hz) is selected to provide the appropriate low cutoff.

Set the lowest frequency that you expect to encounter. Lower bandwidths result in longer settling delays, as shown below:

Input Frequency	Default Settling Delay
3 Hz - 300 kHz (Slow)	1.66 s/measurement
20 Hz - 300 kHz (Medium)	0.25 s/measurement
200 Hz - 300 kHz (Fast)	0.025 s/measurement

Preset value is 20 Hz.

Input range is 3 Hz or 20 Hz or 200 Hz.

property aperture

Sets or gets the integration time in seconds (called aperture time) for frequency measurements.

Access:

ReadWrite

Type:

datetime.timedelta

property auto_timeout

Controls how long the instrument waits before timing out on a frequency measurement when no signal is present.

Access:

ReadWrite

Type:

bool

configure(*args, **kwargs)

Overloaded function.

1. configure(self: keysight_kt34400.keysight_kt34400.Kt34400Frequency, range: float, resolution: keysight_kt34400.keysight_kt34400.Resolution) -> None

   Configure the meter for a frequency measurement.

   Parameters:

   • range (float) - Approximate frequency of the input signal in hertz, between 1 Hz and 1 MHz. Positive values only.

   • resolution (Resolution) - Measurement resolution. Select from Least (4.5 digits), Default (5.5 digits) and Best (5.5 digits). Higher resolutions (5.5 digits) result in slower measurement speeds.

   Returns:

   None

   remarks:

   This method resets all frequency measurement parameters and trigger parameters to their default values. Then, it configures the meter for frequency measurements but does not initiate the measurement.

   Desired range is 1 Hz and 1 MHz.

   If input value is greater than that can be measured on the selected range, "9.9E+37" is returned.

   By default voltage frequency is measured. To measure current frequency instead of voltage frequency the user must call Kt34400.voltage_range if they don't want the default, AutoRange, before calling this method.

   The voltage range should be 0.1 volts or greater for more accurate frequency measurements.

2. configure(self: keysight_kt34400.keysight_kt34400.Kt34400Frequency, range: float, resolution: float) -> None

   Sets all measurement parameters and trigger parameters to their default values for frequency measurements.

   Parameters:

   • range (float) - Desired range in Hz.

   • resolution (float) - Measurement resolution. Select from Least (4.5 digits), Default (5.5 digits) and Best (6.5 digits). Higher resolutions (6.5 digits) result in slower measurement speeds.

   Returns:

   None

   remarks:

   Input range for Range is from 3 Hz to 300 kHz, its preset value is 20 Hz.

   Input range for Resolution is 0.1 ppm x Range to 100 ppm x Range, preset value is 1 ppm x Range (100 ms aperture).

   If input value is greater than that can be measured on the selected range , "+9.9E+37" is returned.

property current_auto_range_enabled

Enables or disables auto ranging for frequency measurements.

Access:

ReadWrite

Type:

bool

property current_range

Sets or gets the current range for frequency measurements.

Access:

ReadWrite

Type:

float

Remarks:

Input range is from 10 mA to 10A.

Selecting this property sets the Kt34400.current_auto_range_enabled to false.

get_voltage_min_max_range(self: keysight_kt34400.keysight_kt34400.Kt34400Frequency, set_value: keysight_kt34400.keysight_kt34400.MinMaxMode) → float

The Maximum and Minimum voltage range for frequency measurements.

Parameters:

set_value (MinMaxMode) – It has two set values- Minimum & Maximum. It sets the values in the SCPI.

Returns:

Minimum and maximum voltage measurement.

Return type:

float

measure(*args, **kwargs)

Overloaded function.

1. measure(self: keysight_kt34400.keysight_kt34400.Kt34400Frequency, range: float, resolution: keysight_kt34400.keysight_kt34400.Resolution) -> float

   Performs a single frequency measurement using the default values for measurement and trigger parameters.

   Parameters:

   • range (float) - Approximate frequency of the input signal in hertz, between 1 Hz and 1 MHz. Positive values only.

   • resolution (Resolution) - Measurement resolution. Select from Least (4.5 digits), Default (5.5 digits) and Best (5.5 digits). Higher resolutions (5.5 digits) result in slower measurement speeds.

   Returns:

   The measured value in Hz.

   Return type:

   float

   remarks:

   This method resets all frequency measurement parameters and trigger parameters to their default values. Then, it configures the meter for frequency measurements but does not initiate the measurement.

   Desired range is 1 Hz and 1 MHz.

   If the input value is greater than can be measured on the selected range then it returns "9.9E+37".

   Timeout may need to be adjusted using Kt34400.io_timeout for executing this method.

2. measure(self: keysight_kt34400.keysight_kt34400.Kt34400Frequency, range: float, resolution: float) -> float

   Sets all measurement parameters and trigger parameters to their default values for frequency measurements and immediately triggers a measurement.

   Parameters:

   • range (float) - Desired range in Hz.

   • resolution (float) - Measurement resolution. Select from Least (4.5 digits), Default (5.5 digits) and Best (6.5 digits). Higher resolutions (6.5 digits) result in slower measurement speeds.

   Returns:

   The measured value in Hz.

   Return type:

   float

   remarks:

   Input range for Range is from 3 Hz to 300 kHz, its preset value is 20 Hz.

   Input range for Resolution is 0.1 ppm x Range to 100 ppm x Range, preset value is 1 ppm x Range (100 ms aperture).

   If input value is greater than that can be measured on the selected range , "+9.9E+37" is returned.

property null_enabled

Enables or disables the null function for frequency measurements.

Access:

ReadWrite

Type:

bool

Remarks:

When true, automatically sets the Kt34400.null_value_auto_enabled to true.

Use Kt34400.null_value to set a fixed null value.

property null_value

Stores a null value for frequency measurements.

Access:

ReadWrite

Type:

float

Remarks:

Specifying this property sets the Kt34400.null_value_auto_enabled to false.

This property will be enabled when Kt34400.null_enabled is set to true.

Input range is from -1.2E6 to +1.2E6.

property null_value_auto_enabled

Enables or disables automatic null value selection for frequency measurements.

Access:

ReadWrite

Type:

bool

Remarks:

If this property is set to true, the first measurement made will be used as the null value for all subsequent measurements. Kt34400.null_value_auto_enabled is set to false.

If this property is set to false, Kt34400.null_value specifies the null value.

The instrument sets this property to true when Kt34400.null_enabled is set to true.

property range_lower

Sets or gets the AC bandwidth used to detect the signal during frequency measurements.

Access:

ReadWrite

Type:

float

property voltage_auto_range

Disables or enables voltage autoranging for frequency measurements.

Access:

ReadWrite

Type:

AutoZero

Remarks:

Autoranging goes down a range at less than 10% of range and up a range at greater than 120% of range.

When this property is set to Ag3446xAutoRangeOn, instrument selects the range based on the input signal.

Selecting a fixed range with Range property disables AutoRange property to Ag3446xAutoRangeOff.

Querying this property when set to Ag3446xAutoRangeOnce, returns Ag3446xAutoRangeOff but it never returns Ag3446xAutoRangeOnce.

Default value is Ag3446xAutoRangeOn.

property voltage_auto_range_enabled

Enables or disables auto ranging for frequency measurements.

Access:

ReadWrite

Type:

bool

property voltage_range

Sets or gets the voltage range for frequency measurements.

Access:

ReadWrite

Type:

float

Remarks:

Input range is from 100mV to 750V.

Selecting this property sets the Kt34400.voltage_auto_range_enabled to false.