ScopeTiming Class
- Updated2023-09-06
- 5 minute(s) read
ScopeTiming Class
Represents the ScopeMeasurement sub-object that contains properties related to timing.
Inheritance Hierarchy
SystemObject
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeTiming
NationalInstruments.ModularInstruments.NIScopeScopeSubObject
NationalInstruments.ModularInstruments.NIScopeScopeTiming
Namespace: NationalInstruments.ModularInstruments.NIScope
Assembly: NationalInstruments.ModularInstruments.NIScope.Fx45 (in NationalInstruments.ModularInstruments.NIScope.Fx45.dll) Version: 2023
Syntax
public sealed class ScopeTiming : ScopeSubObject
Public NotInheritable Class ScopeTiming Inherits ScopeSubObject
The ScopeTiming type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | AbsoluteSampleClockOffset |
Gets or sets the absolute time offset of the sample clock relative to the reference clock.
|
![]() | ClockSynchronizationPulseSource |
Gets or sets the clock synchronization pulse source.
|
![]() | EnforceRealtime |
Gets or sets whether the digitizer enforces real-time measurements or allows equivalent-time measurements.
|
![]() | FractionalResample |
Gets the ScopeFractionalResample sub-object
that you use to configure fractional resampling on the high speed digitizer.
|
![]() | MoreRecordsThanMemoryAllowed |
Gets or sets whether more records can be configured with NumberOfRecordsToAcquire than fit in the onboard memory.
|
![]() | NumberOfRecordsToAcquire |
Gets or sets the number of records to acquire. Can be used for multirecord acquisitions and single record acquisitions. Setting this property to 1 indicates a single record acquisition.
|
![]() | OnboardMemorySize |
Gets the total combined amount of onboard memory for all channels in bytes.
|
![]() | OscillatorPhaseDac |
Gets or sets the binary phase DAC value that controls the delay added to the Phase Locked Loop (PLL) of the sample clock.
|
![]() | PllLockStatus |
Gets whether the PLL has remained locked/unlocked to the external reference clock since it was last checked.
|
![]() | PollInterval |
Gets or sets the poll interval to use during RIS acquisitions to check whether the acquisition is complete.
|
![]() | RealtimeSampleRateMax |
Gets the maximum real-time sample rate, in Hz.
|
![]() | ReferenceClockRate |
Gets or sets the frequency, in hertz, of the input, or reference clock, to which the internal sample clock timbase is synchronized if
ReferenceClockSource is an external source. |
![]() | ReferenceClockSource |
Gets or sets the input source for the PLL reference clock to which the digitizer will be phase-locked.
|
![]() | RisAverages |
Gets or sets the number of averages for each bin in an RIS acquisition.
|
![]() | RisMethod |
Gets or sets the algorithm for random-interleaved sampling, which is used if the sample rate exceeds the value of RealtimeSampleRateMax.
|
![]() | RisRateMax |
Gets the maximum sample rate in RIS mode, in Hz.
|
![]() | SampleClockTimebaseDivisor |
Gets or sets the ratio between the SampleClockTimebaseRate and the SampleRate
(which can be slower) if SampleClockTimebaseSource is an external source.
|
![]() | SampleClockTimebaseMultiplier |
If SampleClockTimebaseSource is an external source, this attribute specifies the ratio between the SampleClockTimebaseRate and the SampleRate, which can be higher. This property can be used in conjunction with the SampleClockTimebaseDivisor attribute.
Some instruments use multiple ADCs to sample the same channel at an effective sample rate that is greater than the specified clock rate. When providing an external sample clock use this property to indicate when you want a higher sample rate. Valid values for this attribute vary by instrument and current configuration.
|
![]() | SampleClockTimebaseRate |
Gets or sets the frequency, in hertz, of the external clock used as the timebase source if SampleClockTimebaseSource is an external source or, if the timebase source is the internal clock for oscilloscopes that support multiple onboard clock rates, of the internal clock.
|
![]() | SampleClockTimebaseSource |
Gets or sets the source of the sample clock timebase, which is the timebase used to control waveform sampling. The SampleRate may be the timebase itself or a divided version of the timebase, depending on the SampleRateMin (for internal sources) or the SampleClockTimebaseDivisor and SampleClockTimebaseMultiplier (for external sources).
|
Methods
Name | Description | |
---|---|---|
![]() | AdjustSampleClockRelativeDelay |
Configures the relative sample clock delay in seconds when using the internal clock.
Each time this method is called, the sample clock is delayed by the specified amount of time.
|
![]() | ConfigureClock |
Configures the properties for synchronizing the digitizer to a reference or sending the digitizer's reference clock output to be used as a synchronizing clock for other digitizers.
|
![]() | ConfigureTiming |
Configures the common properties of the horizontal subsystem for a multirecord acquisition in terms of minimum sample rate.
|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
For more information, refer to the Horizontal attributes 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.