Kt34400Measurement

Access interface members using: driver.measurement
Where driver is a reference to the driver’s root interface returned by the constructor.
class Kt34400Measurement

Kt34400Measurement interface.

abort(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → None

Aborts a measurement in progress.

Returns:

None

Remarks:
  • This method will abort a measurement in progress and stop, returning the instrument to the trigger idle state.
    • property auto_impedance_enabled

    Enables or disables Auto-Impedance.

    Access:

    ReadWrite

    Type:

    bool

    property auto_zero

    Enables or disables the auto zero mode.

    Access:

    ReadWrite

    Type:

    bool

    property bandwidth

    Gets or sets the detector bandwidth.

    Access:

    ReadWrite

    Type:

    float

    copy_readings(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → None

    Copies the readings in reading memory into non-volatile memory.

    Returns:

    None

    delete_readings(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → None

    Deletes all readings from non-volatile memory.

    Returns:

    None

    fetch(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → float

    Returns previously measured data from the instrument output buffer for the primary function. The readings are not erased from memory when you read them. You can execute this method multiple times to retrieve the same data in reading memory.

    Returns:

    The Measured data.

    Return type:

    float

    fetch_all(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → numpy.ndarray[numpy.float64]

    Returns previously measured data from the instrument output buffer for both primary and secondary function. The readings are not erased from memory when you read them. You can execute this method multiple times to retrieve the same data in reading memory.

    Returns:

    The Measured data.

    Return type:

    numpy.ndarray<with dtype:double>

    Remarks:
  • The secondary function must be set to ON to get the readings for both primary and secondary function.
    • initiate(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → None

    Initiates a measurement. Changes the state of the triggering system from the ‘idle’ state to the ‘wait-for-trigger’ state.

    Returns:

    None

    Remarks:
  • Measurements will begin when the specified trigger conditions are satisfied following execution of this method. Note that this method also clears the previous set of readings from memory.
    • is_over_range(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, measurement_value: float) → bool

    Takes a measurement value obtained from one of the Read or Fetch methods and determines if the value is a valid measurement value or a value indicating that an overrange condition occurred.

    Parameters:

    measurement_value (float) – The measurement value from one of the Read or Fetch functions.

    Returns:

    True if value = +9.9E37 or -9.9E37 or NaN else False.

    Return type:

    bool

    query_all(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → numpy.ndarray[numpy.float64]

    Returns all readings in non-volatile memory.

    Returns:

    The measured values.

    Return type:

    numpy.ndarray<with dtype:double>

    Remarks:
  • The internal non-volatile memory can store up to 50,000 readings.
    • query_last(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → float

    Returns the last measurement taken from the non-volatile memory.

    Returns:

    The measured value.

    Return type:

    float

    Remarks:
  • Returns one reading with units. If no data is available, "9.91000000E+37" is returned.
    • read(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, max_time: datetime.timedelta) → float

    Initiates a measurement and returns the data from the instrument output buffer for primary function. Measurements will begin when the specified trigger conditions are satisfied.

    Parameters:

    max_time (datetime.timedelta) – The maximum time allowed for the measurement to complete in milliseconds

    Returns:

    The measured data.

    Return type:

    float

    read_all(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, max_time: datetime.timedelta) → numpy.ndarray[numpy.float64]

    Initiates a measurement and returns the data from the instrument output buffer for both primary and secondary function. Measurements will begin when the specified trigger conditions are satisfied.

    Parameters:

    max_time (datetime.timedelta) – The maximum time allowed for the measurement to complete in milliseconds

    Returns:

    The measured data.

    Return type:

    numpy.ndarray<with dtype:double>

    Remarks:
  • The secondary function must be set to ON to get the readings for both primary and secondary function.
    • read_erase(*args, **kwargs)

    Overloaded function.

    1. read_erase(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, max_readings: int) -> numpy.ndarray[numpy.float64]

      Reads and erases measurements from reading memory up to the specified maxReadings.

      Parameters:

      • max_readings (int) - Specific number of readings to be read and erased from memory.

      Returns:

      The removed values.

      Return type:

      numpy.ndarray<with dtype:double>

      remarks:
    2. The measurements are erased from memory starting with the oldest measurement first.
    3. It does not wait for all readings to complete. It sends the readings that are complete at the time the instrument receives the command.
    4. No error is generated if the reading memory contains less readings than requested. In this case, all available readings in memory are read and deleted.
    5. The instrument clears all measurements from reading memory when the measurement configuration changes.

    6. read_erase(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) -> numpy.ndarray[numpy.float64]

      Reads and erases all measurements from reading memory.

      Parameters:

      Returns:

      The removed values.

      Return type:

      numpy.ndarray<with dtype:double>

      remarks:
    7. The measurements are erased from memory starting with the oldest measurement first.
    8. It does not wait for all readings to complete. It sends the readings that are complete at the time the instrument receives the command.
    property reading_count

    Read Only - Gets the total number of readings currently stored in non-volatile memory.

    Access:

    ReadOnly

    Type:

    int

    Remarks:
  • This method returns between 0 and 50,000 readings.
    • property reading_count_ex

    Read Only - Returns the total number of measurements currently stored in the reading memory.

    Access:

    ReadOnly

    Type:

    int

    Remarks:
  • This property can return up to 1000 measurements for the Keysight 34460A or 10,000 measurements for the 34461A.
    • remove_readings(*args, **kwargs)

    Overloaded function.

    1. remove_readings(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, num_readings: int) -> numpy.ndarray[numpy.float64]

      Reads and erases the specified number of readings from memory.

      Parameters:

      • num_readings (int) - Specific number of readings to be read and erased from memory.

      Returns:

      The removed values.

      Return type:

      numpy.ndarray<with dtype:double>

      remarks:
    2. The readings are erased from memory starting with the oldest reading first. The purpose of this method is to allow you to periodically remove readings from memory during a series of measurements to avoid a reading memory overflow. If the specified number of readings are not yet present in memory when this routine is called, an instrument error will result and the data fetch will fail.

    3. remove_readings(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement, num_readings: int, wait: keysight_kt34400.keysight_kt34400.DataRemove) -> numpy.ndarray[numpy.float64]

      Reads and erases the specified number of readings from memory.

      Parameters:

      • num_readings (int) - Specific number of readings to be read and erased from memory.

      • wait (DataRemove) - The WAIT parameter is specified, in which case the query waits until numReadings measurements are available.

      Returns:

      The removed values.

      Return type:

      numpy.ndarray<with dtype:double>

      remarks:
    4. The readings are erased from memory starting with the oldest reading first. The purpose of this method is to allow you to periodically remove readings from memory during a series of measurements to avoid a reading memory overflow. If the specified number of readings are not yet present in memory when this routine is called, the query waits until numReadings measurements are available.
    send_software_trigger(self: keysight_kt34400.keysight_kt34400.Kt34400Measurement) → None

    This method triggers the instrument from the remote interface.

    Returns:

    None