Kt34400MathStatistics

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

Kt34400MathStatistics interface.

property average

Read Only - Gets the mathematical average (mean) of all readings taken since statistics were enabled.

Access:

ReadOnly

Type:

float

Remarks:
  • To use this property you must first set Kt34400.function to MathFunction.Statistics.
  • It returns the average of the readings taken, or "0" if no data is available.
    • clear(self: keysight_kt34400.keysight_kt34400.Kt34400MathStatistics) → None

    Clears all computed statistics: minimum, maximum, average, peak-to-peak, count and standard deviation.

    Returns:

    None

    Remarks:
  • No measurements are cleared from the reading memory.
    • property enabled

    Enables or disables the statistics computation.

    Access:

    ReadWrite

    Type:

    bool

    Remarks:
  • The statistical values can be cleared when Enabled property is set to True, when the measurement function is changed or when Clear method is called.
  • This property is set to False when the measurement function is changed .
    • get_data(self: keysight_kt34400.keysight_kt34400.Kt34400MathStatistics) → Tuple[float, float, float, float]

    Returns the arithmetic mean (average), standard deviation, minimum value and maximum value of all measurements taken since the last time statistics were cleared.

    Returns:

    A tuple containing:

    • average (float) : Average value

    • standardDeviation (float) : Standard deviation value.

    • minimum (float) : Minimum value.

    • maximum (float) : Maximum value.

    Type:

    tuple[float, float, float, float]

    Remarks:
  • The peak-to-peak value is not returned by this method.
  • The statistical values can be cleared when Enabled property is set to True, when the measurement function is changed or when Clear method is called.
    • property maximum

    Read Only - Gets the maximum value found since statistics were enabled.

    Access:

    ReadOnly

    Type:

    float

    Remarks:
  • To use this property you must first set Kt34400.function to MathFunction.Statistics.
  • It returns the maximum of the readings taken, or "0" if no data is available.
    • property minimum

    Read Only - Gets the minimum value found since statistics were enabled.

    Access:

    ReadOnly

    Type:

    float

    Remarks:
  • To use this property you must first set Kt34400.function to MathFunction.Statistics.
  • It returns the minimum value found, or "0" if no data is available.
    • property peak_to_peak

    Read Only - Gets the peak to peak value found since statistics were enabled.

    Access:

    ReadOnly

    Type:

    float

    property reading_count

    Read Only - Gets the number of readings taken since statistics were enabled.

    Access:

    ReadOnly

    Type:

    float

    Remarks:
  • To use this property you must first set Kt34400.function to MathFunction.Statistics.
  • It returns the count since statistics were enabled, or "0" if no data is available.
    • property standard_deviation

    Read Only - Gets the standard deviation of all readings taken since statistics were enabled.

    Access:

    ReadOnly

    Type:

    float