Kt34400MathHistogram

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

Kt34400MathHistogram interface.

property auto_range_enabled

Enables or disables automatic selection of the histogram’s lower and upper range values.

Access:

ReadWrite

Type:

bool

Remarks:
  • If set to true, the instrument uses the values of the first several measurements to set the histograms's lower and upper range values. To be specific, it uses the number of measurements specified by ReadingCount property.
  • If set to false, the lower and upper range values are specified by LowerRange and UpperRange properties.
  • Setting the lower or upper range value by LowerRange and UpperRange properties set the AutoRangeEnabled property to false.
  • Preset value is True.
    • property bin_count

    Specifies the number of bins between the lower and upper range values for the histogram.

    Access:

    ReadWrite

    Type:

    int

    Remarks:
  • You can specify the lower and upper range values using LowerRange and UpperRange properties. They are computed automatically if AutoRangeEnabled property is true.
  • When AutoRangeEnabled property is true, the specified bin count does not apply and is internally defaulted to 400 bins or points. Querying the bin count returns the count that would be used if AutoRangeEnabled property was false.
  • Preset value is 100.
  • Input range is from 10 to 1000.
    • clear(self: keysight_kt34400.keysight_kt34400.Kt34400MathHistogram) → None

    Clears the histogram data and restarts automatic scaling if AutoRangeEnabled property is true.

    Returns:

    None

    property enabled

    Enables or disables histogram computation.

    Access:

    ReadWrite

    Type:

    bool

    Remarks:
  • Preset value is False.
    • get_bin_data(self: keysight_kt34400.keysight_kt34400.Kt34400MathHistogram) → numpy.ndarray[numpy.int32]

    Returns a comma-separated list of bin data only.

    Returns:

    Bin data in the form of array.

    Return type:

    numpy.ndarray<with dtype:int32>

    Remarks:
  • The bin data includes the following, in order:
        The number of measurements less than the lower range value.
        The number of measurements in the each of the bins, starting at the lower range value bin.
        The number of measurements greater than the upper range value.
    • get_data(self: keysight_kt34400.keysight_kt34400.Kt34400MathHistogram) → Tuple[numpy.ndarray[numpy.int32], float, float, int]

    Returns a comma-separated list of the lower and upper range values, the number of measurements, and the bin data collected since the last time the histogram data was cleared.

    Returns:

    A tuple containing:

    • return (numpy.ndarray<dtype:int32>): Histogram data.

    • minValue (float) : Lower Range of the measurement

    • maxValue (float) : Upper Range of the measurement

    • count (int) : Total Measurement Count

    Type:

    tuple[numpy.ndarray<dtype:int32>, float, float, int]

    Remarks:
  • The bin data includes the following, in order:
        The number of measurements less than the lower range value.
        The number of measurements in the each of the bins, starting at the lower range value bin.
        The number of measurements greater than the upper range value.
    • property lower_range

    Specifies the lower range values for the histogram.

    Access:

    ReadWrite

    Type:

    float

    Remarks:
  • Setting this property sets the AutoRangeEnabled property to false.
  • If AutoRangeEnabled property is true, the query returns the computed range value. If no histogram data exists, 9.91E37 (Not a Number) is returned.
  • Lower and upper range values are computed automatically if AutoRangeEnabled property is true.
  • Preset value is 0.
  • Input range is -1.0E+15 to -1.0E-15.
    • property reading_count

    Read Only - Returns the number of measurements collected since the last time the histogram was cleared.

    Access:

    ReadOnly

    Type:

    int

    Remarks:
  • Before using this property set Enabled property to true.
  • You can read the measurement count at any time.
    • property upper_range

    Specifies the upper range values for the histogram.

    Access:

    ReadWrite

    Type:

    float

    Remarks:
  • Setting this property sets the AutoRangeEnabled property to false.
  • If AutoRangeEnabled property is true, the query returns the computed range value. If no histogram data exists, 9.91E37 (Not a Number) is returned.
  • Lower and upper range values are computed automatically if AutoRangeEnabled property is true.
  • Preset value is 0.
  • Input range is -1.0E+15 to -1.0E-15.