ScopeChannelMeasurement Class
- Updated2023-09-06
- 11 minute(s) read
ScopeChannelMeasurement Class
Represents the ScopeChannelMeasurement sub-objects that contain properties to allow you to configure the digitizers to obtain scalar and array measurements.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeChannelMeasurement
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeChannelMeasurement
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public sealed class ScopeChannelMeasurement : ScopeSubObject, ISupportSynchronizationContext, IIviScopeChannelMeasurement
Public NotInheritable Class ScopeChannelMeasurement Inherits ScopeSubObject Implements ISupportSynchronizationContext, IIviScopeChannelMeasurement
The ScopeChannelMeasurement type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ArrayGain |
Gets or sets a scalar value that is multiplied by every element of an array during the Array Gain measurement.
|
| ArrayOffset |
Gets or sets a scalar value that is added to every element of an array during the Array Offset measurement.
|
| Filter |
Gets measurement properties related to filtering.
|
| HysteresisPercent |
Gets or sets the percentage of the full-scale vertical range for the hysteresis window
size. Digital hysteresis is used in several scalar waveform measurements.
|
| InterpolationSamplingFactor |
Gets or sets, indirectly, the new number of points for polynomial interpolation measurements.
The new number of points is the input number of points times the sampling factor.
|
| LastHistogramSize |
Gets or sets the number of bins in the last acquisition histogram.
This histogram is used to determine several scalar measurements, such as voltage low and voltage high.
|
| OtherChannel |
Gets or sets the second channel for two-channel measurements. If processing steps are registered with this channel, the processing is done before the waveform is used in a two-channel measurement.
|
| PolynomialInterpolationOrder |
Gets or sets the polynomial order used for the polynomial interpolation measurement.
For example, an order of 1 specifies linear interpolation whereas an order of 2 specifies parabolic interpolation. Any positive integer is valid.
|
| ReferenceLevel |
Gets properties related to different reference levels.
|
| SynchronizeCallbacks |
Specifies how events and callback delegates are invoked.
|
| TimeHistogram |
Gets properties that are related to time histogram measurements.
|
| VoltageHistogram |
Gets properties that are related to voltage histogram measurements.
|
Methods
| Name | Description | |
|---|---|---|
 | AddWaveformProcessing |
