NI SCOPE Acquisition Attributes - ni/grpc-device GitHub Wiki
- NISCOPE_ATTRIBUTE_BINARY_SAMPLE_WIDTH
- NISCOPE_ATTRIBUTE_RESOLUTION
- NISCOPE_ATTRIBUTE_ACQUISITION_TYPE
- NISCOPE_ATTRIBUTE_SAMPLE_MODE
- NISCOPE_ATTRIBUTE_FETCH_RELATIVE_TO
- NISCOPE_ATTRIBUTE_FETCH_OFFSET
- NISCOPE_ATTRIBUTE_FETCH_RECORD_NUMBER
- NISCOPE_ATTRIBUTE_FETCH_NUM_RECORDS
- NISCOPE_ATTRIBUTE_FETCH_MEAS_NUM_SAMPLES
- NISCOPE_ATTRIBUTE_POINTS_DONE
- NISCOPE_ATTRIBUTE_RECORDS_DONE
- NISCOPE_ATTRIBUTE_DATA_TRANSFER_BLOCK_SIZE
- NISCOPE_ATTRIBUTE_BACKLOG
- NISCOPE_ATTRIBUTE_ENABLED_CHANNELS
- NISCOPE_ATTRIBUTE_RIS_IN_AUTO_SETUP_ENABLE
- NISCOPE_ATTRIBUTE_DATA_TRANSFER_MAXIMUM_BANDWIDTH
- NISCOPE_ATTRIBUTE_DATA_TRANSFER_PREFERRED_PACKET_SIZE
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Indicates the bit width of the binary data in the acquired waveform, which is useful for determining which Binary Fetch function to use. Compare to NISCOPE_ATTRIBUTE_RESOLUTION.
To configure the device to store samples with a lower resolution than the native resolution, set this attribute to the desired binary width. This process can be useful for streaming at faster speeds at the cost of resolution. The least significant bits are lost with this configuration.
8, 16, 32
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | RO | N/A | None | None |
Indicates the bit width of valid data (as opposed to padding bits) in the acquired waveform. Compare to NISCOPE_ATTRIBUTE_BINARY_SAMPLE_WIDTH.
- Resolution
Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | niScope_ConfigureAcquisition |
Specifies how the oscilloscope acquires data and fills the waveform record.
NISCOPE_VAL_NORMAL (0) | Sets the oscilloscope to normal resolution mode. The oscilloscope can use real-time sampling or equivalent-time sampling. |
---|---|
NISCOPE_VAL_FLEXRES (1001) | Sets legacy oscilloscopes to flexible resolution mode, if supported. |
NISCOPE_VAL_DDC (1002) | Sets legacy oscilloscopes to DDC mode, if supported. To use DDC mode for the PXI/PCI-5142 or PXIe-5622, set this attribute to NISCOPE_VAL_NORMAL and set the NISCOPE_ATTRIBUTE_DDC_ENABLED attribute to VI_TRUE. |
- Acquisition Functions
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | RO | N/A | None | niScope_SampleMode |
Specifies the sample mode the digitizer is currently using.
NISCOPE_VAL_REAL_TIME (0)
NISCOPE_VAL_EQUIVALENT_TIME (1)
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Position to start fetching within one record.
Default Value: NISCOPE_VAL_PRETRIGGER
NISCOPE_VAL_PRETRIGGER (477)—Fetches relative to the first pretrigger point requested with niScope_ConfigureHorizontalTiming.
NISCOPE_VAL_NOW (481)—Fetch data at the last sample acquired.
NISCOPE_VAL_START (482)—Fetch data starting at the first point sampled by the digitizer.
NISCOPE_VAL_TRIGGER (483)—Fetch at the first posttrigger sample.
NISCOPE_VAL_READ_POINTER (388)—The read pointer is set to zero when a new acquisition is initiated. After every fetch the read pointer is incremented to be the sample after the last sample retrieved. Therefore, you can repeatedly fetch relative to the read pointer for a continuous acquisition program.
- Fetching the Most Recent Data
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Offset in samples to start fetching data within each record. The offset is applied relative to NISCOPE_ATTRIBUTE_FETCH_RELATIVE_TO. The offset can be positive or negative.
Default Value: 0
- Fetching the Most Recent Data
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Zero-based index of the first record to fetch. Use NISCOPE_ATTRIBUTE_FETCH_NUM_RECORDS to set the number of records to fetch.
Default Value: 0
- Making Multiple-Record Acquisitions
- Fetching Multiple-Record Acquisitions
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Number of records to fetch. Use –1 to fetch all configured records.
Default Value: –1
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Number of samples to fetch when performing a measurement. Use –1 to fetch the actual record length.
Default Value: –1
- Fetching Data
- Acquiring Data Continuously
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViReal64 | RO | N/A | None | None |
Actual number of samples acquired since the last fetch, relative to the configured value for NISCOPE_ATTRIBUTE_FETCH_RELATIVE_TO, including NISCOPE_ATTRIBUTE_FETCH_OFFSET, and for the current configured NISCOPE_ATTRIBUTE_FETCH_RECORD_NUMBER.
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | RO | N/A | None | None |
Specifies the number of records that have been completely acquired.
- Making Multiple-Record Acquisitions
- Fetching Multiple-Record Acquisitions
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Specifies the maximum number of samples to transfer at one time from the device to host memory. Increasing this number should result in better fetching performance because the driver does not need to restart the transfers as often. However, increasing this number may also increase the amount of page-locked memory required from the system.
- Fetching Data
- Acquiring Data Continuously
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViReal64 | RO | N/A | None | None |
Returns the number of samples (NISCOPE_ATTRIBUTE_POINTS_DONE that have been acquired but not fetched for the record specified by NISCOPE_ATTRIBUTE_FETCH_RECORD_NUMBER.
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViString | RO | N/A | None | None |
Returns a comma-separated list of the channels enabled for the session in ascending order.
- If no channels are enabled, this attribute returns an empty string, "".
- If all channels are enabled, this attribute enumerates all of the channels.
Because this attribute returns channels in ascending order, but the order in which you specify channels for the channelList input to NISCOPE functions is important, the value of this attribute may not necessarily reflect the order in which NISCOPE performs certain actions. Refer to Channel String Syntax for more information on the effects of channel order in NISCOPE.
Data type |
Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViBoolean | R/W | N/A | None | niScope_AutoSetup |
Indicates whether the digitizer should use RIS sample rates when searching for a frequency in autosetup.
Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViReal64 | R/W | N/A | None | None |
Specifies the maximum bandwidth that the device is allowed to consume. The NI device limits itself to transfer fewer bytes per second on the PCIe bus than the value you specify for this property.
Datatype | Access | Applies to | Coercion | High Level Functions |
---|---|---|---|---|
ViInt32 | R/W | N/A | None | None |
Specifies the preferred size of the data field in the PCI Express packet. In general, the larger the packet size, the more efficiently the device uses the bus. However, some systems, because of their implementation, perform better with smaller packet sizes. The value of this property must be a power of two (64, 128, ... , 512).