ScopeChannel Class
- Updated2023-09-06
- 5 minute(s) read
ScopeChannel Class
Represents a channel or a set of channels and the properties that you can set on a channel.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeChannel
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeChannel
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public sealed class ScopeChannel : ScopeSubObject, IIviScopeChannel, IIviRepeatedCapabilityIdentification
Public NotInheritable Class ScopeChannel Inherits ScopeSubObject Implements IIviScopeChannel, IIviRepeatedCapabilityIdentification
The ScopeChannel type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | BandpassFilterEnabled |
Gets or sets whether the bandpass filter is enabled on the specified channel.
|
| CableSenseMode |
Gets or sets the CableSense Signal Mode
|
| CableSenseVoltage |
Gets the CableSense signal voltage amplitude for the given channel
|
| Coupling |
Gets or sets how the digitizer couples the input signal for the channel. When input coupling changes, the input stage takes a finite amount of time to settle.
|
| DigitalGain |
Gets or sets the gain on the specified channel in hardware before any onboard signal processing occurs.
|
| DigitalOffset |
Gets or sets the offset on the specified channel in hardware before any onboard signal processing occurs.
|
| DitherEnabled |
Gets or sets whether dither is enabled on the channel.
|
| Enabled |
Gets or sets whether the digitizer acquires a waveform for the channel.
|
| EnableInterleavingOffsetCorrection |
Gets or sets a value specifying whether to enable the interleaving offset correction.
|
| EnableTimeInterleavedSampling |
Gets or sets the instrument to use multiple ADCs to sample the same waveform at a higher effective real-time sample rate.
|
| FlexFirAntiAliasFilterType |
Gets or sets the type of filter needed to achieve desired filtering characteristics.
|
| HighPassFilterFrequency |
Gets or sets the frequency for the highpass filter in Hz.
|
| InputFrequencyMax |
Gets or sets the bandwidth, in hertz, of the channel. Express this value as the frequency at which the input circuitry attenuates the input signal by 3 dB. |
| InputImpedance |
Gets or sets the input impedance, in ohms, for the channel.
|
| Measurement |
Gets the ScopeChannelMeasurement sub-object
that is related to configuring digitizers to obtain scalar and array measurements.
|
| Name |
Gets the name of the channel.
|
| Offset |
Gets or sets the location of the center of the range with respect to ground in volts.
|
| OnboardSignalProcessing |
Gets the ScopeChannelOnboardSignalProcessing sub-object
that is related to configuring the onboard signal processing (OSP) block of the high speed digitizer.
|
| ProbeAttenuation |
Gets or sets the probe attenuation for the input channel. For example, for a 10:1 probe, set this property to 10.0.
|
| Range |
Gets or sets the absolute value, in volts, of the input range for a channel. For example, to acquire
a sine wave that spans between -5 and +5 V, set this property to 10.0 V.
|
| TerminalConfiguration |
Gets or sets the terminal configuration for the channel.
|
Methods
| Name | Description | |
|---|---|---|
 | Configure |
Configures the most commonly-configured properties, such as the range, offset, coupling, probe attenuation, and the channel name of the digitizer vertical subsystem.
|
| ConfigureCharacteristics |
Configures the properties that control the electrical characteristics of the channel.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetFrequencyResponse |
Gets the frequency response of the digitizer for the current configurations of the channel attributes.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetNormalizationCoefficients |
Returns coefficients that can be used to convert binary data to normalized and calibrated data.
|
| GetScalingCoefficients |
Returns an array of ScopeCoefficientInfo containing gain and offset coefficients for a given channel.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a string representation of the object.
(Overrides ObjectToString.) |
Remarks
For more information, refer to the Attributes section of 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.