Adds one measurement to the list of processing steps that are completed before the
measurement.
|
| BeginFetchArrayMeasurement |
Asynchronously obtains a waveform from the digitizer and returns the specified measurement array. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| BeginFetchByte |
Begins an asynchronous retrieval of data from a previously initiated acquisition.
|
| BeginFetchComplexDouble |
Begins an asynchronous retrieval of data that the digitizer has acquired from a previously initiated acquisition.
|
| BeginFetchComplexInt16 |
Begins an asynchronous retrieval of data from single channels and records. |
| BeginFetchDouble |
Asynchronously returns the waveform from a previously initiated acquisition that the digitizer acquires for the specified channel.
Refer to Using Fetch Functions for more information on using this method.
|
| BeginFetchInt16 |
Begins an asynchronous retrieval of data from a previously initiated acquisition.
|
| BeginFetchInt32 |
Begins an asynchronous retrieval of data from a previously initiated acquisition.
Refer to Using Fetch Functions for more information on using this method.
|
| BeginFetchScalarMeasurement |
Begins an asynchronous fetching of a waveform from the digitizer and performs the specified waveform measurement. Refer to Using Fetch Functions for more information.
|
| BeginFetchScalarMeasurementStatistics |
Asynchronously obtains a waveform measurement and returns the measurement value. This method may return multiple statistical results depending on the number of channels, the acquisition type, and the number of records you specify.
|
| BeginRead |
Asynchronously initiates an acquisition, waits for it to complete, and retrieves the data.
|
| BeginReadScalarMeasurement |
Asynchronously initiates an acquisition, waits for it to complete, and performs the specified waveform measurement for a single channel and record or for multiple channels and records. Refer to Using Fetch Functions for more information.
|
| ClearWaveformMeasurements |
Clears the waveform statistics on the channel and for all measurements.
|
| ClearWaveformMeasurements(ScopeArrayMeasurementType) |
Clears the waveform statistics on the channel and for scalar measurements.
|
| ClearWaveformMeasurements(ScopeScalarMeasurementType) |
Clears the waveform statistics on the channel and for scalar measurements.
|
| ClearWaveformProcessing |
Clears the list of processing steps assigned to the given channel.
|
| EndFetchArrayMeasurement(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchArrayMeasurement(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchByte(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchByte(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchComplexDouble(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchComplexDouble(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchComplexInt16(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchComplexInt16(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchDouble(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchDouble(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchInt16(IAsyncResult) |
Waits for pending asynchronous fetch to complete and returns binary 16-bit waveforms. This method may return multiple waveforms
depending on the number of channels, the acquisition type, and the number of records you specify.
|
| EndFetchInt16(IAsyncResult, ScopeWaveformInfo) |
Waits for pending asynchronous fetch to complete and returns binary 16-bit waveforms. This method may return multiple waveforms
depending on the number of channels, the acquisition type, and the number of records you specify.
|
| EndFetchInt32(IAsyncResult) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchInt32(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous fetch to complete. |
| EndFetchScalarMeasurement |
Waits for a pending asynchronous fetch to complete. |
| EndFetchScalarMeasurementStatistics |
Waits for a pending asynchronous fetch to complete. |
| EndRead(IAsyncResult) |
Waits for a pending asynchronous read to complete. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| EndRead(IAsyncResult, ScopeWaveformInfo) |
Waits for a pending asynchronous read to complete. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| EndReadScalarMeasurement |
Waits for a pending asynchronous read to complete. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FetchArrayMeasurement(PrecisionTimeSpan, ScopeArrayMeasurementType, AnalogWaveformCollectionDouble) |
Obtains a waveform from the digitizer and returns the specified measurement array. This method may return multiple waveforms depending on the number of channels, the acquisition type,
and the number of records you specify.
|
| FetchArrayMeasurement(PrecisionTimeSpan, ScopeArrayMeasurementType, AnalogWaveformCollectionDouble, ScopeWaveformInfo) |
Obtains a waveform from the digitizer and returns the specified measurement array. This method may return multiple waveforms depending on the number of channels, the acquisition type,
and the number of records you specify.
|
| FetchByte(PrecisionTimeSpan, Int64, AnalogWaveformCollectionByte) |
Retrieves data from a previously initiated acquisition and returns binary 8-bit waveforms. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| FetchByte(PrecisionTimeSpan, Int64, AnalogWaveformCollectionByte, ScopeWaveformInfo) |
Retrieves data from a previously initiated acquisition and returns binary 8-bit waveforms. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
Refer to Features Supported by Device for more information on using this method.
|
| FetchComplexDouble(PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexDouble) |
Retrieves data that the digitizer has acquired from a previously initiated acquisition and returns a one-dimensional array of complex, scaled waveforms.
|
| FetchComplexDouble(PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexDouble, ScopeWaveformInfo) |
Retrieves data that the digitizer has acquired from a previously initiated acquisition and returns a one-dimensional array of complex, scaled waveforms.
|
| FetchComplexInt16(PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexInt16) |
Retrieves data from single channels and records. A one-dimensional array of complex binary 16-bit waveforms. |
| FetchComplexInt16(PrecisionTimeSpan, Int64, ComplexWaveformCollectionComplexInt16, ScopeWaveformInfo) |
Retrieves data from single channels and records. Returns a one-dimensional array of complex binary 16-bit waveforms. |
| FetchDouble(PrecisionTimeSpan, Int64, AnalogWaveformCollectionDouble) |
Returns the waveform from a previously initiated acquisition that the digitizer acquires for the specified channel. This method returns scaled voltage waveforms.
Refer to Using Fetch Functions for more information on using this method.
|
| FetchDouble(PrecisionTimeSpan, Int64, AnalogWaveformCollectionDouble, ScopeWaveformInfo) |
Returns the waveform from a previously initiated acquisition that the digitizer acquires for the specified channel. This method returns scaled voltage waveforms.
Refer to Using Fetch Functions for more information on using this method.
|
| FetchInt16(PrecisionTimeSpan, Int64, AnalogWaveformCollectionInt16) |
Retrieves data from a previously initiated acquisition and returns binary 16-bit waveforms. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| FetchInt16(PrecisionTimeSpan, Int64, AnalogWaveformCollectionInt16, ScopeWaveformInfo) |
Retrieves data from a previously initiated acquisition and returns binary 16-bit waveforms. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| FetchInt32(PrecisionTimeSpan, Int64, AnalogWaveformCollectionInt32) |
Retrieves data from a previously initiated acquisition. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| FetchInt32(PrecisionTimeSpan, Int64, AnalogWaveformCollectionInt32, ScopeWaveformInfo) |
Retrieves data from a previously initiated acquisition. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| FetchScalarMeasurement |
Fetches a waveform from the digitizer and performs the specified waveform measurement. Refer to Using Fetch Functions for more information.
|
| FetchScalarMeasurementStatistics |
Obtains a waveform measurement and returns the measurement value. This method may return multiple statistical results depending on the number of channels, the acquisition type, and the number of records you specify.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Read(PrecisionTimeSpan, Int64, AnalogWaveformCollectionDouble) |
Initiates an acquisition, waits for it to complete, and retrieves the data.This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| Read(PrecisionTimeSpan, Int64, AnalogWaveformCollectionDouble, ScopeWaveformInfo) |
Initiates an acquisition, waits for it to complete, and retrieves the data. This method may return multiple waveforms depending on the number of channels, the acquisition type, and the number of records you specify.
|
| ReadScalarMeasurement |
Initiates an acquisition, waits for it to complete, and performs the specified waveform measurement for a single channel and record or for multiple channels and records. Refer to Using Fetch Functions for more information.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
For more information, refer to Making Waveform Measurements in the NI High-Speed Digitizers Help or to the
Scalar Measurements and Array Measurements
topics in the NI-SCOPE Function Reference Help.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.